Get tool execution info

GET

https://api.videogen.io/v1/tools/executions/:toolExecutionId

Retrieve the current status and result of a tool execution. Poll this endpoint until status is succeeded, failed, or cancelled.

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.

toolExecutionIdstringRequired

The tool execution id returned when the tool was started.

Current execution state

toolExecutionIdstring

Execution id matching the original request.

statusenum

pending and running are in-progress; succeeded, failed, and cancelled are terminal.

toolTypestring

Tool name (e.g. GENERATE_IMAGE, TEXT_TO_SPEECH).

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.

resultslist of objects

One entry per generated result. Present when status is succeeded.

errorobject or null

1	const url = 'https://api.videogen.io/v1/tools/executions/vg_tool_ccm3abc123defcm3xyz789ghi';
2	const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
3
4	try {
5	const response = await fetch(url, options);
6	const data = await response.json();
7	console.log(data);
8	} catch (error) {
9	console.error(error);
10	}

1	{
2	"toolExecutionId": "vg_tool_ccm3abc123defcm3xyz789ghi",
3	"status": "succeeded",
4	"toolType": "GENERATE_VIDEO_CLIP",
5	"progressPercentage": 100,
6	"attemptIndex": 0,
7	"results": [
8	{
9	"fileId": "vg_file_obLD1OX2eJCrEs0071Z4kA",
10	"type": "VIDEO"
11	}
12	]
13	}