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

# API Reference

> The canonical AtlaSent REST API, rendered from the OpenAPI specification.

The AtlaSent API is a REST API over HTTPS. All requests and responses are JSON. All endpoints are versioned under `/v1/`.

## Base URLs

| Environment | URL |
| - | - |
| Production | `https://api.atlasent.io/functions/v1` |

Endpoints are hyphenated function names appended to the base URL, e.g.
`https://api.atlasent.io/functions/v1/v1-evaluate`. Keys issued by
[console.atlasent.io](https://console.atlasent.io) are live keys (`ask_live_...`), and a live
key is accepted only with `context.environment` set to `production`. Test keys
(`ask_test_...`) belong to a separate staging environment, available on request —
contact [support@atlasent.io](mailto:support@atlasent.io).

## Source of truth

This reference is generated from the AtlaSent OpenAPI specification (`openapi.yaml`), rendered in the API reference.

For the canonical type names (TypeScript ↔ OpenAPI mapping, permit lifecycle), start with the Wire contract page.

## Quick links

<CardGroup cols={2}>
  <Card title="Authentication" icon="key" href="/api-reference/authentication">
    JWT bearer (user sessions) and API keys (service-to-service).
  </Card>

  <Card title="Rate limits" icon="gauge-high" href="/api-reference/rate-limits">
    Per-key and per-org quotas, plus 429 handling guidance.
  </Card>

  <Card title="Errors" icon="triangle-exclamation" href="/api-reference/errors">
    Every `error` code value and how to recover.
  </Card>

  <Card title="Pagination" icon="arrow-right" href="/api-reference/pagination">
    Cursor-based, stable across inserts.
  </Card>
</CardGroup>

## Full endpoint index

See the **Endpoints** section in the sidebar — every path from the OpenAPI spec is rendered there as an interactive reference (try-it-out included).


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.