API Reference Complete reference for all Aira API endpoints.
https://api.airaproof.com/api/v1 All endpoints are prefixed with /api/v1. Responses are JSON. All timestamps are ISO 8601 UTC.
Interactive API docs are available on self-hosted deployments and development environments:
Swagger UI : /docsReDoc : /redocOpenAPI Schema : /openapi.json
Note: Interactive docs are disabled on the production cloud API for security. Use this documentation or a self-hosted instance for interactive exploration.
Method Endpoint Auth Description POST/auth/registerNone Create organization + user account POST/auth/loginNone Get JWT token for dashboard POST/auth/oauthNone OAuth login (Google, GitHub, GitLab) GET/auth/meJWT Get current user info POST/auth/leave-orgJWT Leave organization (non-owners) DELETE/auth/accountJWT (owner) Delete organization and all data
Method Endpoint Auth Description GET/team/membersAdmin+ List organization members PUT/team/members/{id}/roleAdmin+ Update member role DELETE/team/members/{id}Admin+ Remove member GET/team/invitesAdmin+ List pending invites POST/team/invitesAdmin+ Send invite DELETE/team/invites/{id}Admin+ Cancel invite POST/team/transfer-ownershipOwner Transfer org ownership to an admin
Method Endpoint Auth Description POST/api-keysAdmin+ Create new API key GET/api-keysAdmin+ List all keys (masked) DELETE/api-keys/{id}Admin+ Revoke a key
Method Endpoint Auth Description POST/casesRequired Execute consensus case POST/cases/streamRequired Submit case with SSE streaming GET/cases/{id}Required Get case run details GET/casesRequired List case runs (paginated)
Method Endpoint Auth Description GET/receipts/{id}Required Get receipt details GET/receipts/{id}/exportRequired Export as JSON
Method Endpoint Auth Description GET/verify/{receipt_uuid}None Verify receipt by ID GET/verify/action/{action_uuid}None Verify action receipt GET/.well-known/keysNone List signing public keys
Method Endpoint Auth Description POST/actionsRequired Notarize an agent action GET/actionsRequired List actions (paginated, filterable) GET/actions/{id}Required Get action + receipt + authorizations POST/actions/{id}/cosignJWT only Human co-sign an action POST/actions/{id}/holdRequired Set legal hold DELETE/actions/{id}/holdRequired Release legal hold GET/actions/{id}/chainRequired Chain of custody
Method Endpoint Auth Description POST/agentsRequired Register an agent GET/agentsRequired List agents (paginated) GET/agents/{slug}Required Get agent detail + versions PUT/agents/{slug}Required Update agent metadata POST/agents/{slug}/versionsRequired Publish new version GET/agents/{slug}/versionsRequired List versions POST/agents/{slug}/decommissionRequired Decommission agent POST/agents/{slug}/transferRequired Transfer ownership GET/agents/{slug}/actionsRequired Actions by this agent GET/agents/public/{slug}None Public identity page
Method Endpoint Auth Description POST/evidence/packagesRequired Create sealed evidence package GET/evidence/packagesRequired List evidence packages GET/evidence/packages/{id}Required Get package detail POST/evidence/time-travelRequired Point-in-time query GET/evidence/liability-chain/{id}Required Multi-hop liability chain
Method Endpoint Auth Description PUT/estate/agents/{slug}/willRequired Set/update agent will GET/estate/agents/{slug}/willRequired Get agent will POST/estate/agents/{slug}/death-certificateRequired Issue death certificate GET/estate/agents/{slug}/death-certificateRequired Get death certificate POST/estate/complianceRequired Create compliance snapshot GET/estate/complianceRequired List snapshots
Method Endpoint Auth Description POST/escrow/accountsRequired Create escrow account GET/escrow/accountsRequired List accounts GET/escrow/accounts/{id}Required Get account + transactions POST/escrow/accounts/{id}/depositRequired Record liability commitment POST/escrow/accounts/{id}/releaseRequired Release liability commitment POST/escrow/accounts/{id}/disputeRequired File dispute
Method Endpoint Auth Description POST/provider-credentialsAdmin+ Set/merge provider credentials GET/provider-credentialsAdmin+ Get credential status DELETE/provider-credentials?provider=xxxAdmin+ Delete provider credentials
Method Endpoint Auth Description POST/models/customRequired Register custom model GET/models/customRequired List custom models GET/models/custom/{id}Required Get custom model PUT/models/custom/{id}Required Update custom model DELETE/models/custom/{id}Required Delete custom model POST/models/custom/{id}/testRequired Test model endpoint
Method Endpoint Auth Description POST/webhooksAdmin+ Create webhook GET/webhooksAdmin+ List webhooks DELETE/webhooks/{id}Admin+ Delete webhook GET/webhooks/{id}/deliveriesAdmin+ List delivery log
Method Endpoint Auth Description GET/usageAdmin+ Get usage summary GET/usage/eventsAdmin+ List usage events
Method Endpoint Auth Description GET/audit-logsAdmin+ List audit log events (filterable, paginated)
Method Endpoint Auth Description GET/modelsOptional List available models (9 built-in + custom) GET/models/preferencesRequired Get disabled models list PUT/models/preferencesRequired Update disabled models list
Method Endpoint Auth Description GET/configNone Get deployment configuration
Method Endpoint Auth Description GET/healthNone Service health check
Authorization : Bearer aira_live_xxxxx Content-Type : application/json Content-Type : application/json X-Request-ID : req_a1b2c3d4e5f6 Every response includes a request_id field for support and debugging.
List endpoints return paginated results:
{ "data" : [ ... ], "pagination" : { "page" : 1 , "per_page" : 20 , "total" : 245 , "has_more" : true }, "request_id" : "req_..." } Query parameters:
page (default: 1, min: 1)per_page (default: 20, min: 1, max: 100)
The case execution endpoint supports idempotency keys to prevent duplicate processing on network retries:
{ "details" : "..." , "models" : [ "..." ], "options" : { "idempotency_key" : "loan-app-12345-v1" } } If the same idempotency_key is sent twice, the second request returns 409 DUPLICATE_REQUEST with the original case ID.