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

# API Reference

> RESTful endpoints for integrating with Operark, generated from the live OpenAPI spec.

The Operark API is organized around predictable, resource-oriented URLs and
standard HTTP semantics. Every endpoint on the following pages is generated
directly from the [OpenAPI specification](/api-reference/openapi.json), so it
stays in step with the platform.

## Base URL

```
https://api.operark.com
```

Use `http://localhost:3001` when developing against a local instance.

## Surfaces

| Prefix      | Surface                                                          | Auth    |
| ----------- | ---------------------------------------------------------------- | ------- |
| `/api/v1/*` | Public v1 — executives, agents, sessions, webhooks, organization | API key |
| `/api/v2/*` | Public v2 — governance, analytics, agent execution               | API key |

## Conventions

* **Authentication** — `Authorization: Bearer YOUR_API_KEY` on every request.
  See [Authentication](/authentication).
* **Content type** — request and response bodies are JSON.
* **Pagination** — list endpoints are paginated; follow the returned cursors.
* **Errors** — a consistent envelope with a machine-readable `code`. See
  [Authentication → Errors](/authentication#errors).
* **Idempotency** — retried `5xx` failures are safe for idempotent operations.

<Card title="Quickstart" icon="rocket" href="/quickstart">
  New here? Make your first call in five minutes.
</Card>
