Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.usesynth.ai/llms.txt

Use this file to discover all available pages before exploring further.

This page is the entry point for public Synth API contracts.

Canonical specs

Public infrastructure coverage

synth-api-v1.yaml covers the backend API families used by the public synth-ai SDK surface:
  • /v1/containers/*
  • /v1/tunnels/*
  • /v1/pools/*
  • /v1/rollouts/*
container-contract-v1.yaml covers container runtime endpoints such as health, rollout, info, and candidate validation contracts.

Generate a client

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
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