Platform

Errors

Relay uses standard HTTP status codes. Error responses always include a detail field with a human-readable message.

Error format

json

{
  "detail": "Hall not found"
}

200 OK

Request succeeded. Response body contains the result.

201 Created

Resource created. Returned by POST /v1/halls.

204 No Content

Request succeeded with no response body. Returned by DELETE endpoints.

400 Bad Request

Invalid request body or missing required parameters.

401 Unauthorized

API key is missing, invalid, or revoked.

403 Forbidden

Action not allowed — typically a plan limit violation.

404 Not Found

The requested resource does not exist or belongs to another organisation.

422 Unprocessable Entity

Request body is valid JSON but fails schema validation.

429 Too Many Requests

Rate limit exceeded. See the rate limits page.

502 Bad Gateway

Relay could not reach the media server. Retry the request.

503 Service Unavailable

Relay is temporarily unavailable. Check status.relay.dev.

401 — Invalid or missing API key

Check that the Authorization header is set correctly: Authorization: Bearer relay_live_...

403 — Plan limit exceeded

You have reached a limit enforced by your plan (e.g. max concurrent halls). Upgrade your plan or close existing halls.

400 — Recording requires storage configuration

You set record: true but have not configured S3 credentials. Go to Dashboard → Settings → Storage.

502 — Failed to create media room

Relay could not provision a LiveKit room. This is transient — retry the request. If it persists, check status.relay.dev.