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:https://sandbox.api.syrto.ai/openapi.json.
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.
Schema language
Addlanguage=it to get the schema with every summary and description in Italian. The default, and language=en, is English. Structure, field names, enums and examples are identical in both languages, so a client generated from either one is the same.
language works on both /openapi.json and /openapi.yaml, and on the sandbox. Any other value is a 422 invalid_params. It is separate from the language parameter of the data endpoints, which localizes metric names and labels in responses.
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: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/{id}/financials. - A breaking change ships as a new endpoint with a
-vNsuffix (for example/companies/{id}/financials-v2). The original keeps working and is markeddeprecatedin the schema. - There is no global
/v1prefix - each endpoint evolves independently, and each version is a distinct operation with its own schema.