HEheygen
Durable Workflows

Cancel Workflow Run

Changed on

Requests cancellation of a run. Safe to repeat in any state: a 200 reports the settled outcome, canceled now or already finished. A retryable 503 means cancellation could not be confirmed and the run is unchanged.

post/v3/workflow-runs/{run_id}/cancel

Request

  • Base URL
    https://api.heygen.com
  • URL
    https://api.heygen.com/v3/workflow-runs/{run_id}/cancel
  • Auth
    • API key in header x-api-key
    • or HTTP bearer

Path parameters

run_idstring required

Run ID

Response

Successful response

Changes