Sign in to run requests with your own sandbox key. Sign in

Re-evaluate an execution

POST /api/v1/executions/{id}/re_evaluations
executions:write Idempotent Async

Creates a new execution that re-runs the source's input_context against the source's snapshotted definition (NOT the workflow's current definition) and returns 202; poll getExecution on the new id. The source must belong to an active workflow, and re-running a live-mode execution requires production access.

Idempotency-Key is required and is namespaced per source execution, so the same key can be reused across different sources. Requires executions:write.

Asynchronous: the response is 202 Accepted. Poll GET /executions/{id} until status is terminal.

Path parameters

NameTypeDescription
idrequired integer

Execution id. Scoped to the calling api_client; a foreign id returns 404.

Header parameters

NameTypeDescription
Idempotency-Keyrequired string

Unique per-business-event key. Identical resubmissions return the original response; conflicting bodies return 409 idempotency_conflict. Concurrent identical requests are race-safe. A missing or blank header returns 422 missing_idempotency_key.

The header is accepted up to 200 characters, but the stored key is namespaced to your client (api_client:<id>:<key>, and for re-evaluations api_client:<id>:reeval:<execution_id>:<key>) and the stored value is capped at 200 characters — so the effective limit on trigger is about 185 characters and lower still on re_evaluations. Use a UUID (36 characters) or another key of at most 128 characters to stay clear of the cap.

Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6

Responses

  • 202 Re-evaluation accepted (the NEW execution) application/json
    • data Execution

      Schema: ExecutionDetail

      • id integer required
      • object string required
      • workflow_id integer required
      • status string required Lifecycle of an execution. `queued` (batch rows not yet dispatched), `pending`, `running` and `waiting` (paused on a Wait node or adverse-action waiting period) are in flight; `awaiting_review` is paused on human review; `completed`, `failed`, `cancelled` and `skipped` are terminal. One of queued pending running waiting awaiting_review completed failed cancelled skipped
      • execution_key string, nullable
      • external_reference string, nullable
      • needs_human_review boolean required
      • review_status string required One of none in_review approved denied
      • assigned_to_user_id integer, nullable The reviewer who claimed this execution, if any.
      • started_at string (date-time), nullable
      • completed_at string (date-time), nullable
      • created_at string (date-time) required
      • updated_at string (date-time), nullable
      • input_context object The payload originally sent at trigger time, plus resolved fields such as `execution_mode`, `submitted_by_user_id`, `user_approved`, `external_reference`, (for a test-mode run of a draft) `allow_inactive` and (for a test-mode run that replays a registered test subject) `sandbox_replay`.
    • meta Meta

      Schema: Meta

      • request_id string required Correlation id for this request. Also sent as the `X-Request-Id` response header; quote it when contacting support.
    202 example
    {
      "data": {
        "id": 1842,
        "object": "execution",
        "workflow_id": 27,
        "status": "queued",
        "execution_key": "api_client:12:3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "external_reference": "rv-app-20491",
        "needs_human_review": true,
        "review_status": "none",
        "assigned_to_user_id": 1,
        "started_at": "2026-05-08T18:41:05Z",
        "completed_at": "2026-05-08T18:41:05Z",
        "created_at": "2026-05-08T18:41:05Z",
        "updated_at": "2026-05-08T18:41:05Z",
        "input_context": {}
      },
      "meta": {
        "request_id": "7d4c2f48-9a1b-4c3d-8e2f-1a2b3c4d5e6f"
      }
    }
  • 401 Missing, malformed, expired or revoked bearer token. The WWW-Authenticate header carries the RFC 6750 challenge. application/json

    Schema: ErrorEnvelope

    401 example
    {
      "error": {
        "code": "unauthorized",
        "message": "A valid bearer token is required.",
        "details": [],
        "request_id": "7d4c2f48-9a1b-4c3d-8e2f-1a2b3c4d5e6f",
        "doc_url": "https://cascades.crscreditapi.com/docs/api/errors/unauthorized"
      }
    }
  • 403 insufficient_scope or live_mode_forbidden application/json

    Schema: ErrorEnvelope

    403 example
    {
      "error": {
        "code": "live_mode_forbidden",
        "message": "Re-running a live-mode execution requires production access.",
        "details": [],
        "request_id": "7d4c2f48-9a1b-4c3d-8e2f-1a2b3c4d5e6f",
        "doc_url": "https://cascades.crscreditapi.com/docs/api/errors/live_mode_forbidden"
      }
    }
  • 404 Resource does not exist or belongs to another tenant / api_client application/json

    Schema: ErrorEnvelope

    404 example
    {
      "error": {
        "code": "not_found",
        "message": "The requested resource was not found.",
        "details": [],
        "request_id": "7d4c2f48-9a1b-4c3d-8e2f-1a2b3c4d5e6f",
        "doc_url": "https://cascades.crscreditapi.com/docs/api/errors/not_found"
      }
    }
  • 409 workflow_inactive application/json

    Schema: ErrorEnvelope

    409 example
    {
      "error": {
        "code": "workflow_inactive",
        "message": "Only active workflows can be re-evaluated through the public API.",
        "details": [],
        "request_id": "7d4c2f48-9a1b-4c3d-8e2f-1a2b3c4d5e6f",
        "doc_url": "https://cascades.crscreditapi.com/docs/api/errors/workflow_inactive"
      }
    }
  • 422 missing_idempotency_key application/json

    Schema: ErrorEnvelope

    422 example
    {
      "error": {
        "code": "missing_idempotency_key",
        "message": "Idempotency-Key header is required.",
        "details": [],
        "request_id": "7d4c2f48-9a1b-4c3d-8e2f-1a2b3c4d5e6f",
        "doc_url": "https://cascades.crscreditapi.com/docs/api/errors/missing_idempotency_key"
      }
    }
  • 429 Rate limit exceeded (60 req/min per IP on /api/v1, 600 req/hour per token prefix, or 300 req/5 min per IP globally). The body is the standard error envelope and Retry-After gives the seconds until the window resets. application/json

    Schema: ErrorEnvelope

    429 example
    {
      "error": {
        "code": "rate_limited",
        "message": "Rate limit exceeded. Retry later.",
        "details": [],
        "request_id": "7d4c2f48-9a1b-4c3d-8e2f-1a2b3c4d5e6f",
        "doc_url": "https://cascades.crscreditapi.com/docs/api/errors/rate_limited"
      }
    }
Was this page helpful?