Get workflow run status

Authentication

AuthorizationBearer

API key from app.videogen.io/api. The full key is only shown once when you create it.

Path parameters

workflowRunIdstringRequired

The workflow run id returned when the workflow was started.

Response

Current workflow run state.

workflowRunIdstring

Opaque workflow run id.

statusenum or any

Workflow run status. awaiting_approval means a retained result needs explicit approval because project content changed. Stop polling and return control to the caller. Approval reuses the result; success is reported only after the requested application and any requested export complete.

workflowTypeenum

Workflow type identifier.

progressPercentagedouble0-100

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

attemptIndexinteger>=0

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

projectIdstring

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

projectUrlstringformat: "uri"

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.

errorobject or null

Error details. Always present as a field; null unless status is failed.

exportIdstring or null

Opaque export id (e.g. vg_expo_...) when this run was started with autoExport: true and the export succeeded. Always present as a field; null otherwise.

downloadUrlstring or nullformat: "uri"

Private signed MP4 download URL when autoExport succeeded. Always present as a field; null otherwise. Valid for 7 days from when it was signed. This endpoint re-signs the URL when it is within an hour of expiring.

downloadUrlExpiresAtinteger or null

Seconds since epoch (Unix timestamp) when downloadUrl expires. null while downloadUrl is null.

thumbnailUrlstring or nullformat: "uri"

Private signed thumbnail URL when autoExport succeeded. Always present as a field; null otherwise (and when no thumbnail is available). Re-signed automatically on the same terms as downloadUrl.

thumbnailUrlExpiresAtinteger or null

Seconds since epoch (Unix timestamp) when thumbnailUrl expires. null while thumbnailUrl is null.

exportFileIdstring or null

File id (e.g. vg_file_...) of the rendered MP4 when autoExport succeeded. Always present as a field; null otherwise. Pass it to POST /v1/files/{fileId}/hydrate for a fresh signed URL.