Skip to content
Aura

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.

Information

  • OpenAPI version: 3.1.0

Operations

Section titled “Operations”
GET
/api/v1/deployments
POST
/api/v1/deployments
GET
/api/v1/deployments/{name}
DELETE
/api/v1/deployments/{name}
POST
/api/v1/deployments/{name}/check
POST
/api/v1/files/batch-delete
POST
/api/v1/files/batch-move
POST
/api/v1/files/content
POST
/api/v1/files/delete
POST
/api/v1/files/download
POST
/api/v1/files/list
POST
/api/v1/files/mkdir
POST
/api/v1/files/move
GET
/api/v1/files/raw
POST
/api/v1/files/upload
POST
/api/v1/files/upload/abort
PUT
/api/v1/files/upload/body
POST
/api/v1/files/upload/complete
POST
/api/v1/files/zip
GET
/api/v1/projects
POST
/api/v1/projects
GET
/api/v1/projects/{project_id}
DELETE
/api/v1/projects/{project_id}
PATCH
/api/v1/projects/{project_id}
GET
/api/v1/projects/{project_id}/agent-status
POST
/api/v1/projects/{project_id}/agent/cancel
GET
/api/v1/projects/{project_id}/chat
POST
/api/v1/projects/{project_id}/chat
DELETE
/api/v1/projects/{project_id}/chat
GET
/api/v1/projects/{project_id}/chat/sync
GET
/api/v1/projects/{project_id}/conversations/{conversation_id}/debug-bundle
GET
/api/v1/projects/{project_id}/tool-executions
GET
/api/v1/projects/{project_id}/tool-failures/recent
GET
/api/v1/projects/{project_id}/conversations
POST
/api/v1/projects/{project_id}/conversations
DELETE
/api/v1/projects/{project_id}/conversations/{conversation_id}
PATCH
/api/v1/projects/{project_id}/conversations/{conversation_id}
POST
/api/v1/projects/{project_id}/conversations/{conversation_id}/activate
GET
/api/v1/projects/{project_id}/snapshots
POST
/api/v1/projects/{project_id}/snapshots
GET
/api/v1/projects/{project_id}/snapshots/{ref}
PATCH
/api/v1/projects/{project_id}/snapshots/{snapshot_id}
GET
/api/v1/projects/{project_id}/solve/executions
GET
/api/v1/projects/{project_id}/solve/executions/{execution_id}
DELETE
/api/v1/projects/{project_id}/solve/executions/{execution_id}
GET
/api/v1/projects/{project_id}/tags
GET
/api/v1/projects/{project_id}/tags/{name}
PUT
/api/v1/projects/{project_id}/tags/{name}
DELETE
/api/v1/projects/{project_id}/tags/{name}
POST
/api/v1/projects/{project_id}/workspace/checkout

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