Skip to navigation
REST API ReferenceEndpointsTools

Get tool execution info

Retrieve the current status and result of a tool execution. Poll this endpoint until status is succeeded, failed, or cancelled. Each succeeded result carries signed downloadUrl/thumbnailUrl (with matching *ExpiresAt timestamps) alongside the full hydrated file. The signed URLs are private and valid for 7 days; this single-execution endpoint automatically re-signs them when they are within an hour of expiring, so a caller always receives a URL valid long enough to use. Results remain retrievable indefinitely, including executions older than 7 days. Note that list endpoints (e.g. GET /v1/tools/executions) do not re-sign URLs: they return the last-signed URL, which may already be expired (check downloadUrlExpiresAt). To refresh a URL, GET the individual execution here, or hydrate the file directly via GET /v1/files/{fileId} / POST /v1/files/{fileId}/hydrate.

Authentication

AuthorizationBearer

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

Path parameters

toolExecutionIdstringRequired
The tool execution id returned when the tool was started.

Response

Current execution state
toolExecutionIdstring
Execution id matching the original request.
statusenum or any

Tool execution status. awaiting_approval means generation completed but applying its retained result would overwrite newer project edits. Review it in the project’s Tasks drawer. Stop polling and return control to the caller; this is not success or failure. Standalone asset generation does not require approval.

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 retained generated file (each with signed URLs and a hydrated file) when status is succeeded or awaiting_approval. Always present; empty while generation is pending. Asset availability does not mean it has been applied to the project.

errorobject or null

Error details. Always present; null unless status is failed.