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

# Relay HTTP API

> Control-plane endpoints agents call on relay.fau.run.

Base URL: `https://relay.fau.run`

JSON bodies; errors are `{"error":"…","detail":"…"}`.

## `GET /v1/health`

```json theme={null}
{ "status": "ok", "nodes_connected": 12, "version": "…" }
```

## `GET /v1/transparency`

Static JSON: what the relay can observe (`can_see` / `cannot_see`), retention notes,
and metrics names. Metadata only — no mail.

## `POST /v1/resolve`

See [Resolve](https://docs.fau.run/developer/connect/resolve.md).

## Offline queue

See [Offline queue](https://docs.fau.run/developer/connect/offline-queue.md).

| Method | Path |
| - | - |
| `POST` | `/v1/queue/{hostname}` — body `{envelope, reply_pubkey, request_id?}` → `202` |
| `GET` | `/v1/queue/reply/{request_id}?wait=N` — claim via `X-FAU-Queue-Claim`; `N` is capped at 60 seconds; `401` / `200` / `204` / `404` |

Generate an idempotent `request_id` and persist its reply private key in the
[outstanding request store](https://docs.fau.run/developer/connect/outstanding-requests.md) before enqueueing. A long-poll timeout returns `204`.

## Not for agents

Node self-service only:

* `POST /v1/register`, `/v1/register/confirm`
* `POST /v1/acme/*`
* `POST /v1/node/*`, `DELETE /v1/node`, `GET /v1/node/status`

## Protocol version

**`fau/1`**. Breaking changes bump the version. This site’s
[Wire specification](https://docs.fau.run/developer/protocol/spec.md) is the public contract.


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