Update Collection

Update an existing collection’s properties.

You can modify:

Name: The display name shown in the UI
Sync configuration: Schedule settings for automatic data synchronization

Note that the readable_id cannot be changed after creation to maintain stable API endpoints and preserve existing integrations.

Authentication

x-api-keystring

API Key authentication via header

Path parameters

readable_idstringRequired

The unique readable identifier of the collection to update

Request

This endpoint expects an object.

namestring or nullOptional4-64 characters

Updated display name for the collection. Must be between 4 and 64 characters.

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

Updated 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 nullOptional

Default sync configuration for all syncs in this collection. Overridable at sync and job level.

created_by_emailstring or nullOptionalformat: "email"

Email address of the user who created this collection.

modified_by_emailstring or nullOptionalformat: "email"

Email address of the user who last modified this collection.

statusenumOptional

Current operational status of the collection:
• NEEDS_SOURCE: Collection has no authenticated connections, or connections exist but haven't synced yet
• ACTIVE: At least one connection has completed a sync or is currently syncing
• ERROR: All connections have failed their last sync

Allowed values:

source_connection_summarieslist of objectsOptional

Lightweight list of source connections attached to this collection. Contains only short_name and name, suitable for rendering icons in list views.

Errors

404

Not Found Error

422

Unprocessable Entity Error

429

Too Many Requests Error