API + MCP reference

REST API · v1

The full REST API reference for https://api.terminal.house/v1. Every endpoint, request schema, response schema, and error code is auto-rendered from the live FastAPI OpenAPI spec, so this page is never out of date with the running API.

Authentication required for non-public endpoints. Every endpoint except /v1/health and /v1/public/contact requires a bearer API key. See Authentication for key issue + rotation, and Rate limits & quotas for per-tier caps.

All endpoints

Use the search box (⌘K) below or the in-component sidebar to jump to a specific endpoint. Each entry shows the request schema, response schema, every error response, and copy-paste code samples in curl + Python + a handful of other languages.

OpenAPI spec

The raw OpenAPI 3.1 spec is served alongside this page. Useful for client-SDK generation, automated contract testing, or piping into your own tooling.

GET /api-reference/openapi.json — raw JSON spec
GET /api-reference/ — standalone Redocly bundle (single-file HTML; useful for offline reference)

The spec is regenerated from the FastAPI app in CI on every push that touches the API source. We don't hand-maintain endpoint reference content — enrich the FastAPI route docstrings + Pydantic schemas, and the docs site picks up the change on the next deploy.