HEheygen
Workflows

Create a workflow execution

Changed on

Submit a single workflow for asynchronous execution. Returns an execution_id that can be polled via GET /v1/workflows/executions/{execution_id}.

post/v1/workflows/executions

Request

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

Request body

workflow_typestring required

The workflow type to execute (e.g., 'GenerateImageNode', 'GenerateVideoNode')

inputobject required

Workflow-specific input matching the workflow's input schema

Response

Successful response

Example response

{
  "data": {
    "execution_id": "exec_abc123def456",
    "status": "submitted"
  }
}

Changes