API Reference
API Reference Index
Complete index of HTTP resources, methods, endpoints, and headers in the /v1 API contract.
The Transpera API adheres to RESTful conventions. Request payloads and responses are JSON encoded. All v1 routes require an Authorization: Bearer token.
| Method | Path | Description | Required Scope |
|---|---|---|---|
| POST | /v1/uploads | Generate a signed upload URL for a source document | jobs:write |
| POST | /v1/jobs | Dispatch an operation on a document (requires Idempotency-Key) | jobs:write |
| GET | /v1/jobs | List all jobs created by this API key in descending order | jobs:read |
| GET | /v1/jobs/{id} | Get public status, progress, and charged credits for a job | jobs:read |
| GET | /v1/operations | Catalog of studio operations callable by this key | jobs:read |
| GET | /v1/wallet | Read real-time credit balance of the key owner | wallet:read |