Changelog
Improved

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.

API

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 /jobs lists a typed variant for each live job type, such as SubmitFfprobeJob with FfprobeParams. A generic variant still takes any type, including one newer than your client. compose stays generic, and GET /jobs/types/compose/schema serves its full schema.
  • Named types. Every error response points at one ErrorResponse, and a job is a Job with one variant per status, from JobWaiting to JobComplete.
  • Accurate shapes. The POST /jobs responses show the { data } envelope the API returns, paging parameters are integers, and GET /jobs/{id}/download declares a binary body.
  • Deprecation header. Endpoints listed as deprecated answer with an RFC 9745 Deprecation header 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.

Share