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

# Getting started

> Create an API key and make your first Public API v1 request.

Get from zero to a working API call in a few minutes.

## Prerequisites

* A Chatarmin CX workspace with permission to manage API keys (**Settings → API**)
* `curl` or any HTTP client (for example Postman)

## Step 1 — Create an API key

<Steps>
  <Step title="Open API settings">
    In the dashboard, go to [Settings → API](https://armin.cx/app/_/settings/api).
  </Step>

  <Step title="Create a key">
    Click **Create API key**, give it a name, and select scopes. For read-only integrations and AI agents, **`tickets:read`** is enough.
  </Step>

  <Step title="Copy the key">
    Copy the key and store it in a secrets manager, not in source control.
  </Step>
</Steps>

See [Authentication & API keys](/api/authentication) for scope details and rotation guidance.

## Step 2 — Verify connectivity

Send a health check with your key:

```bash theme={null}
curl -sS \
  -H "cx-api-key: YOUR_API_KEY" \
  "https://api.armin.cx/public/v1/health"
```

Expected response:

```json theme={null}
{
  "success": true,
  "data": {
    "version": "v1"
  }
}
```

The health endpoint requires a valid key but does not enforce a specific scope — useful to confirm auth before calling ticket routes.

## Step 3 — List tickets

```bash theme={null}
curl -sS \
  -H "cx-api-key: YOUR_API_KEY" \
  "https://api.armin.cx/public/v1/tickets?limit=5"
```

Every v1 success response uses the `{ "success": true, "data": ... }` envelope. List endpoints also return `pagination`:

```json theme={null}
{
  "success": true,
  "data": [ ... ],
  "pagination": {
    "has_more": true,
    "next_cursor": "2026-07-20T10:00:00.000Z|019b..."
  }
}
```

Pass `pagination.next_cursor` as the `cursor` query parameter to fetch the next page. See [Pagination](/api/pagination).

## Step 4 — Explore saved views

Most agent workflows start with saved inbox views:

```bash theme={null}
curl -sS \
  -H "cx-api-key: YOUR_API_KEY" \
  "https://api.armin.cx/public/v1/views"
```

Pick a view `id`, then list tickets filtered by that view:

```bash theme={null}
curl -sS \
  -H "cx-api-key: YOUR_API_KEY" \
  "https://api.armin.cx/public/v1/tickets?view_id=VIEW_UUID&limit=40"
```

See [Filtering & saved views](/api/filtering-and-saved-views) for the full workflow.

## Next steps

<CardGroup cols={2}>
  <Card title="OpenAPI reference" icon="book" href="https://api.armin.cx/docs/v1">
    Full endpoint reference with schemas and Try it.
  </Card>

  <Card title="Agent tool examples" icon="robot" href="/api/agent-tool-examples">
    Common AI agent patterns mapped to API calls.
  </Card>
</CardGroup>