Get tool execution info

import { VideoGen } from "@videogen/sdk";
const client = new VideoGen({ apiKey: "sk_videogen_live_..." });
await client.tools.getToolExecutionInfo({
  toolExecutionId: "vg_tool_ccm3abc123defcm3xyz789ghi",
});

{
  "toolExecutionId": "vg_tool_ccm3abc123defcm3xyz789ghi",
  "status": "succeeded",
  "toolType": "GENERATE_VIDEO_CLIP",
  "progressPercentage": 100,
  "attemptIndex": 0,
  "results": [
    {
      "fileId": "vg_file_obLD1OX2eJCrEs0071Z4kA",
      "type": "VIDEO",
      "downloadUrl": "https://stream.media.videogen.io/example/1080p.mp4?token=abc&download=clip.mp4",
      "downloadUrlExpiresAt": 1748001600,
      "thumbnailUrl": "https://image.media.videogen.io/example/thumbnail.jpg?token=abc",
      "thumbnailUrlExpiresAt": 1748001600,
      "file": {
        "fileId": "vg_file_obLD1OX2eJCrEs0071Z4kA",
        "scope": "GLOBAL",
        "type": "VIDEO",
        "displayName": "Mountain landscape clip",
        "durationSeconds": 6,
        "downloadUrl": "https://stream.media.videogen.io/example/1080p.mp4?token=abc&download=clip.mp4",
        "downloadUrlExpiresAt": 1748001600,
        "thumbnailUrl": "https://image.media.videogen.io/example/thumbnail.jpg?token=abc",
        "thumbnailUrlExpiresAt": 1748001600,
        "thumbnailSource": {
          "status": "ready",
          "url": "https://image.media.videogen.io/example/thumbnail.jpg?token=abc",
          "expiresAt": 1748001600,
          "width": 426,
          "height": 240
        },
        "previewSource": {
          "status": "ready",
          "url": "https://stream.media.videogen.io/example/720p.mp4?token=abc",
          "expiresAt": 1748001600,
          "width": 1280,
          "height": 720
        },
        "downloadSource": {
          "status": "ready",
          "url": "https://stream.media.videogen.io/example/1080p.mp4?token=abc&download=clip.mp4",
          "expiresAt": 1748001600,
          "width": 1920,
          "height": 1080
        },
        "isPublicPreviewEnabled": false
      }
    }
  ],
  "error": null
}

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 24 hours; 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 24 hours. 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.

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 24 hours; 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 24 hours. 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/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.

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

Lifecycle status shared by every asynchronous job (tool executions, workflow runs, remix actions, project exports, and timeline interchange jobs). 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. Always present; empty until status is succeeded, then one entry per generated file (each with signed URLs and a hydrated file).

errorobject or null

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