API reference

Documents

Store, retrieve, search, and manage the structured data used by your agents and workflows.

This reference covers a selected set of supported Document operations. Additional platform capabilities may not be available through the public API.

Create Document

Create a new document and configure metadata and properties.

Authorizations

ApiToken

API key authentication

Type

API Key (header: x-api-token)

Request Body

application/json

Unique identifier for the document

The main data of the document, can be any type (string, object, array, etc.)

Additional metadata for the document

Current status of the document

Valid values"active""draft""archived"

Default"active"

Whether to create a vector embedding for the document

Responses

Document created successfully

Content-Type

application/json

Success message

Operation status

Request builder

POST/document

Interactive

Playground

Authorization

ApiToken

Body

Code samples

Use the configured request in your preferred language.

Get Document by ID

Retrieve a document by its unique ID.

Authorizations

ApiToken

API key authentication

Type

API Key (header: x-api-token)

Parameters

Path Parameters

id*

Unique ID of the document

Type

string

Required

Responses

Document details

Content-Type

application/json

Operation status

Request builder

GET/document/{id}

Interactive

Playground

Authorization

ApiToken

Variables

Key

Value

id*

Code samples

Use the configured request in your preferred language.

Update Document

Modify an existing document's data and properties by its unique ID.

Authorizations

ApiToken

API key authentication

Type

API Key (header: x-api-token)

Parameters

Path Parameters

id*

Unique ID of the document to update

Type

string

Required

Request Body

application/json

The main data of the document, can be any type (string, object, array, etc.)

Additional metadata for the document

Updated status of the document

Valid values"active""draft""archived"

Responses

Document updated successfully

Content-Type

application/json

Success message

Operation status

Request builder

PUT/document/{id}

Interactive

Playground

Authorization

ApiToken

Variables

Key

Value

id*

Body

Code samples

Use the configured request in your preferred language.

Delete Document

Remove an existing document by its unique ID.

Authorizations

ApiToken

API key authentication

Type

API Key (header: x-api-token)

Parameters

Path Parameters

id*

Unique ID of the document to delete

Type

string

Required

Responses

Document deleted successfully

Content-Type

application/json

Success message

Operation status

Request builder

DELETE/document/{id}

Interactive

Playground

Authorization

ApiToken

Variables

Key

Value

id*

Code samples

Use the configured request in your preferred language.

Search Documents

Search for documents using sort, filter and pagination.

Authorizations

ApiToken

API key authentication

Type

API Key (header: x-api-token)

Request Body

application/json

Filter criteria for the search

Default{}

Sorting instructions (field name and direction)

Default"_id"-1

Page number for pagination

Default1

Number of results per page

Default10

Responses

Search results

Content-Type

application/json

Array of matching documents

Total number of matching documents

Operation status

Request builder

POST/document/search

Interactive

Playground

Authorization

ApiToken

Body

Code samples

Use the configured request in your preferred language.