Skip to navigation
REST API ReferenceEndpointsFiles

Get file import

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.

Authentication

AuthorizationBearer

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

Path parameters

fileImportIdstringRequired

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

Response

File import status.
fileImportIdstring

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

statusenum

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.

Allowed values:
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 import attempt.

fileIdstring or null

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

fileobject or null

Imported file metadata. Always present as a field; null until status is succeeded.

errorobject or null

Error details. Always present as a field; null unless status is failed.