> This page is for version V3 - Beta (default).
> For other versions, use one of these documentation indexes:
> - V3 - Beta (default): https://docs.authlyx.dev/v3/llms.txt
> - V2 - Legacy: https://docs.authlyx.dev/v2/llms.txt
> - V1 - End of support: https://docs.authlyx.dev/v1/llms.txt

> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.authlyx.dev/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.authlyx.dev/_mcp/server.

# Using the API

> Understand versions, HTTP methods and authentication before sending requests.

## Base URL

The API listens at `https://api.authlyx.dev`. V3 runtime requests use `/v3/`. Server-side record management uses `/management/v1/`; that management version is separate from the SDK protocol version.

## HTTP methods

The endpoint reference shows the actual method beside every route. Health endpoints use **GET**. V3 SDK actions use **POST** with `Content-Type: application/json` and a JSON body. Record management uses **GET** to list and **POST** with an action to change data. There are no public PUT routes in the current rebuild.

## Authentication

| API                     | Credential                                           | Where to use it        |
| ----------------------- | ---------------------------------------------------- | ---------------------- |
| V3 initialization       | AppKey and app version                               | Customer application   |
| V3 sign-in              | AppKey, credentials and installation challenge proof | SDK handles the proof  |
| Protected V3 operations | Session bearer token plus installation request proof | SDK handles signing    |
| Management              | Account-level Elite Key with permissions             | Developer server       |
| Bot commands            | Account-level Bot Key with permissions               | Self-hosted bot server |

> **Keep Elite Keys and Bot Keys on your server**
>
> Never include an Elite Key or Bot Key in customer software. An AppKey identifies an application and cannot replace a management key.

## Responses

Protected V3 responses contain `success`, `code`, `message`, `data`, `requestId` and `verification`. Verify the response first, then read `success` and the stable code. The SDK returns a language-appropriate result object.

## Try a request

```bash
```

```bash
curl -X POST https://api.authlyx.dev/v3/initialize \
  -H "Content-Type: application/json" \
  -H "X-AuthlyX-Nonce: 0123456789abcdef0123456789abcdef" \
  -d '{"appKey":"YOUR_APP_KEY","version":"1.0.0"}'
```

Use a fresh random nonce in real requests. This command shows the HTTP shape; use the SDK or a verified implementation to validate signatures. Protected endpoint examples also need valid installation proof headers. A copied bearer token alone is insufficient.

## API explorer

Fern's API reference provides an explorer. Public health/init requests are easy to test. Protected operations require fresh proof, so pasting placeholder headers will fail. Use the SDK to generate and sign requests. In published docs, `localhost` refers to the reader's own computer, not AuthlyX's server.

V1 and V2 references are archived separately. Their explorers are disabled so archived examples are not mistaken for the current V3 service. Internal dashboard, admin, OAuth callback and payment-provider webhook routes are not customer integration APIs.

Examples use made-up accounts, keys and tokens. Use your own credentials and generate fresh request signatures. Example signatures are not production credentials.