VideoGen API

Delivered when a workflow run completes successfully.

The payload of this webhook request is an object.

eventenumRequired

Lifecycle events emitted for workflow runs started via the developer API.

workflowRunIdstringRequired

Opaque workflow run id matching the original request.

occurredAtdatetimeRequired

ISO-8601 timestamp at which VideoGen observed the terminal state.

workflowTypeenumRequired

Workflow type identifier.

projectIdstringRequired

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

projectUrlstringRequiredformat: "uri"

URL to view the project in the VideoGen app.

errorobjectOptional

Present only on workflow_run.failed.

200

Acknowledge receipt

1	{
2	"event": "workflow_run.succeeded",
3	"workflowRunId": "string",
4	"occurredAt": "2024-01-15T09:30:00Z",
5	"workflowType": "SCRIPT_TO_VIDEO",
6	"projectId": "string",
7	"projectUrl": "string"
8	}