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.
operationstringrequiredStudio operation name: 'document.translate', 'document.extract', 'document.transliterate', or 'document.summarize'.
inputobjectrequiredOperation-specific payload containing uploadId and tool parameters.
webhookUrlstringoptionalOptional HTTPS URL to receive an HMAC-signed JSON payload upon job state transitions.
Public Job Object
| Field | Type | Description |
|---|---|---|
| id | string | Unique public UUID for the job |
| operation | string | The operation that was called |
| status | string | queued | running | succeeded | failed |
| createdAt | string | ISO 8601 UTC timestamp |
| errorCode | string | null | Error identifier if the job failed |
| chargedCredits | number | null | Exact number of credits debited upon completion |