Workflows

Submit review for a paused workflow run

Approve or reject a workflow run that is paused at a review step.

post/api/v1/workflows/runs/{id}/review

Request

  • Base URL: https://api.korala.ai
  • URL: https://api.korala.ai/api/v1/workflows/runs/{id}/review
  • Auth: one of:
    • API key in header X-API-Key
    • bearer (a scheme the document does not define)

Path parameters

idstring required

Headers

X-Korala-Mode'live' | 'test'

Dashboard JWT: live (default) or test. API keys are pinned to their credential mode. Mode cannot be changed after creation.

Request body

action'approve' | 'reject' required

Whether to approve or reject the review

stepRunIdstring uuid

Exact paused step being reviewed. Supply it for safe retries; required after any earlier review has been decided on this run.

editedDataobject

Edited field values (only for approve)

reasonstring

Reason for rejection (only for reject)

Response

sandboxboolean required

Persisted execution mode: true for test data

idstring required
workflowDefinitionIdstring required
organizationIdstring nullable
status'pending' | 'running' | 'paused' | 'completed' | 'failed' required
inputDataobject nullable
outputDataobject nullable
currentStepnumber required
errorMessagestring nullable
inputFileUrlstring nullable
inputFileMimeTypestring nullable
startedAtstring date-time nullable
completedAtstring date-time nullable
createdAtstring date-time required

Changes

No recorded changes to this operation across all 1 revision of this API.