Get workflow run status

AuthorizationBearer

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

API key from [app.videogen.io/developers](https://app.videogen.io/developers). The full key is only shown once when you create it.

workflowRunIdstringRequired

The workflow run id returned when the workflow was started.

Current workflow run state.

workflowRunIdstring

Opaque workflow run id.

statusenum

Lifecycle status of a workflow run.

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.

projectUrlstringformat: "uri"

URL to view the project in the VideoGen app.

errorobject or null

1	import { VideoGenClient } from "@videogen/sdk";
2
3	const client = new VideoGenClient({ token: "YOUR_TOKEN" });
4	await client.workflows.getWorkflowRun({
5	workflowRunId: "workflowRunId"
6	});

1	{
2	"workflowRunId": "string",
3	"status": "pending",
4	"workflowType": "ADD_VISUALS_NARRATIONS_AND_CAPTIONS_TO_SCRIPT",
5	"progressPercentage": 1.1,
6	"attemptIndex": 1,
7	"projectId": "string",
8	"projectUrl": "string",
9	"error": {
10	"message": "string",
11	"code": "string",
12	"requirement": {
13	"type": "string",
14	"details": {}
15	},
16	"internalErrorCode": "string"
17	}
18	}