On this page
REST API reference¶
Download the OpenAPI snapshot
for operation IDs, schemas, pagination and authentication. The tables
below use the same snapshot as the generated clients.
To inspect a running installation, use GET /api/v1/meta for its
release and API version. Fetch its schema at /docs/openapi.json/
or /docs/openapi.yaml/. Browse it at /docs/scalar/,
/docs/swagger/, /docs/redoc/ or /docs/stoplight/.
Preserve trailing slashes as shown.
Pagination. Send
pageandpage_sizewhere supported. Readpage.object_listand stop atnum_pages.Errors. Use
reasonfor branching when present.namescan supply values anddetailhas the list of messages.Background work.
202means the operation was accepted. Check its status endpoint for completion.Services. Use scoped keys. See the first REST call.
Browser sessions. Use the configured frontend origin for login and refresh. Send email and password to
POST /api/v1/auth/tokenfor an access token. The browser sends its HTTP-only refresh cookie toPOST /api/v1/auth/token/refresh. Log out withPOST /api/v1/auth/logout.MCP. Send the OAuth token to the MCP endpoint. See Connect an MCP client.
API Keys¶
Method and path |
Operation |
Response codes |
|---|---|---|
|
|
|
|
|
|
|
|
|
Agent Graph¶
Method and path |
Operation |
Response codes |
|---|---|---|
|
|
|
|
|
|
|
|
|
Analytics¶
Method and path |
Operation |
Response codes |
|---|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Auth¶
Method and path |
Operation |
Response codes |
|---|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Chunk Map¶
Method and path |
Operation |
Response codes |
|---|---|---|
|
|
|
|
|
|
|
|
|
Chunks¶
Method and path |
Operation |
Response codes |
|---|---|---|
|
|
|
|
|
|
|
|
|
Dictionary¶
Method and path |
Operation |
Response codes |
|---|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Documents¶
Method and path |
Operation |
Response codes |
|---|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Embedding Models¶
Method and path |
Operation |
Response codes |
|---|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Eval Datasets¶
Method and path |
Operation |
Response codes |
|---|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Evaluations¶
Method and path |
Operation |
Response codes |
|---|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Extraction¶
Method and path |
Operation |
Response codes |
|---|---|---|
|
|
|
Graph¶
Method and path |
Operation |
Response codes |
|---|---|---|
|
|
|
|
|
|
Groups¶
Method and path |
Operation |
Response codes |
|---|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Installation¶
Method and path |
Operation |
Response codes |
|---|---|---|
|
|
|
Installation access¶
Method and path |
Operation |
Response codes |
|---|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
MCP¶
Method and path |
Operation |
Response codes |
|---|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Members¶
Method and path |
Operation |
Response codes |
|---|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Meta¶
Method and path |
Operation |
Response codes |
|---|---|---|
|
|
|
Metadata Schema¶
Method and path |
Operation |
Response codes |
|---|---|---|
|
|
|
Pipeline¶
Method and path |
Operation |
Response codes |
|---|---|---|
|
|
|
|
|
|
|
|
|
Retrieval¶
Method and path |
Operation |
Response codes |
|---|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
Rubrics¶
Method and path |
Operation |
Response codes |
|---|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Setup¶
Method and path |
Operation |
Response codes |
|---|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Space Config¶
Method and path |
Operation |
Response codes |
|---|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Spaces¶
Method and path |
Operation |
Response codes |
|---|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Vector Backends¶
Method and path |
Operation |
Response codes |
|---|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|