OpenAPI Spec

Canonical OpenAPI contracts for Synth APIs and container runtimes.

This page is the single entry point for Synth OpenAPI contracts.

Canonical Specs

• Main API contract:
  • openapi/synth-api-v1.yaml
• Container runtime contract:
  • openapi/container-contract-v1.yaml

What Each Spec Covers

• synth-api-v1.yaml
  • policy optimization jobs/sessions
  • inference (including OpenAI-compatible chat completions)
  • graphs and verifiers
  • hosted containers, pools, and SynthTunnel leases
• container-contract-v1.yaml
  • /health, /rollout, /info, and /validate-candidate container endpoints

Use It in Any Language

# TypeScript
npx @openapitools/openapi-generator-cli generate \
  -i https://raw.githubusercontent.com/synth-laboratories/synth-ai/main/openapi/synth-api-v1.yaml \
  -g typescript-fetch \
  -o generated/synth-ts

# Python
openapi-generator-cli generate \
  -i https://raw.githubusercontent.com/synth-laboratories/synth-ai/main/openapi/synth-api-v1.yaml \
  -g python \
  -o generated/synth-py