API Reference

Overview

🗣 Making videos with Yepic AI just got easier!

Introducing an incredible breakthrough in AI tech that you won't want to miss, Studio Express Videos.

The Studio Express Videos helps you scale your video communications without cameras, actors, or studios. You'll be able to create personalized videos in no time with even better and more advanced capabilities.

⚙️ How It Works


☎️ API Calls - Examples

📘

Info

  • See the list of available avatars.
  • See the list of available voices.

1. POST - Creates TalkingPhoto from text or audio

This endpoint allows you to create a video by utilizing the powerful feature of talking photos. There are two ways to develop fast video:

  1. Develop fast video using avatarId . Please refer here to obtain the Avatar ID to be used.
  2. Develop fast video using avatarUrl. You can upload your own image and use that URL to fill avatarUrl. Please make sure that the image has the same format as shown on this page.
curl -X 'POST' \
  'https://api.yepic.ai/v1/talkingphotos' \
  -H 'accept: application/json' \
  -H 'X-Api-Key: 194bbf67-e6fd-45da-943f-773ee2ed83a2' \
  -H 'Content-Type: application/json' \
  -d '{
  "parentId": null,
  "groupId": null,
  "draft": false,
  "avatarId": "15a861f5-0f6e-4298-b26f-7c7e72c76dc3",
  "avatarName": null,
  "avatarUrl": null,
  "fullFrame": true,
  "dynamic": false,
  "voiceId": "en-US-JennyMultilingualNeural",
  "voiceOverId": null,
  "voiceOverName": null,
  "voiceOverUrl": null,
  "script": "Hello I try this from Swagger",
  "videoFormat": "mp4",
  "videoWidth": 256,
  "videoHeight": 256,
  "videoTitle": "My talking photo video title.",
  "visibility": "Public"
}'

{
  "id": "73b49938-4ee3-49ab-84da-8f2d27e72300",
  "parentId": null,
  "groupId": null,
  "draft": false,
  "userId": "32447060-32b2-4bcb-9827-2d14ca35196c",
  "dateCreated": "2023-09-15T15:45:18.764189+00:00",
  "renderStartDate": null,
  "renderEndDate": null,
  "renderProgress": null,
  "videoPreviewImageUrl": "https://storage.googleapis.com/yepic-backgrounds/avatar_images/tk_original/15a861f5-0f6e-4298-b26f-7c7e72c76dc3.png",
  "videoUrl": "https://storage.googleapis.com/yepic-generated-videos/73b49938-4ee3-49ab-84da-8f2d27e72300/downloads/avatar/f008ec05-4d04-be9a-8f87-bd13657c62d4/73b49938-4ee3-49ab-84da-8f2d27e72300.mp4",
  "videoWatermarkedUrl": "https://storage.googleapis.com/yepic-generated-videos/73b49938-4ee3-49ab-84da-8f2d27e72300/downloads/avatar/watermarked_73b49938-4ee3-49ab-84da-8f2d27e72300.mp4",
  "videoLength": null,
  "avatarId": "15a861f5-0f6e-4298-b26f-7c7e72c76dc3",
  "avatarName": null,
  "avatarUrl": null,
  "voiceId": "en-US-JennyMultilingualNeural",
  "voiceOverId": null,
  "voiceOverName": null,
  "voiceOverUrl": null,
  "fullFrame": true,
  "dynamic": false,
  "script": "Hello I try this from Swagger",
  "videoFormat": "mp4",
  "videoWidth": 256,
  "videoHeight": 256,
  "videoTitle": "My talking photo video title.",
  "visibility": "Public",
  "status": null
}

2. POST - Requeue a Talking Photo Video Request by ID

This request allows users to submit a request to regenerate a video by specifying its unique identifier (ID). It offers a fast and efficient way to recreate videos based on previously generated talking photo requests."

curl -X 'POST' \
  'https://api.yepic.ai/v1/talkingphotos/requeue/{id}' \
  -H 'accept: application/json' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  -d ''

