API reference

The Skoup API is organized around REST: predictable resource-oriented URLs, JSON request and response bodies, standard HTTP verbs and status codes. Every object carries a prefixed id and an object name.

• Authentication — Bearer API keys (skoup_live_… / skoup_test_…) and scopes.
• Test mode — Test keys work on a sandbox; writes are rolled back.
• Errors — { error: { type, code, message, param, doc_url, request_id } }.
• Pagination — limit + starting_after cursors, { object: "list", data, has_more }.
• Idempotency — Idempotency-Key on every POST, replayed for 24 h.
• Rate limits & quotas — X-RateLimit-* and Skoup-Quota-* response headers.
• Object IDs — Prefixed ids (br_, task_, alrt_…), opaque strings.

Download the OpenAPI spec — OpenAPI 3.1 document of the public API — import it in Postman, Insomnia or a client generator.