GAN studio

This endpoint returns a list of all projects of the user.

Get Projects

Available Credits

Created At

Data Plane Id

Language

Project Id

This refers to the Project type, eg. PERSONALIZED, NON_PERSONALIZED, etc.

Recording Script

These are the links to videos on our landing page.

Smart Url

Srt Target Language

Status

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

Thumbnail

The title of the project is also returned in the response body.

Title

Training Job Id

Updated At

User Id

Utilised Credits

Video

S3 link to the voice path of the project video.

Voice Path

ProjectResponsePartial

The tags associated with the particular video.

Colors

The tag names for the videos. These can be used while creating videos by passing the tags and there respective values in the payload.

Names

ProjectTags

ProjectType

Custom Thumbnail

Thumbnail Gif

Thumbnail Play Gif

Thumbnail Play Png

Thumbnail Png

Thumbnails

JWT & bearerAuth

GetProjectsResponseV2

UnauthorizedException

EntityNotFoundException

RateLimitException

This endpoint can be used for login. The response contains an access token and a refresh token which need to be used in the Authorization header in the future API calls.

Login

This endpoint can be used to provide access tokens with a desired expiration time. 
 <strong>Please save the token as it will be displayed only once.</strong>

Create Dynamic Tokens

This endpoint can be used to revoke the access from a token that had previously been generated.

Revoke Access Token

List User's Dynamic Tokens

Using this endpoint you can create the videos in bulk, by passing the tags and their values in request body as payload. 
 
 This endpoint returns a list of URLs along with inference_id and the unique_id that was part of the payload. Videos can be downloaded from these URLs. The video generation process is asynchronous and hence the user needs to wait for a period of time before the links become functional. The pause time, depends on the number of videos to be generated. 
We can get status of videos by two ways: 
1) Setting Webhook 
2) Pinging our video_status api with the inference_id (from the response of create_video api)

Create Videos

This endpoint can be used to fetch the status of a video by passing the `project_id` and the `inference_id` in query parameters.

Get video_status

This endpoint sets up a webhook for getting the status of the videos. 
 
 Videos are created in batches. We will do a POST request to the webhook that you would provide us.
 The payload is shown below.
 ``` 
{
	'abc123': {
			'video_url':'<Video_S3_URL>',
			'status':True,
			'inference_id': 'Inference_Id'
	},
	'avs3456': {
			'status': False,
			'inference_id':'3eeb8a96-94fa-4c1b-b827-20dc6a2a0c3c',
			'error': {
				'status_code': 503,
				'message': 'Failed to generate video for inference id:3eeb8a96-94fa-4c1b-b827-20dc6a2a0c3c. Please try again later!'
			}
	}
}
``` 
In the above example, video was successfully generated for unique_id `'abc123'` and is ready for download. Video could not be generated for unique_id `'avs3456'`. We will return error details

User

Create Video

Inference

Project

Authorizations

Response