Get Projects

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",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "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,
      "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
}

GET

projects

Get Projects

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",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "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,
      "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

Authorization

string

header

required

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

Response

Successful Response

data

ProjectResponsePartial · object[]

required

Show child attributes

data.user_id

string<uuid>

required

This refers to the user's unique id.

data.project_id

string<uuid>

required

This refers to the project's unique id.

data.title

string

required

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

data.project_type

enum<string>

required

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

Available options:

PERSONALIZED,

PERSONALIZED_INSTANT,

NON_PERSONALIZED

data.created_at

string<date-time>

required

Project creation timestamp

data.updated_at

string<date-time>

required

Project Updation timestamp

data.thumbnail

string

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

data.thumbnails

Thumbnails · object

Cloudfront links to the thumbnails.

Show child attributes

data.thumbnails.thumbnail_png

string

default:""

data.thumbnails.thumbnail_play_png

string

default:""

data.thumbnails.thumbnail_gif

string

default:""

data.thumbnails.thumbnail_play_gif

string

default:""

data.thumbnails.custom_thumbnail

string

default:""

data.status

string

data.language

string

data.tags

ProjectTags · object

The tags associated with the particular video.

Show child attributes

data.tags.colors

string[]

data.tags.names

string[]

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

data.available_credits

integer

The user's available credits.

data.utilised_credits

integer

The user's utilized credits.

data.video

string

S3 link to the project video.

data.training_job_id

string

data.srt

string

data.srt_target_language

string

data.voice_path

string

S3 link to the voice path of the project video.

data.smart_url

string

These are the links to videos on our landing page.

data.recording_script

string

data.data_plane_id

string<uuid>

size

integer

required

Count of projects made by the user.

unpublished_projects

integer

required

Count of unpublished projects of the user.

Set Webhook for video_status

⌘I

User

Create Video

Inference

Project

Get Projects

Authorizations

Response