API ReferenceCollections

Create

Create a new collection. The newly created collection is initially empty and does not contain any data until you explicitly add source connections to it.

Authentication

x-api-keystring
API Key authentication via header

Headers

X-Framework-NamestringOptional
X-Framework-VersionstringOptional

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’).

Response

Successful Response
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.
vector_sizeinteger

Vector dimensions used by this collection. Determines which embedding model is used: 3072 (text-embedding-3-large), 1536 (text-embedding-3-small), or 384 (MiniLM-L6-v2).

embedding_model_namestring

Name of the embedding model used for this collection (e.g., ‘text-embedding-3-large’, ‘text-embedding-3-small’). This ensures queries use the same model as the indexed data.

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.
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