Skip to content

OpenAPI specification

The REST API is documented in Memories. For codegen, contract tests, and API clients, use the OpenAPI 3 document generated from Laravel routes via Scribe.

Download

Download OpenAPI YAML

The file is regenerated on each docs build:

bash
php artisan openbrain:docs-api

Output path: developer-docs/public/openapi.yaml (copied into the static site on build).

Regenerate locally

bash
vendor/bin/sail npm run docs:build

Or only the spec:

bash
vendor/bin/sail artisan openbrain:docs-api

Scope

The spec covers authenticated memory routes under /api. Health routes and MCP are documented separately (Health, MCP setup).