Public API

Credits

API conversions spend the same credits as the website.

Conversions made through the API use the same credits as the website: one balance per organization, shared by the dashboard and every API key. Test-mode keys never use credits (see Test mode).

See Pricing for current plans, credit packs and what a credit costs.

In the API

  • GET /operations lists every supported conversion with a credits_estimated value.
  • A job reports credits_estimated when it is created and credits_used once it has finished. A job that fails or is cancelled uses no credits.
  • GET /me returns your organization's current credits.balance.
  • If your balance cannot cover a job, POST /jobs answers 402 insufficient_credits with credits_required and credits_available in error.details, and nothing is created.

This page will describe how a job's credits are reserved and settled once the new credit system is live.

On this page