Getting Started

1. Create an API key: Administration → API Key → Add Key. Copy the plain key shown in the modal — it will not be shown again.
2. Upload an audio asset, or use one already approved in your Audio Library.
3. Poll Audio Status until status is approved — required before the asset can be used in a broadcast (unless your key auto-approves).
4. Check your balance for the module your key is scoped to.
5. Send a broadcast.
6. Poll the broadcast's number status until it settles.

Authentication

Every request must carry an API key, created from your account's Administration → API Key screen. The key is shown to you exactly once at creation. It can be supplied any of the following ways — the first one found wins, checked in this order:

GET/POST equivalence

Every endpoint accepts both GET and POST for the exact same operation — never PUT, PATCH, or DELETE. Parameters can be sent as a GET query string, a POST form body, or a POST JSON body — all equivalent for every endpoint that isn't a file upload.

Response envelope

Every response — success or failure, on every endpoint — has one of these three shapes.

Success:

{
  "success": true,
  "message": "OK",
  "data": {"...": "..."},
  "request_id": "9c4a2e3e-9b7b-4a1e-8f39-2a3f6b7c9d10"
}

Failure (any code other than REQ_VALIDATION_FAILED):

{
  "success": false,
  "message": "A short, human-readable description of what went wrong.",
  "error": {"code": "SOME_ERROR_CODE", "details": null},
  "request_id": "9c4a2e3e-9b7b-4a1e-8f39-2a3f6b7c9d10"
}

Failure (REQ_VALIDATION_FAILED specifically):

{
  "success": false,
  "message": "The given data was invalid.",
  "error": {
    "code": "REQ_VALIDATION_FAILED",
    "fields": [
      {"field": "did", "code": "REQ_FIELD_REQUIRED", "message": "The did field is required."}
    ]
  },
  "request_id": "9c4a2e3e-9b7b-4a1e-8f39-2a3f6b7c9d10"
}

Rate limits

• Two limits apply, and either can produce a SYS_RATE_LIMITED response with a Retry-After header:
• Per API key — your normal usage limit, applied once your key has been validated.
• Per source IP, for failed authentication only — a much lower limit that bounds invalid-key attempts. It does not apply once a request authenticates successfully.

Error codes

Codes marked Reserved are defined in the catalogue but not currently emitted by anything in this API.

AUTH_*

REQ_*

AUDIO_*

BCAST_*

BILLING_*

SYS_*