OpenAPI spec
The Service API publishes a machine-readable OpenAPI 3 description — the same spec that powers the API reference. Use it to generate a typed client/SDK, import the API into Postman or Insomnia, or validate requests and responses in your own tooling.
Download
Section titled “Download”openapi.yaml — the full specification (YAML).
It describes every endpoint, query parameter, response shape, and the
error envelope, with https://api.useservice.app as the server.
The spec always reflects the current API version; breaking changes ship under a
new dated Service-Version.
Common uses
Section titled “Common uses”- Generate an SDK with openapi-generator
or
openapi-typescript, e.g.openapi-generator-cli generate -i https://docs.useservice.app/api/openapi.yaml -g <language>. - Import into Postman / Insomnia to explore the endpoints and try requests with your API key.
- Browse it rendered in the API reference.