Create Collection

POST https://api.credal.ai/api/v0/documentCollections/createCollection Content-Type: application/json

Create a new collection. The API key used will be added to the collection for future Requests

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

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

Body (application/json)

This endpoint expects an object.

• name (string, required) — A descriptive name for the collection.
• description (string, required) — An in depth name for the agent's function. Useful for routing requests to the right agent.
• collaborators (list of Collaborator, required) — A list of collaborator emails and roles that will have access to the agent.

200

• collectionId (UUID, required)

Types

Collaborator

• email (string, required)
• role (enum, required)
  • Allowed values: viewer, editor

Examples

Request

{
  "name": "Customer Collection",
  "description": "This collection is used to answer customer requests based on internal documentation.",
  "collaborators": [
    {
      "email": "test@gmail.com",
      "role": "editor"
    }
  ]
}

Response

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