Endpoints
Endpoint reference grouped by API type. Each row lists the expected input and output at a practical contract level.
Application, SDK, CLI, and automation endpoints.
| Method | Path | Description | Expected Input | Expected Output |
|---|---|---|---|---|
GET | /search | Search visible workspace resources. | Query: q, limit. | Grouped search results. |
GET | /projects | List projects. | Query: limit, offset. | Project list. |
POST | /projects | Create a project. | Body: name, description. | Created project. |
GET | /threads | List threads. | Query: limit, offset, projectId. | Thread list. |
POST | /threads | Create a thread. | Body: title, source, projectId, agentId, workflowId. | Created thread. |
GET | /threads/:id/messages | List messages. | Path: thread id. | Ordered message list. |
POST | /threads/:id/messages | Create a message. | Body: role, content, contentBlocks, acts, metadata. | Created message. |
GET | /threads/:id/runs/:runId | Get run state. | Path: thread id, run id. | Run detail with outcomes, steps, events, and deliverables. |
GET | /threads/:id/runs/:runId/events | Stream run events. | Query: after. Header: Last-Event-Id optional. | Server-sent event stream. |
POST | /documents/upload-url | Create upload URL. | Body: filename, mimeType, sizeBytes, threadId. | Document id and upload URL. |
POST | /documents/:id/commit | Commit uploaded document. | Body: file metadata. | Committed document. |
GET | /documents/:id/download | Create download URL. | Path: document id. | Download URL. |
GET | /agents | List agents. | Query: visibility, status. | Agent list. |
POST | /agents/:id/run | Start agent run. | Body: input, threadId. | Created agent run. |
GET | /workflows | List workflows. | Query: visibility, status. | Workflow list. |
POST | /workflows/:id/run | Start workflow run. | Body: input, threadId. | Created workflow run. |
GET | /pending-actions | List approvals. | Query: limit, offset. | Pending action list. |
POST | /pending-actions/:id/approve | Approve pending action. | Body: optional comment. | Updated pending action. |
POST | /pending-actions/:id/reject | Reject pending action. | Body: optional reason. | Updated pending action. |