VIvideogen
Files

Get file import

Changed on

Returns the current status of a file import started via POST /v1/files/import-url, and, once status is succeeded, the imported file. Poll this endpoint until status is succeeded, failed, or cancelled.

get/v1/files/imports/{fileImportId}

Request

  • Base URL
    https://api.videogen.io
  • Auth
    HTTP bearer

Path parameters

fileImportIdstring required

The file import id (e.g. vg_fimp_...) returned by POST /v1/files/import-url.

Response

File import status.

fileImportIdstring required

Opaque file import id (e.g. vg_fimp_...) matching the original request.

status'pending' | 'running' | 'succeeded' | 'failed' | 'cancelled' required

Base lifecycle status for asynchronous jobs. pending and running are in-progress; succeeded, failed, and cancelled are terminal. Workflows and tools additionally support awaiting_approval through their specific status schemas.

progressPercentagenumber required

Completion progress for the current attempt (0-100). Always 100 when status is succeeded.

attemptIndexinteger required

Zero-based index of the current or most recent import attempt.

fileIdstring nullable required

Id of the imported video file (e.g. vg_file_...). Always present as a field; null until status is succeeded.

Changes