API Basics

The conventions shared by every Atria Open API endpoint. (Pagination is per-endpoint and documented in the API Reference, not here.)

Base URL

https://api.tryatria.com

All endpoints live under /open/v1/.

Authentication

Every request must include your API key in the X-API-Key header:

X-API-Key: atria-sk_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

API keys start with the atria-sk_ prefix. To create one:

1. In the Atria web app, click the avatar in the top-left corner.
2. Go to Settings & members → API Keys.
3. Click Create API key to issue a new key.

🚧

Copy your key immediately

The full key is shown only once at creation time — store it in a password manager or secrets vault before closing the modal. If you lose it, you'll need to rotate to a new key.

Each workspace can have up to two active keys.

If the X-API-Key header is missing, the gateway returns 401 with error: "unauthorized":

{
  "error": "unauthorized",
  "message": "No valid credentials provided",
  "request_id": "db254fccc64f0e57f3156b8274620426"
}

If the header is present but the key isn't recognized (unknown, disabled, suspended, or expired), you get 401 with error: "invalid_api_key":

{
  "error": "invalid_api_key",
  "message": "The provided API key is invalid",
  "request_id": "20a3d4af927efade86e6ff9f1cae3ff7"
}

Response envelope

Every successful endpoint returns the same wrapper:

{
  "code": 0,
  "message": "ok",
  "data": { ... }
}

• code: 0 means success. A non-zero code indicates a business-level error — read message for context.
• Gateway-level errors (401, 429, 5xx) bypass the envelope and return a flat { error, message, request_id } shape. Always check the HTTP status first.

Rate limits