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

# A clear interface to the website.

> Use the shared AVRXT gateway over HTTPS and JSON.

The public gateway base URL is:

```text theme={null}
https://api.avrxt.dev/v1
```

## Your first request

```bash curl theme={null}
curl --fail-with-body https://api.avrxt.dev/v1/health
```

```javascript JavaScript theme={null}
const response = await fetch("https://api.avrxt.dev/v1/health");
if (!response.ok) throw new Error(`HTTP ${response.status}`);
const health = await response.json();
console.log(health);
```

```python Python theme={null}
import json
from urllib.request import urlopen

with urlopen("https://api.avrxt.dev/v1/health", timeout=10) as response:
    print(json.load(response))
```

## Access and boundaries

Read-only public endpoints do not require an administrator session. Browser-origin restrictions, rate limits, and endpoint-specific validation still apply. Administrative and write endpoints are not a general-purpose public integration API.

## Machine-readable reference

The [OpenAPI document](https://docs.avrxt.dev/openapi.json) is a migration-time snapshot of the public schema. The main website also serves its [current OpenAPI document](https://www.avrxt.dev/openapi.json).

The listening endpoint retains a Spotify-compatible path for existing clients even though the backend now uses Last.fm data.

> [!NOTE]
>
> The interactive playground is disabled to avoid accidental writes or reliance on browser-origin permissions. Use a terminal for the read-only examples.


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