VideoGen APIGet file
GET/v1/get-fileGet a file that was generated via the VideoGen API. The apiFileSignedUrl is a temporary signed URL, available for a maximum of 24 hours.
Request
Query Params
apiFileId
string
required
Primary ID of API generated file.
Example:
41a2c3a7-5ef7-474b-bb97-7e322474c337
Request samples
Responses
Successfully fetched API file(200)
Failed to fetch video data(400)
Successfully fetched API file
HTTP Code: 200
Content Type : JSONapplication/json
Data Schema
apiFileSignedUrl
string | null
required
The temporary signed URL for accessing the generated API file, available for a maximum of 24 hours. It may be null if not yet available.
loadingState
enum<string>
required
The current loading state of the file generation process.
Allowed values:
UNATTEMPTEDLOADINGFULFILLEDREJECTED
secondsAtLoadingState
integer
required
The number of seconds the file has been in the current loading state.
progressPercentage
number <float>
required
The current progress percentage of the file generation. This is only an estimate and may be inaccurate.
errorDisplayMessage
string | null
required
The displayable error message of the video generation job. Null if the job has not yet been rejected.
Example
{
"apiFileSignedUrl": "89a2d12b5c7d8b2e13e7f58090b8bfc75124a5e7e63274f3f7db19ff6124b85e9f632c09d7a64d8266394f07a1e47f1ce9dbfde237b526c2bda3cb4974e715e39f62f7b2fba4c9e6a2e83c1d843b5486eb3cf68cddb9d950ae6f2e6c1f07d2f8ed8b3b9290b7f3b6e87a2b13a17f94d712f1e08b2919c10b56d25859c5a29b13af2c6b98752d6dbea72885d4875e21d4b9a905c53a821f8cf6373e16fbfa9f15369a7e5c734ff4b90c7f7b82729b3d843d7a1d25494d5aaf37c8bfb439dc0bc23865c17f71b29636f5c638edfca752b3f8c67f44c7d32d14bc9843ab97df425b12bc9a1e21e7d65a3a8e42a3f6d4c7a80cd248fb74d263d8b6f5f1f70b85e5bd95",
"loadingState": "FULFILLED",
"secondsAtLoadingState": 6,
"progressPercentage": 100
}Last modified: a month ago