Submit an evaluation
POST/evaluate
Enqueue an asynchronous governance evaluation for one or more scenarios.
Returns immediately with an evaluation_id and a single-use result_token.
Batches are capped at 1–10 scenarios per call. For larger batches, split across calls.
Where scenario_ids come from: these are Make.com scenario IDs that have
already been imported into your FlowBeacon organization (via the Make Custom
App or the console). The public API has no "list scenarios" endpoint — discover
and import scenarios from Make first, then reference their IDs here. To evaluate a
blueprint that is not yet stored, use POST /evaluate/inline or the blueprints
field instead.
Unknown IDs fail fast: if any scenario_id does not resolve to a stored
scenario in your organization, the whole request is rejected with 404 and the
unknown IDs are listed in the error — nothing is evaluated. This prevents a typo'd
ID from silently returning a perfect score and a false "pass" in CI/CD gates.
Request
Responses
- 200
- 400
- 401
- 403
- 404
- 413
- 422
- 429
- 500
- 503
Evaluation accepted.
Malformed request.
Missing or invalid Authorization header or API key.
Auth succeeded but the action is not permitted.
One or more scenario_ids do not exist in this organization. No evaluation is run.
Reduce payload size below 10 MB.
Request body failed schema validation (missing/!wrong-typed fields).
Returned in the standard public envelope; the field-level errors are
preserved under detail (FastAPI's validation error list).
Rate limit exceeded. Honor Retry-After. Defaults: 60 RPM / 1000 RPH per key.
Response Headers
Seconds to wait before retrying.
Internal server error.
Public API is disabled by an emergency kill-switch.