{
  "id": "73b49938-4ee3-49ab-84da-8f2d27e72300"
}

3. GET - Retrieve a list of TalkingPhoto requests

With this endpoint, you can get a list of generated videos.

curl -X 'GET' \
  'https://api.yepic.ai/v1/talkingphotos?PageSize=5&Page=1' \
  -H 'accept: application/json' \
 	-H 'X-Api-Key: YOUR_API_KEY' \

[
  {
    "id": "6b2cd19f-6998-470a-9931-543e75f28821",
    "parentId": null,
    "groupId": null,
    "draft": null,
    "userId": "32447060-32b2-4bcb-9827-2d14ca35196c",
    "dateCreated": "2023-08-24T03:12:39.945479+00:00",
    "renderStartDate": null,
    "renderEndDate": null,
    "renderProgress": null,
    "videoPreviewImageUrl": "https://yepic-api-asset-storage-production.s3.eu-west-2.amazonaws.com/716822a2-e255-43c6-875b-a559eb0b0478.png?X-Amz-Expires=43200&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAXTRTYVQOYN73OYUI%2F20230915%2Feu-west-2%2Fs3%2Faws4_request&X-Amz-Date=20230915T153659Z&X-Amz-SignedHeaders=host&X-Amz-Signature=a178c9cee0887464072a0ef156d8fff917ef91419199767883b6f7f5d46370e4",
    "videoUrl": "https://storage.googleapis.com/yepic-generated-videos/6b2cd19f-6998-470a-9931-543e75f28821/downloads/avatar/6a4dc3ee-04f7-de46-2b9a-f90bed3e3962/6b2cd19f-6998-470a-9931-543e75f28821.mp4",
    "videoWatermarkedUrl": "https://storage.googleapis.com/yepic-generated-videos/6b2cd19f-6998-470a-9931-543e75f28821/downloads/avatar/watermarked_6b2cd19f-6998-470a-9931-543e75f28821.mp4",
    "videoLength": null,
    "avatarId": "716822a2-e255-43c6-875b-a559eb0b0478",
    "avatarName": null,
    "avatarUrl": "https://storage.googleapis.com/yepic-backgrounds/avatar_images/raw/1905f687d4104ea8a5f8419ae6d9c3c8.png",
    "voiceId": "en-US-JennyMultilingualNeural",
    "voiceOverId": null,
    "voiceOverName": null,
    "voiceOverUrl": null,
    "fullFrame": true,
    "dynamic": false,
    "script": "Creating eye-catching videos is a must-have for anyone, not just marketers, as the Internet becomes synonymous with video.",
    "videoFormat": "mp4",
    "videoWidth": 256,
    "videoHeight": 256,
    "videoTitle": "My new video name",
    "visibility": "None",
    "status": null
  },
  {
    "id": "d68264e1-d9b2-4c1f-be16-acf2522609fd",
    "parentId": null,
    "groupId": null,
    "draft": null,
    "userId": "32447060-32b2-4bcb-9827-2d14ca35196c",
    "dateCreated": "2023-08-23T13:18:18.472233+00:00",
    "renderStartDate": null,
    "renderEndDate": null,
    "renderProgress": null,
    "videoPreviewImageUrl": "https://storage.googleapis.com/yepic-backgrounds/avatar_images/raw/1905f687d4104ea8a5f8419ae6d9c3c8.png",
    "videoUrl": "https://storage.googleapis.com/yepic-generated-videos/d68264e1-d9b2-4c1f-be16-acf2522609fd/downloads/avatar/67077986-42f2-9674-a250-4adc9d83c823/d68264e1-d9b2-4c1f-be16-acf2522609fd.mp4",
    "videoWatermarkedUrl": "https://storage.googleapis.com/yepic-generated-videos/d68264e1-d9b2-4c1f-be16-acf2522609fd/downloads/avatar/watermarked_d68264e1-d9b2-4c1f-be16-acf2522609fd.mp4",
    "videoLength": null,
    "avatarId": "550f4c3f-3156-451e-a848-c2954eaa0ce1",
    "avatarName": null,
    "avatarUrl": null,
    "voiceId": "en-US-JennyMultilingualNeural",
    "voiceOverId": null,
    "voiceOverName": null,
    "voiceOverUrl": null,
    "fullFrame": true,
    "dynamic": false,
    "script": "Creating eye-catching videos is a must-have for anyone, not just marketers, as the Internet becomes synonymous with video.",
    "videoFormat": "mp4",
    "videoWidth": 256,
    "videoHeight": 256,
    "videoTitle": "My video title.",
    "visibility": "Public",
    "status": null
  },
  {
    "id": "7d8a8852-4309-4b53-b31d-b8b55fb63e4c",
    "parentId": null,
    "groupId": null,
    "draft": null,
    "userId": "32447060-32b2-4bcb-9827-2d14ca35196c",
    "dateCreated": "2023-08-23T13:18:08.780439+00:00",
    "renderStartDate": null,
    "renderEndDate": null,
    "renderProgress": null,
    "videoPreviewImageUrl": "https://storage.googleapis.com/yepic-backgrounds/avatar_images/raw/1905f687d4104ea8a5f8419ae6d9c3c8.png",
    "videoUrl": "https://storage.googleapis.com/yepic-generated-videos/7d8a8852-4309-4b53-b31d-b8b55fb63e4c/downloads/avatar/1d12ad32-4cf6-d88e-6676-cb19da70a5a8/7d8a8852-4309-4b53-b31d-b8b55fb63e4c.mp4",
    "videoWatermarkedUrl": "https://storage.googleapis.com/yepic-generated-videos/7d8a8852-4309-4b53-b31d-b8b55fb63e4c/downloads/avatar/watermarked_7d8a8852-4309-4b53-b31d-b8b55fb63e4c.mp4",
    "videoLength": null,
    "avatarId": "550f4c3f-3156-451e-a848-c2954eaa0ce1",
    "avatarName": "Yvonne",
    "avatarUrl": "https://storage.googleapis.com/yepic-backgrounds/avatar_images/raw/1905f687d4104ea8a5f8419ae6d9c3c8.png",
    "voiceId": "en-US-JennyMultilingualNeural",
    "voiceOverId": null,
    "voiceOverName": null,
    "voiceOverUrl": null,
    "fullFrame": true,
    "dynamic": false,
    "script": "Creating eye-catching videos is a must-have for anyone, not just marketers, as the Internet becomes synonymous with video.",
    "videoFormat": "mp4",
    "videoWidth": 256,
    "videoHeight": 256,
    "videoTitle": "My video title.",
    "visibility": "Public",
    "status": null
  },
  {
    "id": "3c95d73a-8fe7-4820-b9eb-001624a24089",
    "parentId": null,
    "groupId": null,
    "draft": null,
    "userId": "32447060-32b2-4bcb-9827-2d14ca35196c",
    "dateCreated": "2023-08-23T13:18:37.323165+00:00",
    "renderStartDate": null,
    "renderEndDate": null,
    "renderProgress": null,
    "videoPreviewImageUrl": "https://storage.googleapis.com/yepic-backgrounds/avatar_images/raw/1905f687d4104ea8a5f8419ae6d9c3c8.png",
    "videoUrl": "https://storage.googleapis.com/yepic-generated-videos/3c95d73a-8fe7-4820-b9eb-001624a24089/downloads/avatar/b404d1af-192d-ba63-8708-116eb0fb345a/3c95d73a-8fe7-4820-b9eb-001624a24089.mp4",
    "videoWatermarkedUrl": "https://storage.googleapis.com/yepic-generated-videos/3c95d73a-8fe7-4820-b9eb-001624a24089/downloads/avatar/watermarked_3c95d73a-8fe7-4820-b9eb-001624a24089.mp4",
    "videoLength": null,
    "avatarId": "550f4c3f-3156-451e-a848-c2954eaa0ce1",
    "avatarName": "Yvonne",
    "avatarUrl": "https://storage.googleapis.com/yepic-backgrounds/avatar_images/raw/1905f687d4104ea8a5f8419ae6d9c3c8.png",
    "voiceId": "en-US-JennyMultilingualNeural",
    "voiceOverId": null,
    "voiceOverName": null,
    "voiceOverUrl": null,
    "fullFrame": true,
    "dynamic": false,
    "script": "Creating eye-catching videos is a must-have for anyone, not just marketers, as the Internet becomes synonymous with video.",
    "videoFormat": "mp4",
    "videoWidth": 256,
    "videoHeight": 256,
    "videoTitle": "My video title.",
    "visibility": "Public",
    "status": null
  },
  {
    "id": "bbdbab41-06d9-4a4e-839a-1ca856a0a392",
    "parentId": null,
    "groupId": null,
    "draft": null,
    "userId": "32447060-32b2-4bcb-9827-2d14ca35196c",
    "dateCreated": "2023-08-23T13:40:15.916487+00:00",
    "renderStartDate": null,
    "renderEndDate": null,
    "renderProgress": null,
    "videoPreviewImageUrl": "https://storage.googleapis.com/yepic-backgrounds/avatar_images/raw/1905f687d4104ea8a5f8419ae6d9c3c8.png",
    "videoUrl": "https://storage.googleapis.com/yepic-generated-videos/bbdbab41-06d9-4a4e-839a-1ca856a0a392/downloads/avatar/aefef9c9-352d-3d21-f1cd-97dd7cbdbe97/bbdbab41-06d9-4a4e-839a-1ca856a0a392.mp4",
    "videoWatermarkedUrl": "https://storage.googleapis.com/yepic-generated-videos/bbdbab41-06d9-4a4e-839a-1ca856a0a392/downloads/avatar/watermarked_bbdbab41-06d9-4a4e-839a-1ca856a0a392.mp4",
    "videoLength": null,
    "avatarId": "550f4c3f-3156-451e-a848-c2954eaa0ce1",
    "avatarName": null,
    "avatarUrl": null,
    "voiceId": "en-US-JennyMultilingualNeural",
    "voiceOverId": null,
    "voiceOverName": null,
    "voiceOverUrl": null,
    "fullFrame": true,
    "dynamic": false,
    "script": "Creating eye-catching videos is a must-have for anyone, not just marketers, as the Internet becomes synonymous with video.",
    "videoFormat": "mp4",
    "videoWidth": 256,
    "videoHeight": 256,
    "videoTitle": "My video title.",
    "visibility": "Public",
    "status": null
  }
]

