API Reference

This reference is generated from the OpenAPI specification — the contract of record. It lists every endpoint, field, status code and error the guides refer to.

Try it with your own key. Pick the environment in the server selector, type your workspace subdomain, then open any endpoint and paste your key into the authentication box — Authorization: Bearer or X-API-Key both work. Requests go to your real workspace, so use a trial workspace if you do not want test records in a live one. Keys are never sent anywhere but your workspace.