Reference

HTTP contract for the Synapse API. The per-endpoint pages under HTTP API are generated from src/pipeline/openapi/openapi.yaml at build time.

Handwritten pages in this section cover behavior the spec does not fully document:

• Authentication — OIDC Bearer and X-API-Key
• Response envelopes — { "data": ... } vs unwrapped bodies
• Worker protocol — internal; console only uses stats
• Environment variables

Base URL: the API you expose (set VITE_API_BASE_URL on the console to the same origin).

There is no runtime Swagger UI on the API process. Try-it-out is disabled on this docs site so the docs origin does not need CORS.