Sign in

v50

latestOpenAPI 3.1.0raw.githubusercontent.com2026-03-222763184.3 KB
collections

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)
post/collections

Request body

namestring required

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 nullable

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

Example request

{
  "name": "Finance Data",
  "readable_id": "finance-data-reports"
}

Response

Created collection

namestring required

Human-readable display name for the collection.

readable_idstring required

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

idstring uuid required

Unique system identifier for the collection. This UUID is generated automatically and used for internal references.

created_atstring date-time required

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

modified_atstring date-time required

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

organization_idstring uuid required

Identifier of the organization that owns this collection. Collections are isolated per organization.

created_by_emailstring email nullable

Email address of the user who created this collection.

modified_by_emailstring email nullable

Email address of the user who last modified this collection.

status'ACTIVE' | 'NEEDS SOURCE' | 'ERROR'

Collection status enum.

vector_sizeinteger required

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

embedding_model_namestring required

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

Example response

{
  "created_at": "2024-01-15T09:30:00Z",
  "created_by_email": "admin@company.com",
  "embedding_model_name": "text-embedding-3-large",
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "modified_at": "2024-01-15T14:22:15Z",
  "modified_by_email": "finance@company.com",
  "name": "Finance Data",
  "organization_id": "org12345-6789-abcd-ef01-234567890abc",
  "readable_id": "finance-data-ab123",
  "source_connection_summaries": [
    {
      "name": "Slack",
      "short_name": "slack"
    },
    {
      "name": "GitHub",
      "short_name": "github"
    }
  ],
  "status": "ACTIVE",
  "vector_size": 3072
}