Skip to content

Companion API Reference

The full REST API for Companion, served live from GCP Cloud Run.

The interactive reference is generated from the FastAPI OpenAPI schema. The schema is available for client generation and contract testing at openapi.json.

Live API

The backend-hosted Scalar UI is available at /scalar. The embedded reference below uses the same live OpenAPI schema.

Health Check

Verify the backend is running: /api/health

If the reference doesn't load

The embed pulls the OpenAPI schema live from Cloud Run. If the service is cold-starting or unreachable, open the live Scalar UI directly, or check the /api/health endpoint.