Create a collection
Creates a new collection scoped to your organization. Optionally attach sources and retrieval settings at creation time. If slug is omitted, one is derived from name and must be unique within your organization.
Request body
Example request
{
"name": "Support Transcripts",
"description": "All customer support voice transcripts.",
"slug": "support-transcripts",
"sources": [
{
"source_type": "voice",
"bucket_id": "policy-docs"
}
],
"settings": {
"record_type": "ai_collection_settings",
"retrieval": {
"top_k": 5,
"retrieval_type": "vector"
}
}
}Response
Collection created.
Example response
{
"data": {
"uuid": "6a09ccbd-8f9b-4c3a-9b0e-2f1d3c4b5a6e",
"slug": "support-transcripts",
"record_type": "ai_collection",
"name": "Support Transcripts",
"description": "All customer support voice transcripts.",
"status": "ready",
"sources": [
{
"id": "source_8vkvtcksnawvbnxq48yv2l06wx",
"record_type": "ai_collection_source",
"collection_id": "6a09ccbd-8f9b-4c3a-9b0e-2f1d3c4b5a6e",
"source_type": "voice",
"bucket_id": "policy-docs",
"status": "ready"
}
],
"settings": {
"record_type": "ai_collection_settings",
"retrieval": {
"top_k": 5,
"retrieval_type": "vector"
}
},
"created_at": "2026-08-04T12:00:00Z",
"updated_at": "2026-08-04T12:00:00Z"
}
}Changes
Changed in 2 of the 99 revisions of this API.5414
- ▲
removed the enum value
keywordof the request property//////request-property-enum-value-removed
- ▲
the
//response's property type changed fromstringtointeger, and format from no format toint32for statusresponse-property-type-changed
- ▲
the
//response's property type changed fromstringtointeger, and format from no format toint32for statusresponse-property-type-changed
- ▲
the
//response's property type changed fromstringtointeger, and format from no format toint32for statusresponse-property-type-changed
- ▲
the
//response's property type changed fromstringtointeger, and format from no format toint32for statusresponse-property-type-changed
- ●
removed the optional property
///from the response with the statusresponse-optional-property-removed
- ●
removed the optional property
///from the response with the statusresponse-optional-property-removed
- ●
removed the optional property
///from the response with the statusresponse-optional-property-removed
- ●
removed the optional property
///from the response with the statusresponse-optional-property-removed
- ○
added the optional property
//to the response with the statusresponse-optional-property-added
- ○
added the optional property
//to the response with the statusresponse-optional-property-added
- ○
added the optional property
//to the response with the statusresponse-optional-property-added
- ○
added the optional property
//to the response with the statusresponse-optional-property-added
- ○
the response property
//became required for the statusresponse-property-became-required
- ○
the response property
//became required for the statusresponse-property-became-required
- ○
the response property
//became required for the statusresponse-property-became-required
- ○
the response property
//became required for the statusresponse-property-became-required
- ○
the response property
//became required for the statusresponse-property-became-required
- ○
the response property
//became required for the statusresponse-property-became-required
- ○
the response property
//became required for the statusresponse-property-became-required
- ○
the response property
//became required for the statusresponse-property-became-required
- ○
removed the
keywordenum value from the///response property for the response statusresponse-property-enum-value-removed
This revision also has 34 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
- ▲
- ○
endpoint added
endpoint-added
This revision also has 64 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
- ○
Of the 99 revisions, 1 has no diff computed.