HEheygen
Workflows

Get workflow execution status

Changed on

Poll the status and output of a workflow execution.

Single-workflow executions return output in the output field.

Multi-workflow graph executions return all outputs in the outputs field, keyed by workflow ID.

get/v1/workflows/executions/{execution_id}

Request

  • Base URL
    https://api.heygen.com
  • URL
    https://api.heygen.com/v1/workflows/executions/{execution_id}
  • Auth
    • API key in header x-api-key
    • or HTTP bearer

Path parameters

execution_idstring required

Execution ID returned from POST /v1/workflows/executions

Response

Successful response

Example response

{
  "data": {
    "execution_id": "exec_abc123def456",
    "status": "completed",
    "output": {
      "url": "https://files.heygen.ai/output.mp4"
    },
    "outputs": {
      "node_1": {
        "url": "https://files.heygen.ai/output.mp4"
      }
    },
    "error": {
      "code": "workflow_timeout",
      "message": "Workflow execution timed out after 300s"
    }
  }
}

Changes