Information
- OpenAPI version:
3.1.0
Overview
Aura API 0.1.0
Section titled “Aura API 0.1.0”The public Aura REST API. Every endpoint is authenticated with a company API key (sk-aura-…) sent as Authorization: Bearer <key>, and is scoped to that key’s company.
Most callers should reach for the TypeScript SDK, the Python SDK or the CLI rather than calling these endpoints directly.
Not wrapped by the SDKs
The SDKs cover the run journey. These operations are REST-only — call them with the same key and host, and the SDK’s baseUrl / base_url to compose the URL:
- Rename or describe a project —
PATCH /api/v1/projects/{project_id} - Rename a conversation —
PATCH /api/v1/projects/{project_id}/conversations/{conversation_id} - Make a conversation the active one —
POST /api/v1/projects/{project_id}/conversations/{conversation_id}/activate - Read a conversation’s full message history —
GET /api/v1/projects/{project_id}/chat - Clear a project’s chat —
DELETE /api/v1/projects/{project_id}/chat - Capture a snapshot on demand —
POST /api/v1/projects/{project_id}/snapshots - Read one tag by name —
GET /api/v1/projects/{project_id}/tags/{name} - Delete a tag —
DELETE /api/v1/projects/{project_id}/tags/{name} - Delete a solve execution —
DELETE /api/v1/projects/{project_id}/solve/executions/{execution_id} - List the agent’s tool executions, or its recent tool failures —
GET /api/v1/projects/{project_id}/tool-executions, /tool-failures/recent - Restart the run dashboard —
POST /api/v1/projects/{project_id}/run/dashboard/restart - Run a command the dashboard declares —
POST /api/v1/projects/{project_id}/run/dashboard/commands/{command} - Create a directory, move files, or delete or move several at once —
POST /api/v1/files/mkdir, /files/move, /files/batch-move, /files/batch-delete - A download URL for one file —
POST /api/v1/files/download - A conversation’s debug bundle —
GET /api/v1/projects/{project_id}/conversations/{conversation_id}/debug-bundle
The upload legs (PUT /files/upload/body, POST /files/upload/abort) and GET /files/raw are the plumbing behind uploadFile / upload_file and zipUrl / zip_url; there is no reason to call them yourself.
Authentication
Section titled “Authentication”apiKey
Section titled “apiKey”A company API key (sk-aura-…). Mint one in Company settings → API keys.
Security scheme type: http