Delete a document
write/v1/docs/{path}
Delete a document by path.
Scopes: seadb:content:write
Generated reference
API Reference
Generated capability index for the public /v1 developer surface.
Public developer surface
Capability index
This index is generated from services/seagate/src/routing/capabilities.rs plus a small curated set of developer auth endpoints. Admin and internal routes are intentionally excluded from the public docs catalog.
Mutate a document
write/v1/docs/{path}
Mutate a document with op append | edit | sed | patch.
Scopes: seadb:content:write
Read a document or search
read/v1/docs/{path}
Read a markdown/HTML document by path, or search via /v1/docs/_search?q=.
Scopes: seadb:content:read
Write a document
write/v1/docs/{path}
Write a document as text/markdown (string) or JSON (object).
Scopes: seadb:content:write
Resolve signed artifact content
read/v1/files/{fileId}/content
Stream artifact bytes inline (200) or return a signed redirect (302).
Scopes: seadb:content:read
Delete artifact metadata
write/v1/files/{fileId}
Delete artifact metadata by id.
Scopes: seadb:content:write
Read artifact metadata
read/v1/files/{fileId}
Read artifact metadata by id.
Scopes: seadb:content:read
List artifacts
read/v1/files
List artifact metadata by prefix, kind, artifactType, or label.
Scopes: seadb:content:read
Mint an API key
write/v1/auth/keys
Create a user-scoped API key. The raw token is returned only once.
Scopes: anonymous/public
List API keys
read/v1/auth/keys
List the API keys owned by the current user.
Scopes: anonymous/public
Revoke an API key
write/v1/auth/keys/{keyId}
Revoke a user-scoped API key by id.
Scopes: anonymous/public
Discover capabilities for this key
read/v1/capabilities
Return the capability catalog available to the current credential.
Scopes: anonymous/public
Identity of the current key
read/v1/me
Return the identity, actor type, auth method, and scopes for the current API key.
Scopes: anonymous/public
Create a presigned download URL
read/v1/downloads
Create a signed download URL for an artifact.
Scopes: files:read
Finalize a presigned upload
write/v1/uploads/complete
Finalize a presigned upload; requires the sha256 of the bytes you PUT.
Scopes: files:write
Create a presigned upload
write/v1/uploads
Create an S3-style presigned upload delegation. PUT the bytes to the signed URL, then complete.
Scopes: files:write
Create a conversation thread
write/v1/threads
Create a conversation thread (pure storage; no runtime).
Scopes: seaplane:write
Read a thread
read/v1/threads/{threadId}
Read a conversation thread by id.
Scopes: seaplane:read
List conversation threads
read/v1/threads
List conversation threads (pure storage).
Scopes: seaplane:read
Append a message (pure storage)
write/v1/threads/{threadId}/messages
Append a message to a thread. The facade forces dispatch:false; no runtime, no assistant turn.
Scopes: seaplane:write
List thread messages
read/v1/threads/{threadId}/messages
List messages in a thread.
Scopes: seaplane:read
Replay the thread timeline
read/v1/threads/{threadId}/timeline
Replay the append-only timeline of a thread.
Scopes: seaplane:read
Chat completions (OpenAI-compatible)
invoke/v1/chat/completions
Create an OpenAI-compatible chat completion. Set stream:true for an SSE stream.
Scopes: model:invoke
Model discovery sub-resource
read/v1/models/{path}
Enumerate deployment-specific model ids for a modality (filter to availability.state live_ok).
Scopes: model:invoke
List models
read/v1/models
List available model modalities and models.
Scopes: model:invoke
Responses API (OpenAI-compatible)
invoke/v1/responses
Create an OpenAI-compatible Responses result. Set stream:true for an SSE stream.
Scopes: model:invoke
Cancel an async task
write/v1/tasks/{taskId}
Cancel an in-flight async task.
Scopes: model:invoke
Poll an async task
read/v1/tasks/{taskId}
Poll an async media/task by id.
Scopes: model:invoke
Fetch an async task result
read/v1/tasks/{taskId}/result
Fetch the result of a completed async task.
Scopes: model:invoke
Native multimodal invoke
invoke/v1/invoke/{path}
Single entrypoint for embeddings, rerank, and image/audio/video generation. path = {modality}/{model}[/{version}].
Scopes: model:invoke
Usage summary
read/v1/usage?start={start}&end={end}
Return usage attribution for the current key. Both start and end are required.
Scopes: usage:read
Read a plugin definition
read/v1/tools/{pluginId}
Read a tool plugin definition by id.
Scopes: seatool:read
Invoke a tool
invoke/v1/tools/{pluginId}/{toolName}/invoke
Invoke a tool by plugin id and tool name with a JSON input.
Scopes: tool:invoke
List the tool catalog
read/v1/tools
List the available tool/plugin catalog.
Scopes: seatool:read
Publish a tool plugin
write/v1/tools
Publish or register a tool plugin definition.
Scopes: seatool:write
Agent inputs
Machine-readable reference
Use /api/capabilities.json when an agent needs route metadata and examples. Use /api/openapi.json when an API client or code generator expects OpenAPI 3.1.