Skip to content
Braiv Docs

OpenAPI

The machine contract for Public API v1 is OpenAPI 3.1. The endpoint reference is generated from this same file, so its parameters, examples, responses, and errors match the downloadable contract.

Download: openapi.yaml

https://docs.braiv.co/public-api/openapi.yaml

Servers in the file:

https://api.braiv.co/v1

Each operationId has its own reference page (for example createVideo, listVideoJobs, and health). Use those ids for generated clients and MCP tools.

Auth in the spec is Authorization: Bearer or X-Api-Key.

When handlers change, update braiv-firebase/functions/src/public-api/openapi.yaml first, then copy that file to apps/docs/public/public-api/openapi.yaml in this repo so the download stays identical.