API Reference
Workspaces & Documents
Endpoints for managing workspace knowledge scopes, documents, and file uploads.
GET /v1/workspaces
Lists all workspaces accessible to the authenticated principal.
Response
[
{
"id": "ws_01jze9m2xw",
"name": "Research Workspace",
"createdAt": "2026-08-16T00:00:00.000Z",
"updatedAt": "2026-08-16T00:00:00.000Z"
}
]POST /v1/workspaces
Creates a new workspace knowledge boundary.
Request Body
{
"name": "Engineering Knowledge Base"
}Response (200 OK)
{
"id": "ws_01jze9m2eng",
"name": "Engineering Knowledge Base",
"createdAt": "2026-08-16T00:00:00.000Z",
"updatedAt": "2026-08-16T00:00:00.000Z"
}POST /v1/workspaces/:workspaceId/documents
Creates or updates a markdown knowledge document within a workspace.
- Scope Required:
memory:write
Request Body
{
"title": "Architecture Overview",
"markdown": "# Architecture Overview\n\nDetailed system design...",
"document_payload": { "format": "markdown", "type": "document" }
}Response
{
"document": {
"id": "doc_123",
"workspace_id": "ws_01jze9m2eng",
"title": "Architecture Overview",
"slug": "architecture-overview",
"markdown": "# Architecture Overview\n\nDetailed system design...",
"createdAt": "2026-08-16T00:00:00.000Z"
}
}POST /v1/workspaces/:workspaceId/files/upload-url
Generates a presigned URL for uploading binary or large media assets.
- Scope Required:
files:write
Request Body
{
"filename": "specification.pdf",
"contentType": "application/pdf"
}Response
{
"url": "https://storage.omnistatic.com/workspaces/ws_123/files/specification.pdf?...",
"key": "workspaces/ws_123/files/specification.pdf",
"method": "PUT"
}