Developers
Submit a customer API job
Keys, idempotency, caps and result pagination.
Use a scoped key
Use a Live key with submit scope for production verification. Keep it on your server and assign only the submit, read or balance scopes you need. Test keys simulate reserved example addresses with no provider call or credit use.
The live key cap counts credits charged plus accepted reservations. If the cap is reached, a new job is refused without creating a hold. Workspace credits are reserved as checks are admitted for processing, using the same charging and return rules as the dashboard.
Safe retries
Send a stable Idempotency-Key with a job. A matching retry returns the same job. Use the returned job ID to read state and paginated results. A repeated key with a different payload is rejected.
An operational pause can temporarily refuse new live jobs with HTTP 503 live_verification_unavailable and no credit hold. Retry later with the same idempotency key. This is separate from API-key permissions, key caps and rate limits.