API ReferenceCollections

Create Collection

Create a new collection in your organization. Collections are containers for organizing and searching across data from multiple sources. After creation, add source connections to begin syncing data. The collection will be assigned a unique `readable_id` based on the name you provide, which is used in URLs and API calls. You can optionally configure: - **Sync schedule**: How frequently to automatically sync data from all sources - **Custom readable_id**: Provide your own identifier (must be unique and URL-safe)

Authentication

x-api-keystring
API Key authentication via header

Request

This endpoint expects an object.
namestringRequired4-64 characters

Human-readable display name for the collection. This appears in the UI and should clearly describe the data contained within (e.g., ‘Finance Data’).

readable_idstring or nullOptionalformat: "^[a-z0-9]+(-[a-z0-9]+)*$"

URL-safe unique identifier used in API endpoints. Must contain only lowercase letters, numbers, and hyphens. If not provided, it will be automatically generated from the collection name with a random suffix for uniqueness (e.g., ‘finance-data-ab123’).

sync_configobject or nullOptional

Default sync configuration for all syncs in this collection. This provides collection-level defaults that can be overridden at sync or job level.

Response

Created collection
namestring

Human-readable display name for the collection.

readable_idstring

URL-safe unique identifier used in API endpoints. This becomes non-optional once the collection is created.

idstringformat: "uuid"
Unique system identifier for the collection. This UUID is generated automatically and used for internal references.
created_atstringformat: "date-time"

Timestamp when the collection was created (ISO 8601 format).

modified_atstringformat: "date-time"

Timestamp when the collection was last modified (ISO 8601 format).

organization_idstringformat: "uuid"
Identifier of the organization that owns this collection. Collections are isolated per organization.
vector_sizeinteger

Vector dimensions used by this collection (derived from deployment metadata).

embedding_model_namestring

Name of the embedding model used for this collection (derived from deployment metadata).

sync_configobject or null
Default sync configuration for all syncs in this collection. Overridable at sync and job level.
created_by_emailstring or nullformat: "email"
Email address of the user who created this collection.
modified_by_emailstring or nullformat: "email"
Email address of the user who last modified this collection.
statusenum or null
Current operational status of the collection:<br/>• **NEEDS_SOURCE**: Collection has no authenticated connections, or connections exist but haven't synced yet<br/>• **ACTIVE**: At least one connection has completed a sync or is currently syncing<br/>• **ERROR**: All connections have failed their last sync
Allowed values:

Errors