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.

MethodPathDescriptionRequired Scope
POST/v1/uploadsGenerate a signed upload URL for a source documentjobs:write
POST/v1/jobsDispatch an operation on a document (requires Idempotency-Key)jobs:write
GET/v1/jobsList all jobs created by this API key in descending orderjobs:read
GET/v1/jobs/{id}Get public status, progress, and charged credits for a jobjobs:read
GET/v1/operationsCatalog of studio operations callable by this keyjobs:read
GET/v1/walletRead real-time credit balance of the key ownerwallet:read