Project

Set Webhook for 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

POST

projects

{project_id}

webhook

curl --request POST \
  --url https://api.gan.ai/projects/{project_id}/webhook \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "enable": true,
  "url": "<string>",
  "Authorization": "Bearer <Insert_the_token_here>"
}'

{
  "enable": true,
  "url": "<string>",
  "Authorization": "Bearer <Insert_the_token_here>",
  "user_identifier": "<string>",
  "user_password": "<string>",
  "message": "<string>",
  "send_query_params": true,
  "send_replacement": true,
  "serialize_payload": true,
  "tags_mapping": {}
}

Authorizations

Authorization

string

header

required

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

Path Parameters

project_id

string

required

The project_id for which the webhook needs to be set.

Body

application/json

This value corresponds to the webhook configured with this particular project.

Response

200

application/json

Successful Response

This value corresponds to the webhook configured with this particular project.

Get video_status Get Projects

curl --request POST \
  --url https://api.gan.ai/projects/{project_id}/webhook \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "enable": true,
  "url": "<string>",
  "Authorization": "Bearer <Insert_the_token_here>"
}'

{
  "enable": true,
  "url": "<string>",
  "Authorization": "Bearer <Insert_the_token_here>",
  "user_identifier": "<string>",
  "user_password": "<string>",
  "message": "<string>",
  "send_query_params": true,
  "send_replacement": true,
  "serialize_payload": true,
  "tags_mapping": {}
}

User

Create Video