Sign in
Workflows

Get workflow run status

get/v1/workflows/runs/{workflowRunId}

Path parameters

workflowRunIdstring required

The workflow run id returned when the workflow was started.

Response

Current workflow run state.

workflowRunIdstring required

Opaque workflow run id.

status'pending' | 'running' | 'succeeded' | 'failed' | 'cancelled' required

Lifecycle status shared by every asynchronous job (tool executions, workflow runs, remix actions, project exports, and timeline interchange jobs). pending and running are in-progress; succeeded, failed, and cancelled are terminal.

workflowType'SCRIPT_TO_VIDEO' | 'VOICEOVER_TO_VIDEO' | 'SLIDESHOW_TO_VIDEO' | 'STORYBOARD_TO_VIDEO' | 'PROMPT_TO_VIDEO_CLIP' | 'CREATIVE_BRIEF_TO_VIDEO' required

Workflow type identifier.

progressPercentagenumber required

Completion progress for the current attempt (0-100). Always 100 when status is succeeded.

attemptIndexinteger required

Zero-based index of the current or most recent execution attempt.

projectIdstring required

Id of the project created for this workflow run (e.g. vg_proj_...).

projectUrlstring uri required

Deep link to open this project in the VideoGen web editor. Not required for an API-only integration: store projectId and use the Projects API (export, remix, metadata). Use projectUrl when a person should open the project in the app to review or edit it manually. The project is visible only to members of your team and any project collaborators, the same access model as a project created in the dashboard.

Changes