Skip to content

API (v2)

All v2 endpoints require an Authorization header:

Authorization: Bearer <token-or-api-key>
  • GET /v2/system/status
  • POST /v2/api-keys
  • GET /v2/api-keys
  • DELETE /v2/api-keys/{api_key_id}
  • POST /v2/inputs/{kind} (kind ∈ { data_csv, config_yml, holidays_csv })
  • POST /v2/inputs/demo/{kind}
  • GET /v2/inputs/{input_id}
  • POST /v2/datasets
  • GET /v2/datasets
  • GET /v2/datasets/{dataset_id}
  • DELETE /v2/datasets/{dataset_id}
  • GET /v2/datasets/{dataset_id}/files/{file_kind}
  • POST /v2/runs
  • GET /v2/runs
  • GET /v2/runs/{run_id}
  • POST /v2/runs/{run_id}/cancel
  • DELETE /v2/runs/{run_id}
  • GET /v2/runs/{run_id}/artifacts
  • GET /v2/runs/{run_id}/artifacts/{artifact_path:path}
  • GET /v2/runs/{run_id}/logs/tail
  • GET /v2/runs/{run_id}/budget-summary
  • POST /v2/optimisations
  • GET /v2/optimisations
  • GET /v2/optimisations/{optimisation_id}
  • POST /v2/optimisations/{optimisation_id}/cancel
  • DELETE /v2/optimisations/{optimisation_id}
  • GET /v2/optimisations/{optimisation_id}/artifacts
  • GET /v2/optimisations/{optimisation_id}/logs/tail
  • POST /v2/agent/chat

TODO: Add examples and payload schemas (or link to an OpenAPI export) once stabilized.