Get Projects
This endpoint returns a list of all projects of the user.
curl --request GET \
--url https://api.gan.ai/projects/v2 \
--header 'Authorization: Bearer <token>'
{
"data": [
{
"user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"project_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"title": "<string>",
"project_type": "PERSONALIZED",
"thumbnail": "<string>",
"thumbnails": {
"thumbnail_png": "",
"thumbnail_play_png": "",
"thumbnail_gif": "",
"thumbnail_play_gif": "",
"custom_thumbnail": ""
},
"status": "<string>",
"language": "<string>",
"tags": {
"colors": [
"<string>"
],
"names": [
"<string>"
]
},
"available_credits": 123,
"utilised_credits": 123,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"video": "<string>",
"training_job_id": "<string>",
"srt": "<string>",
"srt_target_language": "<string>",
"voice_path": "<string>",
"smart_url": "<string>",
"recording_script": "<string>",
"data_plane_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
],
"size": 123,
"unpublished_projects": 123
}
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Response
This refers to the user's unique id.
This refers to the project's unique id.
The title of the project is also returned in the response body.
This refers to the Project type, eg. PERSONALIZED, NON_PERSONALIZED, etc.
PERSONALIZED
, PERSONALIZED_INSTANT
, NON_PERSONALIZED
Project creation timestamp
Project Updation timestamp
Cloudfront link to personalized thumbnail (if enabled) else default project thumbnail.
The user's available credits.
The user's utilized credits.
S3 link to the project video.
S3 link to the voice path of the project video.
These are the links to videos on our landing page.
Count of projects made by the user.
Count of unpublished projects of the user.
curl --request GET \
--url https://api.gan.ai/projects/v2 \
--header 'Authorization: Bearer <token>'
{
"data": [
{
"user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"project_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"title": "<string>",
"project_type": "PERSONALIZED",
"thumbnail": "<string>",
"thumbnails": {
"thumbnail_png": "",
"thumbnail_play_png": "",
"thumbnail_gif": "",
"thumbnail_play_gif": "",
"custom_thumbnail": ""
},
"status": "<string>",
"language": "<string>",
"tags": {
"colors": [
"<string>"
],
"names": [
"<string>"
]
},
"available_credits": 123,
"utilised_credits": 123,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"video": "<string>",
"training_job_id": "<string>",
"srt": "<string>",
"srt_target_language": "<string>",
"voice_path": "<string>",
"smart_url": "<string>",
"recording_script": "<string>",
"data_plane_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
],
"size": 123,
"unpublished_projects": 123
}