Typed job params in the OpenAPI spec
Generate a client in your language from GET /openapi.json and get typed params for every live job type, one shared ErrorResponse, a Job type per status, and a Deprecation header on endpoints that are going away.
GET /openapi.json now describes the API the way a client generator needs it. Point openapi-python-client, Fern or any other OpenAPI 3.1 generator at it and you get a client with named, typed models instead of anonymous shapes.
- Typed job params.
POST /jobslists a typed variant for each live job type, such asSubmitFfprobeJobwithFfprobeParams. A generic variant still takes any type, including one newer than your client.composestays generic, andGET /jobs/types/compose/schemaserves its full schema. - Named types. Every error response points at one
ErrorResponse, and a job is aJobwith one variant per status, fromJobWaitingtoJobComplete. - Accurate shapes. The
POST /jobsresponses show the{ data }envelope the API returns, paging parameters are integers, andGET /jobs/{id}/downloaddeclares a binary body. Deprecationheader. Endpoints listed as deprecated answer with an RFC 9745Deprecationheader carrying the day they were deprecated, so your logs flag them before anything is removed.
Requests and responses on the wire are unchanged. The error codes are the same ones ErrorResponse carries, and the TypeScript SDK page covers the client we ship.