4. GET - Retrieve a TalkingPhoto request

With this endpoint, you can get a generated video using its ID. To get the ID, you need to make sure that there is a TalkingPhoto request. To check that, you can use this endpoint.

curl -X 'GET' \
  'https://api.yepic.ai/v1/talkingphotos/73b49938-4ee3-49ab-84da-8f2d27e72300' \
  -H 'accept: application/json' \
  -H 'X-Api-Key: 194bbf67-e6fd-45da-943f-773ee2ed83a2'

{
  "id": "73b49938-4ee3-49ab-84da-8f2d27e72300",
  "parentId": null,
  "groupId": null,
  "draft": false,
  "userId": "32447060-32b2-4bcb-9827-2d14ca35196c",
  "dateCreated": "2023-09-15T15:45:18.764189+00:00",
  "renderStartDate": null,
  "renderEndDate": null,
  "renderProgress": null,
  "videoPreviewImageUrl": "https://storage.googleapis.com/yepic-backgrounds/avatar_images/tk_original/15a861f5-0f6e-4298-b26f-7c7e72c76dc3.png",
  "videoUrl": "https://storage.googleapis.com/yepic-generated-videos/73b49938-4ee3-49ab-84da-8f2d27e72300/downloads/avatar/f008ec05-4d04-be9a-8f87-bd13657c62d4/73b49938-4ee3-49ab-84da-8f2d27e72300.mp4",
  "videoWatermarkedUrl": "https://storage.googleapis.com/yepic-generated-videos/73b49938-4ee3-49ab-84da-8f2d27e72300/downloads/avatar/watermarked_73b49938-4ee3-49ab-84da-8f2d27e72300.mp4",
  "videoLength": null,
  "avatarId": "15a861f5-0f6e-4298-b26f-7c7e72c76dc3",
  "avatarName": null,
  "avatarUrl": null,
  "voiceId": "en-US-JennyMultilingualNeural",
  "voiceOverId": null,
  "voiceOverName": null,
  "voiceOverUrl": null,
  "fullFrame": true,
  "dynamic": false,
  "script": "Hello I try this from Swagger",
  "videoFormat": "mp4",
  "videoWidth": 256,
  "videoHeight": 256,
  "videoTitle": "My talking photo video title.",
  "visibility": "Public",
  "status": null
}

