API Reference

API access

Where the spec lives

The interactive reference (Swagger UI) is served at /api-docs, and the machine-readable OpenAPI 3.0 spec at /api/openapi.json. Every endpoint in the spec is real and reachable.

Resources

  • Auth — session status, login/logout, registration, password reset.
  • Datasets — upload, list and manage datasets.
  • Jobs — create and poll runs (data synthesis, evaluation, prediction, optimization, TEA).
  • Pipeline — end-to-end pipeline runs.
  • Projects, Reports, Conversations, API Keys, Webhooks, Billing, Admin.

Authentication

Two schemes: session cookies (what the web app uses) and Bearer API keys issued from Settings → API Keys. Key management is fully implemented; endpoint-by-endpoint key coverage is being rolled out — the API reference marks which endpoints accept keys.

Rate limits

Programmatic requests are rate-limited against your tier the same way the web app is — see Tiers and quotas.

Go from reading to running

The quickstart tutorial walks the first synthesis, evaluation and prediction on a demo dataset — each step matches a real platform page.