Skip to content

GET /api/v1/runs/preflight

Status: GA Access: token required API contract: 0.3.0 · capability 2026-09-03.1 View as Markdown Open in Claude Open in ChatGPT

Run Preflight

Can this run launch? Returns can_launch + blocking reasons WITHOUT creating a run, so a caller can check quota, pool and pipeline state before spending a launch.

Auth: Authorization: Bearer <token> required

Terminal window
curl -sS -X GET "https://entherium.duckdns.org:8443/api/v1/runs/preflight" \
-H "Authorization: Bearer <token>"

The contract carries no example for this response; schema: object. Field-level shape: interactive explorer.

object — Successful Response

ParameterInRequiredTypeDefaultConstraintsDescription
pipeline_idqueryyesstring——
guidqueryyesinteger——
entityquerynostring | null——
CodeMeaningBody
401Missing or invalid authentication credentialsErrorResponse
422Validation ErrorHTTPValidationError

Every error body is {detail, code?, request_id, doc_url} — request_id is the value to quote, doc_url points at the Errors reference.