Delete collection

A quick guide on how to delete collections by ID using the Alphamoon API

To delete collection via API, get the collection_id of the processed file from:

• Upload a file endpoint (Base64 or Binary)

• Get collections endpoint

• URL e.g. https://workspace.alphamoon.ai/supervision/223742cc9bca43fd81b2d41b0018e4c7

Use the following endpoint to delete the given collection:

Delete collection by ID

DELETE /api/v0.3/collections/{collection_id}

Path parameters

Name	Type	Description
collection-id*	String	The ID of the collection

Response

204: OK Successful Response

"string"

422: Unprocessable Entity Validation error

{
  "detail": [
    {
      "loc": [
        "string",
        0
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

See the example:

API call

curl -X 'DELETE' \
  'https://workspace.alphamoon.ai/api/v0.3/collections/4635c1aed59d45aa9268501fdc4d59c3' \
  -H 'accept: */*' \
  -H 'Authorization: Basic API_KEY_BASE64_ENCODED'

Server response

"string"

See more: