API Reference

Jobs API

POST /v1/jobs queues an operation. GET /v1/jobs/{id} checks status, progress, and debited credits.

Queue a Job (POST /v1/jobs)

The request must include an Idempotency-Key header. Replaying the same key with identical input returns the original job without creating duplicates.

operationstringrequired

Studio operation name: 'document.translate', 'document.extract', 'document.transliterate', or 'document.summarize'.

inputobjectrequired

Operation-specific payload containing uploadId and tool parameters.

webhookUrlstringoptional

Optional HTTPS URL to receive an HMAC-signed JSON payload upon job state transitions.

Public Job Object

FieldTypeDescription
idstringUnique public UUID for the job
operationstringThe operation that was called
statusstringqueued | running | succeeded | failed
createdAtstringISO 8601 UTC timestamp
errorCodestring | nullError identifier if the job failed
chargedCreditsnumber | nullExact number of credits debited upon completion