Base URL
/v1. Requests and responses are JSON, except GET /v1/docs, which returns a short machine-readable markdown quickstart without authentication.
What you can do
Posts take images: presign with
POST /v1/media, PUT the bytes, then attach the returned object_key via parts[].media (up to 4 images or exactly 1 GIF per part, optional alt_text). JPG, PNG, WEBP up to 5MB; GIF up to 15MB. Video is not supported yet.
Conventions
- Timestamps are UTC ISO-8601 in both directions. Inputs must include an explicit
Zor a numeric offset (2026-07-06T12:00:00Z,2026-07-06T14:00:00+02:00). Timestamps without a timezone are rejected with400 invalid_parameter. - Lists return
{ "data": [...], "pagination": { "page", "limit", "has_more", "total"? } }.limitis capped at 100;totalappears only where it is cheap to compute. - Errors return
{ "error": { "code", "message" } }with a stable machine-readable code. See Errors for the codes and one legacy exception. - Account selection: most endpoints accept an
account_idparameter. When omitted, your main account is used. See Accounts.
Quick start
- Create an API key in the SuperX app: Account > API / MCP / CLI.
- Copy the key when it is shown. It is displayed exactly once.
- Make a request:
Requirements
An active SuperX subscription (including trials and team-billed accounts). If the subscription lapses, requests return403 until you resubscribe; your keys are kept and start working again automatically.