> ## Documentation Index
> Fetch the complete documentation index at: https://docs.atlaswork.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# API reference

> Generated straight from the OpenAPI spec — never hand-maintained.

The pages under **Endpoints** are generated from the API's OpenAPI document.
This reference is never hand-written: adding a route to the API regenerates the
spec, and these pages follow automatically.

* **Spec:** served by the API at `/api/openapi.json`, and downloadable from this
  site at [`/openapi.json`](https://docs.atlaswork.ai/openapi.json)
* **Base URL:** `https://api-atlaswork.vercel.app` (endpoints are mounted under `/api`)

<Note>
  Once the custom domain lands, the API serves from `api.atlaswork.ai`. The generated reference is
  unaffected — it always follows the spec.
</Note>

## Authentication

The REST API (`/api/v1`) uses [API keys](/guides/authentication#api-keys) passed
as a bearer token:

```bash theme={null}
curl https://api-atlaswork.vercel.app/api/v1/ping \
  -H "Authorization: Bearer $ATLAS_API_KEY"
```

## Conventions

* **One error envelope** — every error is `{ "code", "message" }`. See
  [Errors](/guides/errors).
* **Idempotent writes** — state-changing calls accept an idempotency key. See
  [Idempotency](/guides/idempotency).
* **OpenAPI is generated, never hand-written** — REST routes are defined in code;
  the spec (and this reference) follow automatically.

## Try it

Every endpoint page below includes an interactive playground. Add your API key
and send a real request without leaving the docs.