Guides

How the API works, from your first request to running it in production.

• QuickstartMake your first request in five minutes with a free sandbox key.
• Keys and sandboxLive and sandbox keys, personal and organisation keys, scopes, expiry, IP allow-lists and keeping secrets safe.
• Jobs, polling, webhooks and streamingHow long work stays safe: 202 straight away, then poll, listen for a webhook or stream progress.
• WebhooksSigned notices when jobs finish and when things happen in your centre, with retries and replays.
• Files and uploadsUpload a document, recording or course file once, then refer to it by file_id.
• ErrorsOne error shape everywhere, stable codes and what to do about each status.
• Rate limitsRequest limits per key, per-product limits and how to stay inside them.
• Billing and creditsPrepaid API balance, paying with your paid credits, bulk bonus, limits and alerts.
• VersioningDated versions, what can change without notice and how to pin.
• LMS data API: auth and paginationRead and change learners, courses, enrolments and results inside your centre.
• EventsKnow when work arrives, marks are approved, results are released and learners enrol.