API reference
The HTTP APIs of venom serve, the orchestrator and Venom Cloud, generated from their contracts.
Reference pages generated from the contracts at build time. When an operation is added to a contract, its page follows on the next build, and the build fails if any operation is missing from its page.
| API | What it covers | Source |
|---|---|---|
| Harness server API | Every operation of venom serve's HTTP API (66 operations), with parameters, bodies, responses, schemas and a curl line each. | packages/harness-server/openapi.yaml |
| Orchestrator API | The Go orchestrator's OpenAI-compatible and admin HTTP API (78 endpoints): routes, headers, bodies and errors. | docs/architecture.md, services/go-orchestrator |
| Venom Cloud API | Every public /v1 route of Venom Cloud (115 operations): what it does, its client-key auth and a curl line. | services/nodejs-cloud/app/v1, services/nodejs-cloud/contracts, docs/cloud-mesh.md |
In this section
- Harness server API: Every operation of venom serve's HTTP API (66 operations), with parameters, bodies, responses, schemas and a curl line each.
- Orchestrator API: The Go orchestrator's OpenAI-compatible and admin HTTP API (78 endpoints): routes, headers, bodies and errors.
- Venom Cloud API: Every public /v1 route of Venom Cloud (115 operations): what it does, its client-key auth and a curl line.