Ingest API - Collections Management

The Custom Collections API allows you to create, manage, and query custom collections of documents. Collections are a way to group documents together for various purposes.

---

Authentication

Authentication

All requests to the Doti API require a Bearer token. Include it in the Authorization header:

Authorization: Bearer {YOUR_ACCESS_TOKEN}

❗ Tokens must be generated by the Doti team. They are not yet user-creatable via the Portal.

---

API Endpoints

Create a Custom Collection

Use this endpoint to initialize a new custom collection to host your documents. This collection can later be assigned to specified agents.

Endpoint:

POST https://api.doti.ai/api/v2/collections

Request Body

Field	Type	Required	Description
id	string	Yes	A unique external identifier for the collection.
name	string	Yes	The display name of the collection.

Example Request

{
  "id": "project-alpha-docs",
  "name": "Project Alpha Documents"
}

Example Response (201 Created)

{
  "id": "project-alpha-docs",
  "name": "Project Alpha Documents"
}

Error Handling

Status Code	Reason
200	Success
400	The request body is malformed.
401	User is not authenticated.
409	A collection with the specified ID already exists.
500	Internal server error.

---

Get All Custom Collections

Use this endpoint to list all custom collections available within your organization. Helpful for browsing and managing existing collections.

Endpoint:

GET https://api.doti.ai/api/v2/collections

Example Response (200 OK)

[
  {
    "id": "project-alpha-docs",
    "name": "Project Alpha Documents"
  },
  {
    "id": "q1-marketing-assets",
    "name": "Q1 Marketing Assets"
  }
]

Error Handling

Status Code	Reason
200	Success
401	User is not authenticated.
500	Internal server error.

---

Get a Specific Custom Collection

Use this endpoint to retrieve details of a specific custom collection by providing its unique external identifier.

Endpoint:

GET https://api.doti.ai/api/v2/collections/:id

URL Parameters

Parameter	Type	Description
id	string	The external identifier of the collection.

Example Response (200 OK)

{
  "id": "project-alpha-docs",
  "name": "Project Alpha Documents"
}

Error Handling

Status Code	Reason
200	Success
404	Collection not found.
500	Internal server error.

---

Update a Custom Collection

Use this endpoint to modify the properties of an existing custom collection, such as renaming it.

Endpoint:

PUT https://api.doti.ai/api/v2/collections/:id

URL Parameters

Parameter	Type	Description
id	string	The external identifier of the collection.

Request Body

Field	Type	Required	Description
name	string	No	The new display name for the collection.

Example Request

{
  "name": "Project Alpha - All Documents"
}

Example Response (200 OK)

{
  "id": "project-alpha-docs",
  "name": "Project Alpha - All Documents"
}

Error Handling

Status Code	Reason
200	Success
400	The request body is malformed.
401	User is not authenticated.
404	Collection not found.
500	Internal server error.

---

Delete a Custom Collection

Use this endpoint to permanently delete a custom collection from your organization.

Endpoint:

DELETE https://api.doti.ai/api/v2/collections/:id

URL Parameters

Parameter	Type	Description
id	string	The external identifier of the collection.

Example Response (204 No Content)

(empty response)

Error Handling

Status Code	Reason
200	Success
401	Unauthorized – invalid or missing token
404	Collection not found.
500	Internal server error.