/

Docs
History
Schema
Generate

Filter operations

Admin Sessions3

Agents57

AI Assistants42

API Keys6

Chat42

Collections57

get/collectionsList collections.
post/collectionsCreate a Collection
get/collections/allFetches all users' collection metadata sorted by last update time by default.
get/collections/countCounts a number of collections.
get/collections/{collection_id}Get a Collection
delete/collections/{collection_id}Deletes collection.
patch/collections/{collection_id}Updates attributes of an existing collection.
get/collections/{collection_id}/chunks/{chunk_ids}Returns specific chunks in a collection.
post/collections/{collection_id}/chunks/matchFinds chunks related to a message using semantic search.
post/collections/{collection_id}/chunks/searchFinds chunks related to a message using lexical search.
post/collections/delete_jobCreates a job to delete collections.
post/collections/reset_all_collection_expirationsReset all collection expiry dates and inactivity intervals that have been set.
put/collections/{collection_id}/prompt_templateUpdates a prompt template reference of a collection.
delete/collections/{collection_id}/prompt_templateRemoves a prompt template reference from the collection.
put/collections/{collection_id}/expiry_dateUpdates an expiry date of a collection.
delete/collections/{collection_id}/expiry_dateRemoves an expiry date from a collection.
put/collections/{collection_id}/inactivity_intervalUpdates an inactivity interval of a collection.
delete/collections/{collection_id}/inactivity_intervalRemoves an inactivity interval from the collection.
put/collections/{collection_id}/workspaceUpdates the workspace associated with a collection.
post/collections/{collection_id}/archiveArchives a collection along with its associated data.
post/collections/{collection_id}/unarchiveRestores an archived collection to an active status.
put/collections/{collection_id}/size_limitSets a maximum limit on the total size of documents (sum) added to a collection.
delete/collections/{collection_id}/size_limitRemoves a size limit for a collection.
post/collections/{collection_id}/is_publicUpdates a flag specifying whether a collection is private or public.
get/collections/{collection_id}/settingsFetches collection settings.
put/collections/{collection_id}/settingsUpdates collection settings.
delete/collections/{collection_id}/prompt_settingsResets the prompt settings for a given collection.
get/collections/{collection_id}/metadataFetches collection metadata.
put/collections/{collection_id}/metadataUpdates collection metadata.
put/collections/{collection_id}/thumbnailUpdates collection thumbnail.
delete/collections/{collection_id}/thumbnailDeletes collection thumbnail.
put/collections/{collection_id}/thumbnail/jobCreates a job to update collection thumbnail.
delete/collections/{collection_id}/thumbnail/jobCreates a job to delete collection thumbnail.
get/collections/{collection_id}/chat_settingsFetches collection chat settings.
put/collections/{collection_id}/chat_settingsUpdates collection chat settings.
get/collections/{collection_id}/documentsList a Collection's documents
put/collections/{collection_id}/documents/{document_id}Import an already stored document to an existing collection.
delete/collections/{collection_id}/documents/{document_id}Removes the document from the collection.
post/collections/{collection_id}/documents/insert_jobCreates job to insert document to the collection.
post/collections/{collection_id}/documents/delete_jobCreates job to remove documents from the collection.
get/collections/{collection_id}/documents/countCounts a number of documents in the collection.
get/collections/{collection_id}/chatsList chat sessions for a given collection.
get/collections/{collection_id}/chats/countCounts a number of chat sessions with the collection.
get/collections/{collection_id}/questionsList suggested questions for a given collection.
get/collections/{collection_id}/permissionsReturns a list of access permissions for a given collection.
delete/collections/{collection_id}/permissionsRemoves sharing of a collection to all other users except the original owner.
get/collections/{collection_id}/group_permissionsReturns a list of group access permissions for a given collection.
get/collections/{collection_id}/public_permissionsReturns the public permissions for a given collection.
put/collections/{collection_id}/permissions/{username}Shares a collection to a user.
delete/collections/{collection_id}/permissions/{username}Removes sharing of a collection to a user.
put/collections/{collection_id}/group_permissions/{group_id}Shares a collection to a group.
delete/collections/{collection_id}/group_permissions/{group_id}Removes sharing of a collection to a user.
post/collections/{collection_id}/import_collection_jobCreates job to import collection to the collection.
get/collections/{collection_id}/scheduled_connectorsList scheduled connectors for a collection
post/collections/{collection_id}/migrate_scheduled_connectorsMigrate scheduled connectors from another collection
post/collections/{collection_id}/migrate_chat_sessions_jobCreates a job to migrate all chat sessions from one collection to another.
put/collections/{collection_id}/exempt_from_chat_expiryUpdates the chat expiry exemption of a collection.

Configurations12

Document Ingestion21

Documents24

Extractors18

Forums16

GraphRAG7

Guardrails4

Jobs9

LLM Registry8

Memory Blocks15

Models20

Permissions34

Prompt Templates19

Scheduled Tasks16

Secrets6

Shared Chats6

Showcase9

System3

Tags6

Collections

Changes to List scheduled connectors for a collection

get/collections/{collection_id}/scheduled_connectors

Nov 6, 2026a82a117320f4 Revision changes
- info
  endpoint added