OpenAPI Specification
The BytePhase integration API is described by an OpenAPI 3.1 document. It is the contract of record: the API reference is rendered from it, and every field, status code and error in the guides is checked against it.
Download
Section titled “Download”| Bundled JSON | /openapi/v1.json |
| Source | The openapi/ directory of the public repository (see the link in the site header) |
The bundled file is self-contained and can be imported into any tool that reads OpenAPI 3.1: Postman, Insomnia, Bruno, an SDK generator, or a mock server.
curl -O https://developers.bytephase.com/openapi/v1.jsonEnvironments in the spec
Section titled “Environments in the spec”The document declares the four base URLs as servers with a {workspace} (or {custom_domain}) variable, so tools that understand server variables can be pointed at your workspace by filling in one value. See Environments.
Run a mock server
Section titled “Run a mock server”To develop against the shapes without touching a real workspace, run a mock from the spec. With Prism:
npx @stoplight/prism-cli mock https://developers.bytephase.com/openapi/v1.jsonA mock returns example responses; it does not validate keys, apply duplicate rules or enforce rate limits. Test the real behaviour against a trial workspace before you go live.
Versioning
Section titled “Versioning”The document’s info.version tracks the documented API version. Additions (new endpoints, new optional fields, new error codes) are non-breaking and appear in the changelog. Removals and changes of meaning are announced with a deprecation period first.
Found a mistake?
Section titled “Found a mistake?”If the spec and the API disagree, the API is wrong or the spec is wrong and either way we want to know. Open an issue in the repository or contact support with the endpoint and the request id.