Skip to content
Verbitas Docs

OpenAPI Spec

OpenAPI Spec

The Verbitas API is documented with an OpenAPI 3.1 specification.

Swagger UI

Interactive API explorer:

api.verbitas.io/docs

You can authorize with your API key and make test requests directly from the browser.

Raw specification

Download the OpenAPI 3.1 JSON:

Terminal window
curl https://api.verbitas.io/openapi.json -o verbitas-api.json

Or YAML:

Terminal window
curl https://api.verbitas.io/openapi.yaml -o verbitas-api.yaml

ReDoc

Rendered API reference with navigation:

api.verbitas.io/redoc

Generating clients

Python (openapi-generator)

Terminal window
openapi-generator generate \
  -i https://api.verbitas.io/openapi.json \
  -g python \
  -o ./verbitas-client-generated

Note: the official verbitas Python package is preferred over generated clients. Generated clients do not include retry logic, idempotency key management, or typed exception handling.

TypeScript

Terminal window
openapi-generator generate \
  -i https://api.verbitas.io/openapi.json \
  -g typescript-fetch \
  -o ./verbitas-client-ts

Again, prefer the official @verbitas/sdk package.

Breaking change detection

The OpenAPI spec is linted and checked for breaking changes in CI on every PR that touches apps/api. The check uses spectral for linting and a breaking-change detector against the main branch spec.

If you maintain an integration against the raw OpenAPI spec rather than the official SDKs, subscribe to the changelog for breaking change notices.

Versioning

The API is versioned via the URL path (/v1/). All current endpoints are v1. A breaking change to any endpoint will introduce a v2 path. The v1 path will be maintained for at least 12 months after a v2 announcement.

SDK version compatibility

For the SDK version-to-API-version compatibility matrix, see docs/sdk-compatibility.md in the repository: github.com/Original-Pictures/verbitas/blob/main/docs/sdk-compatibility.md