External Agent Reference
CrewOS API Docs
A curated map of CrewOS endpoints that are useful to external agents and automation accounts. Use the generated OpenAPI schema for exact request and response models.
- Endpoint groups
- 13
- Useful endpoints
- 180
- Primary auth
- API key
Request Pattern
curl -sS https://crewos.com.hk/api/v1/auth/me \ -H "X-CrewOS-API-Key: $CREWOS_API_KEY"
curl -sS https://crewos.com.hk/api/v1/chat \ -H "X-CrewOS-API-Key: $CREWOS_API_KEY" \ -F "project_id=$PROJECT_ID" \ -F "message=Prepare the project update"
Authentication and API Keys
Create, inspect, and revoke credentials. API keys inherit the creating user team, role, project access, and namespace permissions.
| Method | Path | Purpose | Auth | Notes |
|---|---|---|---|---|
| POST | /api/v1/auth/login | Exchange username and password for a JWT login response. | Public | Interactive users and bootstrap scripts use this before creating API keys. |
| POST | /api/v1/auth/refresh | Refresh an interactive JWT session. | JWT | Use OpenAPI for body and response schema. |
| POST | /api/v1/auth/logout | Revoke the current refresh token. | JWT | Use OpenAPI for body and response schema. |
| POST | /api/v1/auth/logout-all | Revoke all refresh tokens for the current user. | JWT | Use OpenAPI for body and response schema. |
| GET | /api/v1/auth/me | Read the authenticated user, team, role, and namespace grants. | API key | Use OpenAPI for body and response schema. |
| GET | /api/v1/auth/api-keys | List API key metadata for the current user. | JWT | API-key-authenticated calls cannot manage additional keys. |
| POST | /api/v1/auth/api-keys | Create an API key and receive the raw key once. | JWT | Body supports name, optional scopes, and optional expires_at. |
| DELETE | /api/v1/auth/api-keys/{key_id} | Revoke one API key. | JWT | Use OpenAPI for body and response schema. |
| GET | /api/v1/auth/sso/providers | Discover enabled SSO providers for login UX or health checks. | Public | Use OpenAPI for body and response schema. |
Agent Discovery
Discover available CrewOS agents, skills, and the public agent-card metadata used by external automation.
| Method | Path | Purpose | Auth | Notes |
|---|---|---|---|---|
| GET | /.well-known/agent-card.json | Fetch the well-known CrewOS agent card. | Public | Use OpenAPI for body and response schema. |
| GET | /api/v1/agents | List callable CrewOS agents and their metadata. | API key | Use OpenAPI for body and response schema. |
| GET | /api/v1/agents/agent-card | Fetch the authenticated agent-card representation. | API key | Use OpenAPI for body and response schema. |
| GET | /api/v1/agents/{name} | Inspect one agent by registry name. | API key | Use OpenAPI for body and response schema. |
| GET | /api/v1/skills | List configured skills available to the caller. | API key | Use OpenAPI for body and response schema. |
| GET | /api/v1/skills/discovery | Retrieve skill-discovery metadata for routing and planning. | API key | Use OpenAPI for body and response schema. |
| GET | /api/v1/skills/{skill_id} | Inspect one skill definition. | API key | Use OpenAPI for body and response schema. |
Chat and Agent Runs
Start CrewOS work through synchronous, streaming, or external-compatible chat entry points.
| Method | Path | Purpose | Auth | Notes |
|---|---|---|---|---|
| POST | /api/v1/chat | Send a CrewOS chat message. Can attach project_id and session_id. | API key | Form-data endpoint; durable project chat may return a job ID. |
| POST | /api/v1/chat/stream | Stream CrewOS chat progress and final output. | API key | Use OpenAPI for body and response schema. |
| POST | /api/v1/chat/cancel | Cancel an active chat stream or run. | API key | Use OpenAPI for body and response schema. |
| POST | /api/v1/external/chat | Compatibility chat endpoint for external agent clients. | API key | Use OpenAPI for body and response schema. |
| POST | /api/v1/external/chat/stream | Streaming compatibility chat endpoint for external agent clients. | API key | Use OpenAPI for body and response schema. |
| GET | /api/v1/orchestrator/status | Read orchestrator runtime status. | API key | Use OpenAPI for body and response schema. |
Sessions, Transcripts, and Feedback
Create conversation containers, replay or export transcripts, share sessions, and attach feedback.
| Method | Path | Purpose | Auth | Notes |
|---|---|---|---|---|
| POST | /api/v1/sessions | Create a standalone session. | API key | Use OpenAPI for body and response schema. |
| GET | /api/v1/sessions | List sessions visible to the caller. | API key | Use OpenAPI for body and response schema. |
| GET | /api/v1/sessions/{session_id} | Fetch session detail and messages. | API key | Use OpenAPI for body and response schema. |
| PATCH | /api/v1/sessions/{session_id} | Update session metadata. | API key | Use OpenAPI for body and response schema. |
| POST | /api/v1/sessions/{session_id}/close | Close an active session. | API key | Use OpenAPI for body and response schema. |
| POST | /api/v1/sessions/{session_id}/archive | Archive a session. | API key | Use OpenAPI for body and response schema. |
| GET | /api/v1/sessions/{session_id}/transcript | Fetch a transcript for downstream review or storage. | API key | Use OpenAPI for body and response schema. |
| GET | /api/v1/sessions/{session_id}/export | Export a session bundle. | API key | Use OpenAPI for body and response schema. |
| GET | /api/v1/sessions/{session_id}/replay | Fetch replay data for an existing session. | API key | Use OpenAPI for body and response schema. |
| GET | /api/v1/sessions/{session_id}/shares | List share links or invitations for a session. | API key | Use OpenAPI for body and response schema. |
| POST | /api/v1/sessions/{session_id}/shares | Create a session share invitation. | API key | Use OpenAPI for body and response schema. |
| POST | /api/v1/sessions/{session_id}/shares/{share_id}/accept | Accept a session share invitation. | API key | Use OpenAPI for body and response schema. |
| DELETE | /api/v1/sessions/{session_id}/shares/{share_id} | Revoke a session share invitation. | API key | Use OpenAPI for body and response schema. |
| POST | /api/v1/sessions/{session_id}/feedback | Submit feedback against a session response. | API key | Use OpenAPI for body and response schema. |
| GET | /api/v1/feedback/metrics | Read aggregated feedback metrics. | API key | Use OpenAPI for body and response schema. |
Projects and Collaboration
Create project workspaces, manage project membership, upload project documents, and inspect project scaffolds.
| Method | Path | Purpose | Auth | Notes |
|---|---|---|---|---|
| POST | /api/v1/projects | Create a CrewOS project. | API key | Use OpenAPI for body and response schema. |
| GET | /api/v1/projects | List projects accessible to the caller. | API key | Use OpenAPI for body and response schema. |
| GET | /api/v1/projects/{project_id} | Fetch project metadata and status. | API key | Use OpenAPI for body and response schema. |
| PATCH | /api/v1/projects/{project_id} | Update project metadata. | API key | Use OpenAPI for body and response schema. |
| DELETE | /api/v1/projects/{project_id} | Delete a project when permitted. | API key | Use OpenAPI for body and response schema. |
| POST | /api/v1/projects/{project_id}/archive | Archive a project. | API key | Use OpenAPI for body and response schema. |
| GET | /api/v1/projects/{project_id}/members | List project members. | API key | Use OpenAPI for body and response schema. |
| PATCH | /api/v1/projects/{project_id}/members/{member_user_id} | Add or update a project member. | API key | Use OpenAPI for body and response schema. |
| DELETE | /api/v1/projects/{project_id}/members/{member_user_id} | Remove a project member. | API key | Use OpenAPI for body and response schema. |
| GET | /api/v1/projects/{project_id}/team-users | List team users available for project membership. | API key | Use OpenAPI for body and response schema. |
| GET | /api/v1/projects/{project_id}/access-requests | List project access requests. | API key | Use OpenAPI for body and response schema. |
| POST | /api/v1/projects/{project_id}/access-requests | Create a project access request. | API key | Use OpenAPI for body and response schema. |
| PATCH | /api/v1/projects/{project_id}/access-requests/{access_request_id} | Approve or reject a project access request. | API key | Use OpenAPI for body and response schema. |
| GET | /api/v1/projects/{project_id}/scaffold-items | List generated project scaffold items. | API key | Use OpenAPI for body and response schema. |
| GET | /api/v1/projects/{project_id}/folders | List project folders. | API key | Use OpenAPI for body and response schema. |
| GET | /api/v1/projects/{project_id}/folder-updates | List proposed project folder updates. | API key | Use OpenAPI for body and response schema. |
| POST | /api/v1/projects/{project_id}/folder-updates/{folder_update_id}/approve | Approve a project folder update. | API key | Use OpenAPI for body and response schema. |
| POST | /api/v1/projects/{project_id}/folder-updates/{folder_update_id}/reject | Reject a project folder update. | API key | Use OpenAPI for body and response schema. |
| GET | /api/v1/projects/{project_id}/documents | List project documents. | API key | Use OpenAPI for body and response schema. |
| POST | /api/v1/projects/{project_id}/documents/upload | Upload a document into a project. | API key | Use OpenAPI for body and response schema. |
| POST | /api/v1/projects/{project_id}/documents/reingest | Reingest an existing project document. | API key | Use OpenAPI for body and response schema. |
Tasks, Reviews, and Durable Jobs
Create task records, drive task lifecycle transitions, inspect events, and monitor durable background work.
| Method | Path | Purpose | Auth | Notes |
|---|---|---|---|---|
| POST | /api/v1/tasks | Create a managed task. | API key | Use OpenAPI for body and response schema. |
| GET | /api/v1/tasks | List tasks visible to the caller. | API key | Use OpenAPI for body and response schema. |
| GET | /api/v1/tasks/{task_id} | Fetch task detail, events, dependencies, agent runs, and review metadata. | API key | Use OpenAPI for body and response schema. |
| PATCH | /api/v1/tasks/{task_id} | Update task metadata. | API key | Use OpenAPI for body and response schema. |
| DELETE | /api/v1/tasks/{task_id} | Delete a task when permitted. | API key | Use OpenAPI for body and response schema. |
| POST | /api/v1/tasks/{task_id}/status | Update task status. | API key | Use OpenAPI for body and response schema. |
| PATCH | /api/v1/tasks/{task_id}/status | Patch task status. | API key | Use OpenAPI for body and response schema. |
| POST | /api/v1/tasks/{task_id}/retry | Retry task execution. | API key | Use OpenAPI for body and response schema. |
| GET | /api/v1/tasks/{task_id}/events | List task timeline events. | API key | Use OpenAPI for body and response schema. |
| POST | /api/v1/tasks/{task_id}/events | Append a task event. | API key | Use OpenAPI for body and response schema. |
| POST | /api/v1/tasks/{task_id}/dependencies | Add a task dependency. | API key | Use OpenAPI for body and response schema. |
| DELETE | /api/v1/tasks/{task_id}/dependencies/{blocks_task_id} | Remove a task dependency. | API key | Use OpenAPI for body and response schema. |
| POST | /api/v1/tasks/{task_id}/agent-runs | Create or attach a task agent-run record. | API key | Use OpenAPI for body and response schema. |
| PATCH | /api/v1/tasks/agent-runs/{run_id} | Update a task agent-run record. | API key | Use OpenAPI for body and response schema. |
| POST | /api/v1/tasks/{task_id}/review/approve | Approve a task review. | API key | Use OpenAPI for body and response schema. |
| POST | /api/v1/tasks/{task_id}/review/request-rework | Request rework on a task review. | API key | Use OpenAPI for body and response schema. |
| POST | /api/v1/tasks/{task_id}/review/block | Block a task from review completion. | API key | Use OpenAPI for body and response schema. |
| POST | /api/v1/agent-jobs | Create a durable background job for supported job kinds. | API key | Use OpenAPI for body and response schema. |
| GET | /api/v1/agent-jobs | List durable background jobs. | API key | Use OpenAPI for body and response schema. |
| GET | /api/v1/agent-jobs/{job_id} | Get durable job status, progress, health, and result payload. | API key | Use OpenAPI for body and response schema. |
| GET | /api/v1/agent-jobs/{job_id}/events | List durable job events. | API key | Use OpenAPI for body and response schema. |
| POST | /api/v1/agent-jobs/{job_id}/cancel | Request durable job cancellation. | API key | Use OpenAPI for body and response schema. |
Knowledge Base and Wiki Graph
Search, retrieve, ingest, govern, and link knowledge used by CrewOS agents.
| Method | Path | Purpose | Auth | Notes |
|---|---|---|---|---|
| GET | /api/v1/knowledge/namespaces | List namespaces visible to the caller. | API key | Use OpenAPI for body and response schema. |
| POST | /api/v1/knowledge/search | Search accessible knowledge entries. | API key | Use OpenAPI for body and response schema. |
| POST | /api/v1/knowledge/retrieve | Retrieve graph-aware knowledge context. | API key | Use OpenAPI for body and response schema. |
| GET | /api/v1/knowledge | List knowledge entries. | API key | Use OpenAPI for body and response schema. |
| POST | /api/v1/knowledge | Create a knowledge entry. | API key | Use OpenAPI for body and response schema. |
| GET | /api/v1/knowledge/{entry_id} | Fetch a knowledge entry. | API key | Use OpenAPI for body and response schema. |
| PUT | /api/v1/knowledge/{entry_id} | Update a knowledge entry. | API key | Use OpenAPI for body and response schema. |
| DELETE | /api/v1/knowledge/{entry_id} | Delete a knowledge entry. | API key | Use OpenAPI for body and response schema. |
| POST | /api/v1/knowledge/ingest | Ingest a document into the knowledge base. | API key | Use OpenAPI for body and response schema. |
| GET | /api/v1/knowledge/files | List knowledge file groups. | API key | Use OpenAPI for body and response schema. |
| DELETE | /api/v1/knowledge/files | Delete a knowledge file group. | API key | Use OpenAPI for body and response schema. |
| PATCH | /api/v1/knowledge/files/visibility | Toggle knowledge file visibility. | API key | Use OpenAPI for body and response schema. |
| GET | /api/v1/knowledge/{entry_id}/file | Download an entry source file. | API key | Use OpenAPI for body and response schema. |
| GET | /api/v1/knowledge/wiki-graph | Read the namespace wiki graph. | API key | Use OpenAPI for body and response schema. |
| GET | /api/v1/knowledge/wiki-governance | Read wiki governance queues. | API key | Use OpenAPI for body and response schema. |
| POST | /api/v1/knowledge/wiki-governance/actions | Apply a wiki governance action. | API key | Use OpenAPI for body and response schema. |
| GET | /api/v1/knowledge/{entry_id}/links | List wiki links for an entry. | API key | Use OpenAPI for body and response schema. |
| POST | /api/v1/knowledge/{entry_id}/links | Create a wiki link from an entry. | API key | Use OpenAPI for body and response schema. |
| PATCH | /api/v1/knowledge/{entry_id}/links/{link_id} | Update a wiki link. | API key | Use OpenAPI for body and response schema. |
| DELETE | /api/v1/knowledge/{entry_id}/links/{link_id} | Delete a wiki link. | API key | Use OpenAPI for body and response schema. |
| POST | /api/v1/knowledge/wiki-meditation/trigger | Trigger LLM-assisted wiki graph meditation. | Admin | Use OpenAPI for body and response schema. |
| GET | /api/v1/knowledge/wiki-meditation/runs | List recent wiki graph meditation runs. | Admin | Use OpenAPI for body and response schema. |
| POST | /api/v1/knowledge/web-research/runs | Run agent-reviewed web research for KB intake. | Admin | Use OpenAPI for body and response schema. |
| GET | /api/v1/knowledge/web-research/runs | List recent KB web research runs. | Admin | Use OpenAPI for body and response schema. |
| GET | /api/v1/knowledge/web-research/runs/{run_id} | Inspect one KB web research run. | Admin | Use OpenAPI for body and response schema. |
| POST | /api/v1/knowledge/web-research/runs/{run_id}/batch | Batch approve or reject web research candidates. | Admin | Use OpenAPI for body and response schema. |
Artifacts and Generated Files
Download generated artifacts, read editable source, and save artifact revisions.
| Method | Path | Purpose | Auth | Notes |
|---|---|---|---|---|
| GET | /api/v1/attachments/{reference_token}/download | Download a generated artifact by reference token. | API key | Use OpenAPI for body and response schema. |
| GET | /api/v1/attachments/{reference_token}/source | Fetch editable HTML artifact source. | API key | Use OpenAPI for body and response schema. |
| POST | /api/v1/attachments/{reference_token}/revisions | Save a revised HTML artifact source. | API key | Use OpenAPI for body and response schema. |
| POST | /api/v1/attachments/{reference_token}/layout-cleanup | Request layout cleanup for an HTML artifact. | API key | Use OpenAPI for body and response schema. |
Project Tokenization
Inspect readiness, manage token wallets, route token-change requests, and execute approved token operations.
| Method | Path | Purpose | Auth | Notes |
|---|---|---|---|---|
| GET | /api/v1/projects/{project_id}/tokenization/status | Read project tokenization readiness status. | API key | Use OpenAPI for body and response schema. |
| GET | /api/v1/projects/{project_id}/tokenization/wallets | List project token wallets. | API key | Use OpenAPI for body and response schema. |
| PUT | /api/v1/projects/{project_id}/tokenization/wallets/{wallet_address} | Create or update a project token wallet. | API key | Use OpenAPI for body and response schema. |
| GET | /api/v1/projects/{project_id}/tokenization/token/status | Read token ledger status. | API key | Use OpenAPI for body and response schema. |
| GET | /api/v1/projects/{project_id}/tokenization/token-requests | List token change requests. | API key | Use OpenAPI for body and response schema. |
| POST | /api/v1/projects/{project_id}/tokenization/token-requests | Create a token mint, transfer, or burn request. | API key | Use OpenAPI for body and response schema. |
| POST | /api/v1/projects/{project_id}/tokenization/token-requests/{request_id}/approve | Approve a token change request. | API key | Use OpenAPI for body and response schema. |
| POST | /api/v1/projects/{project_id}/tokenization/token-requests/{request_id}/reject | Reject a token change request. | API key | Use OpenAPI for body and response schema. |
| POST | /api/v1/projects/{project_id}/tokenization/token-requests/{request_id}/execute | Execute an approved token change request. | API key | Use OpenAPI for body and response schema. |
| POST | /api/v1/projects/{project_id}/tokenization/token/mint | Directly mint project tokens when permitted. | API key | Use OpenAPI for body and response schema. |
| POST | /api/v1/projects/{project_id}/tokenization/token/transfer | Directly transfer project tokens when permitted. | API key | Use OpenAPI for body and response schema. |
| POST | /api/v1/projects/{project_id}/tokenization/token/burn | Directly burn project tokens when permitted. | API key | Use OpenAPI for body and response schema. |
Notifications
Monitor and mark notification-center events for an external worker account.
| Method | Path | Purpose | Auth | Notes |
|---|---|---|---|---|
| GET | /api/v1/notifications | List notifications. | API key | Use OpenAPI for body and response schema. |
| GET | /api/v1/notifications/unread-count | Read unread notification count. | API key | Use OpenAPI for body and response schema. |
| POST | /api/v1/notifications/{notification_id}/read | Mark one notification as read. | API key | Use OpenAPI for body and response schema. |
| POST | /api/v1/notifications/read-all | Mark all notifications as read. | API key | Use OpenAPI for body and response schema. |
| POST | /api/v1/notifications/{notification_id}/dismiss | Dismiss one notification. | API key | Use OpenAPI for body and response schema. |
| GET | /api/v1/notifications/preferences | Read notification preferences. | API key | Use OpenAPI for body and response schema. |
| PUT | /api/v1/notifications/preferences | Update notification preferences. | API key | Use OpenAPI for body and response schema. |
Review, Validation, Testing, and Capability Gaps
Use human-review queues, validation scoring, test scenarios, and capability-gap reports in external QA agents.
| Method | Path | Purpose | Auth | Notes |
|---|---|---|---|---|
| GET | /api/v1/review/queue | List review queue items. | API key | Use OpenAPI for body and response schema. |
| POST | /api/v1/review/queue | Submit an item for review. | API key | Use OpenAPI for body and response schema. |
| GET | /api/v1/review/queue/stats | Read review queue stats. | API key | Use OpenAPI for body and response schema. |
| GET | /api/v1/review/queue/{item_id} | Fetch one review item. | API key | Use OpenAPI for body and response schema. |
| POST | /api/v1/review/queue/{item_id}/approve | Approve a review item. | API key | Use OpenAPI for body and response schema. |
| POST | /api/v1/review/queue/{item_id}/reject | Reject a review item. | API key | Use OpenAPI for body and response schema. |
| POST | /api/v1/review/queue/{item_id}/quarantine | Quarantine a review item. | API key | Use OpenAPI for body and response schema. |
| POST | /api/v1/review/queue/batch | Apply batch review decisions. | API key | Use OpenAPI for body and response schema. |
| GET | /api/v1/review/queue/{item_id}/transcript | Fetch a review item transcript. | API key | Use OpenAPI for body and response schema. |
| GET | /api/v1/review/queue/{item_id}/attachments/{attachment_index}/download | Download a review attachment. | API key | Use OpenAPI for body and response schema. |
| POST | /api/v1/validation/validate | Run validation scoring. | API key | Use OpenAPI for body and response schema. |
| GET | /api/v1/validation/logs | List validation logs. | API key | Use OpenAPI for body and response schema. |
| GET | /api/v1/validation/config | Read default validation config. | API key | Use OpenAPI for body and response schema. |
| POST | /api/v1/testing/run | Trigger a configured test run. | API key | Use OpenAPI for body and response schema. |
| GET | /api/v1/testing/runs | List test runs. | API key | Use OpenAPI for body and response schema. |
| GET | /api/v1/testing/runs/{run_id} | Fetch one test run. | API key | Use OpenAPI for body and response schema. |
| GET | /api/v1/testing/scenarios | List configured test scenarios. | API key | Use OpenAPI for body and response schema. |
| GET | /api/v1/capability-gaps/reports | List capability-gap reports. | API key | Use OpenAPI for body and response schema. |
| POST | /api/v1/capability-gaps/reports/run | Run a capability-gap report. | API key | Use OpenAPI for body and response schema. |
| GET | /api/v1/capability-gaps/reports/{report_id} | Fetch one capability-gap report. | API key | Use OpenAPI for body and response schema. |
| GET | /api/v1/capability-gaps/findings | List capability-gap findings. | API key | Use OpenAPI for body and response schema. |
| POST | /api/v1/capability-gaps/findings/{finding_id}/status | Update a capability-gap finding status. | API key | Use OpenAPI for body and response schema. |
| POST | /api/v1/capability-gaps/findings/{finding_id}/create-task | Create a task from a capability-gap finding. | API key | Use OpenAPI for body and response schema. |
Admin Automation
Privileged endpoints for external admin agents that manage users, model settings, policy, audit, and system queues.
| Method | Path | Purpose | Auth | Notes |
|---|---|---|---|---|
| GET | /api/v1/auth/users | List users. | Admin | Use OpenAPI for body and response schema. |
| PATCH | /api/v1/auth/users/{user_id} | Update a user account. | Admin | Use OpenAPI for body and response schema. |
| POST | /api/v1/auth/users/{user_id}/unlock | Unlock a user account. | Admin | Use OpenAPI for body and response schema. |
| GET | /api/v1/auth/agent-namespace-policies | List agent namespace policies. | Admin | Use OpenAPI for body and response schema. |
| PUT | /api/v1/auth/agent-namespace-policies/{agent_name} | Update an agent namespace policy. | Admin | Use OpenAPI for body and response schema. |
| GET | /api/v1/auth/tool-config | List team tool configs. | Admin | Use OpenAPI for body and response schema. |
| PUT | /api/v1/auth/tool-config/{team_id} | Update a team tool config. | Admin | Use OpenAPI for body and response schema. |
| GET | /api/v1/admin/llm-config | Read model routing configuration. | Admin | Use OpenAPI for body and response schema. |
| PUT | /api/v1/admin/llm-config | Update model routing configuration. | Admin | Use OpenAPI for body and response schema. |
| GET | /api/v1/admin/llm-config/catalog | List model catalog metadata. | Admin | Use OpenAPI for body and response schema. |
| GET | /api/v1/admin/llm-config/token-budget | Read token-budget controls. | Admin | Use OpenAPI for body and response schema. |
| PUT | /api/v1/admin/llm-config/token-budget | Update token-budget controls. | Admin | Use OpenAPI for body and response schema. |
| GET | /api/v1/admin/llm-usage/summary | Read LLM usage summary. | Admin | Use OpenAPI for body and response schema. |
| GET | /api/v1/admin/cache | Read semantic cache stats. | Admin | Use OpenAPI for body and response schema. |
| POST | /api/v1/admin/cache/invalidate | Invalidate semantic cache entries. | Admin | Use OpenAPI for body and response schema. |
| GET | /api/v1/admin/queue/stats | Read backend queue stats. | Admin | Use OpenAPI for body and response schema. |
| GET | /api/v1/audit/events | List audit events. | Admin | Use OpenAPI for body and response schema. |
| GET | /api/v1/audit/events/export.csv | Export audit events as CSV. | Admin | Use OpenAPI for body and response schema. |
| GET | /api/v1/audit/integrity | Verify audit-log integrity. | Admin | Use OpenAPI for body and response schema. |
| GET | /api/v1/pipeline-policy | Read default pipeline policy. | Admin | Use OpenAPI for body and response schema. |
| PUT | /api/v1/pipeline-policy | Update default pipeline policy. | Admin | Use OpenAPI for body and response schema. |
| GET | /api/v1/prompt-standards | List prompt standards. | Admin | Use OpenAPI for body and response schema. |
| PUT | /api/v1/prompt-standards/{agent_name} | Upsert a prompt standard. | Admin | Use OpenAPI for body and response schema. |
Health and Discovery Documents
Unauthenticated endpoints useful for monitors, load balancers, and client-code generation.
| Method | Path | Purpose | Auth | Notes |
|---|---|---|---|---|
| GET | /health/live | Liveness probe. | Public | Use OpenAPI for body and response schema. |
| GET | /health/ready | Deep readiness probe. | Public | Use OpenAPI for body and response schema. |
| GET | /health | Readiness alias. | Public | Use OpenAPI for body and response schema. |
| GET | /openapi.json | Generated OpenAPI schema for exact request and response shapes. | Public | Use OpenAPI for body and response schema. |
| GET | /docs | Generated FastAPI Swagger UI. | Public | Use OpenAPI for body and response schema. |