Skip to main content
Because the Syrto API is configured per client, your OpenAPI schema is the authoritative reference for your API - it lists exactly the endpoints, parameters, and response shapes provisioned for your organization. It is generated per API key and scoped to what that key can call, so it is the fastest way to see what your API actually exposes.
Want to see what a schema looks like first? Browse the interactive reference for the example endpoints - it renders the same way your own schema will.

​
Preview your schema

Your schema is served as OpenAPI 3.1, in JSON or YAML. Both endpoints require your API key and are never billed. Create a key in the Syrto dashboard (admins only), then fetch and save it:
Then open the saved file in any OpenAPI viewer to browse it interactively. A good open-source choice is the Swagger Editor, which renders the file in your browser - the schema describes your API but never contains your key. Other options: Scalar (npx @scalar/cli), Postman, or an OpenAPI IDE plugin.
There is no browse-in-the-page schema viewer, by design: the schema is gated by your secret API key. Fetch it with your key and render it in a tool you control, rather than pasting the key into a web page.

​
Generate a client

The schema is a language-agnostic contract, so you can generate a typed client from the saved file with any OpenAPI generator:
Every operation carries a stable operationId (the endpoint slug), so generated method names stay clean, and the error code is a typed enum covering the full error taxonomy - a generated client sees exact codes, not a bare string.

​
Versioning

Versioning is per-resource and appears in the resource name, only when a change would break existing callers:
  • The first version of an endpoint uses the clean resource name - for example /companies/{taxId}/financials.
  • A breaking change ships as a new endpoint with a -vN suffix (for example /companies/{taxId}/financials-v2). The original keeps working and is marked deprecated in the schema.
  • There is no global /v1 prefix - each endpoint evolves independently, and each version is a distinct operation with its own schema.
This means an existing integration never breaks silently: a new major version is a new URL you opt into, and the old one keeps serving until you migrate.