ErrorEnvelope

The envelope returned by every non-2xx response, including `429` and the `/api/*` 404 catch-all.

Type: ErrorEnvelope

ErrorEnvelope has 1 top-level field; error is always present. Fields typed as another schema link to that schema's page, and nested objects expand in place below. It is referenced by 42 operations, listed under Used by. The machine-readable definition is #/components/schemas/ErrorEnvelope in openapi.json; the example in the right-hand rail is synthesized from the field examples in that spec.

Fields

error object required
- code string required Stable machine-readable error code. Branch on this, never on `message`.
- message string required
- details array of object Field-level detail when available; otherwise an empty array.
  
  field string
  
  message string
- request_id string required
- doc_url string (uri) Link to the reference page for this error code

Used by

GET /workflows List workflows
POST /workflows Create a workflow
POST /workflows/generate Generate a workflow from a prompt
GET /workflows/{id} Show a workflow
PATCH /workflows/{id} Update a workflow
DELETE /workflows/{id} Delete a workflow
GET /workflows/{id}/test_cases List sandbox test cases for a workflow
POST /workflows/{id}/trigger Trigger a workflow
GET /workflow_templates List published templates
GET /workflow_templates/{id} Show a template (with definition)
GET /executions List executions
GET /executions/{id} Show an execution
POST /executions/{id}/cancel Cancel an execution
POST /executions/{id}/re_evaluations Re-evaluate an execution
POST /executions/{id}/review_decisions Approve or deny a paused review
GET /executions/{id}/review_events List review audit events
POST /executions/{id}/review_assignment Claim or unassign a review
POST /executions/{id}/review_notes Append a review note
POST /executions/review_bulk_actions Bulk approve / deny / assign_to_me
GET /executions/{id}/report_artifacts List credit-report PDFs for an execution
GET /executions/{id}/report_artifacts/{artifact_id} Download a credit-report PDF
GET /executions/{id}/notice_artifacts List adverse-action notice PDFs for an execution
GET /executions/{id}/notice_artifacts/{artifact_id} Download an adverse-action notice PDF
POST /workflows/{id}/batches Create a batch from N rows
GET /batches List batches
GET /batches/{id} Show a batch
GET /batches/{id}/executions List child executions of a batch
POST /batches/{id}/cancel Cancel a batch
POST /batches/{id}/resume Resume an interrupted batch
POST /batches/{id}/retry_failed Retry failed and skipped rows
GET /batches/{id}/exports.csv Download flat results CSV
GET /batches/{id}/exports.zip Download structured ZIP of batch results
GET /batches/{id}/adverse_action_notices.zip Download all adverse-action notice PDFs as a ZIP
GET /webhook_subscriptions List webhook subscriptions
POST /webhook_subscriptions Create a webhook subscription
GET /webhook_subscriptions/{id} Show a webhook subscription
PATCH /webhook_subscriptions/{id} Update a webhook subscription
DELETE /webhook_subscriptions/{id} Delete a webhook subscription
POST /webhook_subscriptions/{id}/rotate_secret Rotate the signing secret
GET /webhook_deliveries List webhook deliveries
GET /webhook_deliveries/{id} Show a webhook delivery
POST /webhook_deliveries/{id}/retry Manually retry a failed or dead delivery