GET
/
projects
/
{project_id}
/
inference
/
{inference_id}
/
video_status
curl --request GET \
  --url https://api.gan.ai/projects/{project_id}/inference/{inference_id}/video_status \
  --header 'Authorization: Bearer <token>'
{
  "gen_status": "PENDING",
  "video_url": "<string>",
  "permalink": "<string>",
  "thumbnail_url": "<string>",
  "smart_url": "<string>",
  "error": {}
}

Authorizations

Authorization
string
headerrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

inference_id
string
required

The inference_id of the video for fetching its video status.

project_id
string
required

The project_id of the video for fetching its video status.

Response

200 - application/json
gen_status
enum<string>
required

This indicates the current generation status of the particular video.

Available options:
PENDING,
PROCESSING,
SUCCEEDED,
FAILED,
LIPSYNC_PENDING,
WEBSITE_SCROLLING_PENDING,
DELETED,
BLOCKED,
UNKNOWN,
REGENERATE_REQUIRED,
WEBHOOK_TRIGGERED,
NEXRENDER_PENDING,
FFMPEG_PENDING,
INFERENCE_POST_PROCESSING
video_url
string
required

S3 url for the video file.

permalink
string
required

Permalinks are links to the generated videos that do not expire.

thumbnail_url
string
required

Cloudfront link to personalized thumbnail (if enabled) else default project thumbnail.

smart_url
string
required

These are the links to videos hosted on our landing page.

error
object
required

It corresponds to the error in video generation(if any). Otherwise this field in response body has a value null.