Add Collection To Copilot

POST https://api.credal.ai/api/v0/copilots/addCollectionToCopilot Content-Type: application/json

Link a collection with a agent. The API Key used must be added to both the collection and the agent beforehand.

Reference: https://docs.credal.ai/api-reference/api-reference/copilots/add-collection-to-copilot

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.

copilotId (UUID, required) — Credal-generated Agent ID to add the collection to.
collectionId (UUID, required) — Credal-generated collection ID to add.

Examples

Request

JSON

{
  "copilotId": "82e4b12a-6990-45d4-8ebd-85c00e030c24",
  "collectionId": "def1055f-83c5-43d6-b558-f7a38e7b299e"
}

SDK Code

Example0

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

async function main() {
    const client = new CredalClient({
        apiKey: "YOUR_TOKEN_HERE",
    });
    await client.copilots.addCollectionToCopilot({
        copilotId: "82e4b12a-6990-45d4-8ebd-85c00e030c24",
        collectionId: "def1055f-83c5-43d6-b558-f7a38e7b299e",
    });
}
main();

Example0

from credal import CredalV0
import uuid

client = CredalV0(
    api_key="YOUR_TOKEN_HERE",
)

client.copilots.add_collection_to_copilot(
    copilot_id=uuid.UUID("82e4b12a-6990-45d4-8ebd-85c00e030c24"),
    collection_id=uuid.UUID("def1055f-83c5-43d6-b558-f7a38e7b299e"),
)