Delete Collection

DELETE https://api.credal.ai/api/v0/documentCollections/deleteCollection Content-Type: application/json

Delete the collection.

Reference: https://docs.credal.ai/api-reference/api-reference/document-collections/delete-collection

Authentication

Authorization header (bearer token, required) — Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

Body (application/json)

This endpoint expects an object.

collectionId (UUID, required)

Response

200

collectionId (UUID, required)

Examples

Request

JSON

{
  "collectionId": "ac20e6ba-0bae-11ef-b25a-efca73df4c3a"
}

Response

JSON

{
  "collectionId": "ac20e6ba-0bae-11ef-b25a-efca73df4c3a"
}

SDK Code

Example0

import { CredalClient } from "@credal/sdk";

async function main() {
    const client = new CredalClient({
        apiKey: "YOUR_TOKEN_HERE",
    });
    await client.documentCollections.deleteCollection({
        collectionId: "ac20e6ba-0bae-11ef-b25a-efca73df4c3a",
    });
}
main();

Example0

from credal import CredalV0
import uuid

client = CredalV0(
    api_key="YOUR_TOKEN_HERE",
)

client.document_collections.delete_collection(
    collection_id=uuid.UUID("ac20e6ba-0bae-11ef-b25a-efca73df4c3a"),
)