HTTP API
Generated from the running services' OpenAPI schemas, so it cannot
drift from the routes it describes.
Every error response is an RFC 9457
problem document with a stable code. Endpoints under /internal are
not listed: they are reachable only from inside the cluster, and the
edge proxy must not route them.
Control API
Libraries, documents, and identity.
GET /api/v1/capabilities
What this deployment supports.
| Status |
Meaning |
200 |
Successful Response |
GET /api/v1/libraries
List the caller's libraries.
| Status |
Meaning |
200 |
Successful Response |
POST /api/v1/libraries
Create a private library.
| Status |
Meaning |
201 |
Successful Response |
422 |
Validation Error |
GET /api/v1/libraries/{library_id}
Read one library.
| Parameter |
In |
Required |
library_id |
path |
yes |
| Status |
Meaning |
200 |
Successful Response |
422 |
Validation Error |
PATCH /api/v1/libraries/{library_id}
Rename a library.
| Parameter |
In |
Required |
library_id |
path |
yes |
| Status |
Meaning |
200 |
Successful Response |
422 |
Validation Error |
DELETE /api/v1/libraries/{library_id}
Delete a library.
| Parameter |
In |
Required |
library_id |
path |
yes |
| Status |
Meaning |
204 |
Successful Response |
422 |
Validation Error |
GET /api/v1/libraries/{library_id}/documents
List a library's documents.
| Parameter |
In |
Required |
library_id |
path |
yes |
| Status |
Meaning |
200 |
Successful Response |
422 |
Validation Error |
POST /api/v1/libraries/{library_id}/documents
Upload a document.
| Parameter |
In |
Required |
library_id |
path |
yes |
| Status |
Meaning |
201 |
Successful Response |
422 |
Validation Error |
GET /api/v1/libraries/{library_id}/documents/{document_id}
Read one document's status.
| Parameter |
In |
Required |
library_id |
path |
yes |
document_id |
path |
yes |
| Status |
Meaning |
200 |
Successful Response |
422 |
Validation Error |
DELETE /api/v1/libraries/{library_id}/documents/{document_id}
Delete a document.
| Parameter |
In |
Required |
library_id |
path |
yes |
document_id |
path |
yes |
| Status |
Meaning |
204 |
Successful Response |
422 |
Validation Error |
GET /api/v1/libraries/{library_id}/documents/{document_id}/content
Download the current version's bytes.
| Parameter |
In |
Required |
library_id |
path |
yes |
document_id |
path |
yes |
| Status |
Meaning |
200 |
Successful Response |
422 |
Validation Error |
POST /api/v1/libraries/{library_id}/documents/{document_id}/reindex
Rebuild a document's index.
| Parameter |
In |
Required |
library_id |
path |
yes |
document_id |
path |
yes |
| Status |
Meaning |
202 |
Successful Response |
422 |
Validation Error |
POST /api/v1/libraries/{library_id}/documents/{document_id}/versions
Replace a document with a new version.
| Parameter |
In |
Required |
library_id |
path |
yes |
document_id |
path |
yes |
| Status |
Meaning |
201 |
Successful Response |
422 |
Validation Error |
GET /api/v1/me
Describe the acting principal.
| Status |
Meaning |
200 |
Successful Response |
GET /health/live
Liveness probe.
| Status |
Meaning |
200 |
Successful Response |
GET /health/ready
Readiness probe.
| Status |
Meaning |
200 |
Successful Response |
Chat
Asking questions and streaming the answers, and the models a deployment offers.
GET /api/v1/conversations
List the caller's conversations.
| Parameter |
In |
Required |
library_id |
query |
no |
| Status |
Meaning |
200 |
Successful Response |
422 |
Validation Error |
POST /api/v1/conversations
Ask a question and stream the answer.
| Status |
Meaning |
200 |
Successful Response |
422 |
Validation Error |
GET /api/v1/conversations/{conversation_id}
Read one conversation.
| Parameter |
In |
Required |
conversation_id |
path |
yes |
| Status |
Meaning |
200 |
Successful Response |
422 |
Validation Error |
GET /api/v1/conversations/{conversation_id}/messages
Read a conversation's turns.
| Parameter |
In |
Required |
conversation_id |
path |
yes |
| Status |
Meaning |
200 |
Successful Response |
422 |
Validation Error |
POST /api/v1/conversations/{conversation_id}/messages
Continue a conversation.
| Parameter |
In |
Required |
conversation_id |
path |
yes |
| Status |
Meaning |
200 |
Successful Response |
422 |
Validation Error |
GET /api/v1/models
Models this deployment offers.
| Status |
Meaning |
200 |
Successful Response |
List pending tool requests.
| Parameter |
In |
Required |
conversation_id |
query |
no |
| Status |
Meaning |
200 |
Successful Response |
422 |
Validation Error |
POST /api/v1/tool-requests/{request_id}/approve
Approve a tool call.
| Parameter |
In |
Required |
request_id |
path |
yes |
| Status |
Meaning |
200 |
Successful Response |
422 |
Validation Error |
POST /api/v1/tool-requests/{request_id}/deny
Deny a tool call.
| Parameter |
In |
Required |
request_id |
path |
yes |
| Status |
Meaning |
200 |
Successful Response |
422 |
Validation Error |
GET /health/live
Process liveness.
| Status |
Meaning |
200 |
Successful Response |
GET /health/ready
Readiness.
| Status |
Meaning |
200 |
Successful Response |