5. PATCH - Update a TalkingPhoto request

Use this endpoint to update the existing video using its ID and name.

curl -X 'PATCH' \
  'https://api.yepic.ai/v1/talkingphotos/73b49938-4ee3-49ab-84da-8f2d27e72300' \
  -H 'accept: application/json' \
  -H 'X-Api-Key: 194bbf67-e6fd-45da-943f-773ee2ed83a2' \
  -H 'Content-Type: application/json' \
  -d '{
  "parentId": null,
  "groupId": null,
  "draft": false,
  "videoTitle": "My talking photo video title updated from Swagger.",
  "visibility": "Public"
}'

{
  "id": "73b49938-4ee3-49ab-84da-8f2d27e72300",
  "parentId": null,
  "groupId": null,
  "draft": false,
  "userId": "32447060-32b2-4bcb-9827-2d14ca35196c",
  "deleted": null,
  "dateCreated": "2023-09-15T15:45:18.764189+00:00",
  "renderStartDate": null,
  "renderEndDate": null,
  "renderProgress": null,
  "videoPreviewImageUrl": "https://storage.googleapis.com/yepic-backgrounds/avatar_images/tk_original/15a861f5-0f6e-4298-b26f-7c7e72c76dc3.png",
  "videoUrl": "https://storage.googleapis.com/yepic-generated-videos/73b49938-4ee3-49ab-84da-8f2d27e72300/downloads/avatar/f008ec05-4d04-be9a-8f87-bd13657c62d4/73b49938-4ee3-49ab-84da-8f2d27e72300.mp4",
  "videoWatermarkedUrl": "https://storage.googleapis.com/yepic-generated-videos/73b49938-4ee3-49ab-84da-8f2d27e72300/downloads/avatar/watermarked_73b49938-4ee3-49ab-84da-8f2d27e72300.mp4",
  "videoLength": null,
  "avatarId": "15a861f5-0f6e-4298-b26f-7c7e72c76dc3",
  "avatarName": null,
  "avatarUrl": null,
  "voiceId": "en-US-JennyMultilingualNeural",
  "voiceOverId": null,
  "voiceOverName": null,
  "voiceOverUrl": null,
  "fullFrame": true,
  "dynamic": false,
  "script": "Hello I try this from Swagger",
  "videoFormat": "mp4",
  "videoWidth": 256,
  "videoHeight": 256,
  "videoTitle": "My talking photo video title updated from Swagger.",
  "visibility": "Public",
  "status": null
}

6. DELETE- Delete a TalkingPhoto request

Use this endpoint to delete the existing video using its ID. To get the ID, you need to make sure that there is a TalkingPhoto request. To check that, you can use this endpoint.

curl --request DELETE \
     --url https://api.yepic.ai/v1/talkingphotos/id \
     --header 'X-Api-Key: 194bbf67-e6fd-45da-943f-773ee2ed83a2' \
     --header 'accept: application/json'

{}

📌 Need help?

If you require assistance or encounter any issues, we recommend referring to our FAQ page first. If you are still unable to resolve your issue, please don't hesitate to contact us for further support.