Overview

With the Studio Pro feature from Yepic AI, you can generate a video's content using artificial intelligence algorithms and natural language processing techniques to generate a textual description of what is happening in the video.

⚙️ How It Works

The following table shows attributes that support the making of videos:

Input	Object	Note
Video Format	mp4	The default format option.
	webm	If the alpha channel is required, the 'webm' option must be used instead.
Slides	Background Colour	The colour should be specified in a hex format.
	Soundtrack	Take the soundtrack from existing assets.
	Transition	A variety of transitions between slides.
	Overlays	Various overlay settings include shape, video, text, and image.

☎️ API Calls - Examples

1) POST - Create video from text or audio

This endpoint allows you to create a video from text or audio.

curl -X 'POST' \
  'https://api.yepic.ai/v1/videos' \
  -H 'accept: application/json' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "parentId": null,
  "groupId": null,
  "draft": false,
  "videoTitle": "My video from Swagger",
  "videoFormat": "mp4",
  "videoHeight": 1080,
  "videoWidth": 1920,
  "slides": [
    {
      "id": "19a90b4c-ae86-49fd-ab54-154b01f4bece",
      "slideDuration": null,
      "backgroundColor": "#ffffff",
      "soundtrack": null,
      "transition": null,
      "overlays": [
        {
          "type": "AvatarOverlay",
          "assetId": "3bfc9743-a530-44d7-9980-6af1993e81b2",
          "assetName": null,
          "assetUrl": null,
          "xPosition": 448,
          "yPosition": 56,
          "height": 1024,
          "width": 1024,
          "script": "Creating eye-catching videos is a must-have for anyone, not just marketers, as the Internet becomes synonymous with video.",
          "voiceId": "en-US-JennyMultilingualNeural",
          "voiceOverId": null,
          "voiceOverName": null,
          "voiceOverUrl": null,
          "insideShape": null,
          "shapeBackgroundColor": ""
        },
        {
          "type": "TextOverlay",
          "text": "Creating eye-catching videos is a must-have for anyone, not just marketers, as the Internet becomes synonymous with video.",
          "xPosition": 0,
          "yPosition": 0,
          "font": "",
          "fontSize": 120
        },
        {
          "type": "ImageOverlay",
          "assetId": "00000000-0000-0000-0000-000000000000",
          "assetName": "",
          "assetUrl": "",
          "xPosition": 0,
          "yPosition": 0,
          "height": null,
          "width": null,
          "scale": 1,
          "angle": 0
        },
        {
          "type": "VideoOverlay",
          "assetId": "00000000-0000-0000-0000-000000000000",
          "assetName": "",
          "assetUrl": "",
          "xPosition": 0,
          "yPosition": 0,
          "height": null,
          "width": null,
          "scale": 1,
          "length": "Full",
          "volume": 1,
          "angle": 0
        },
        {
          "type": "CircleOverlay",
          "centerX": 0,
          "centerY": 0,
          "radius": 100
        },
        {
          "type": "EllipseOverlay",
          "centerX": 0,
          "centerY": 0,
          "radiusX": 100,
          "radiusY": 100,
          "angle": 0
        },
        {
          "type": "RectangleOverlay",
          "xPosition": 0,
          "yPosition": 0,
          "height": 100,
          "width": 100,
          "angle": 0
        }
      ]
    }
  ]
}'

{
  "id": "cc625027-1014-41ff-86d5-d2c8be8bc77d",
  "parentId": null,
  "groupId": null,
  "draft": false,
  "videoTitle": "My video from Swagger",
  "videoFormat": "mp4",
  "videoHeight": 1080,
  "videoWidth": 1920,
  "videoUrl": "https://storage.googleapis.com/yepic-generated-videos/00000000-0000-0000-0000-000000000000/downloads/video/6303d320-56f4-3f4a-fa87-94af9b6af610/00000000-0000-0000-0000-000000000000.mp4",
  "videoWatermarkedUrl": "https://storage.googleapis.com/yepic-generated-videos/00000000-0000-0000-0000-000000000000/downloads/video/watermarked_00000000-0000-0000-0000-000000000000.mp4",
  "svgPayload": "",
  "jsonPayload": "{\"parentId\":null,\"groupId\":null,\"draft\":false,\"videoTitle\":\"My video from Swagger\",\"videoFormat\":\"mp4\",\"videoHeight\":1080,\"videoWidth\":1920,\"slides\":[{\"id\":\"86623c44-4719-493d-aa53-44337094eb7e\",\"slideDuration\":null,\"backgroundColor\":\"#ffffff\",\"soundtrack\":null,\"transition\":null,\"overlays\":[{\"type\":\"AvatarOverlay\",\"assetId\":\"3bfc9743-a530-44d7-9980-6af1993e81b2\",\"assetName\":null,\"assetUrl\":null,\"xPosition\":448,\"yPosition\":56,\"height\":1024,\"width\":1024,\"script\":\"Creating eye-catching videos is a must-have for anyone, not just marketers, as the Internet becomes synonymous with video.\",\"voiceId\":\"en-US-JennyMultilingualNeural\",\"voiceOverId\":null,\"voiceOverName\":null,\"voiceOverUrl\":null,\"insideShape\":null,\"shapeBackgroundColor\":\"\"},{\"type\":\"TextOverlay\",\"text\":\"Creating eye-catching videos is a must-have for anyone, not just marketers, as the Internet becomes synonymous with video.\",\"xPosition\":0,\"yPosition\":0,\"font\":\"\",\"fontSize\":120},{\"type\":\"ImageOverlay\",\"assetId\":\"00000000-0000-0000-0000-000000000000\",\"assetName\":\"\",\"assetUrl\":\"\",\"xPosition\":0,\"yPosition\":0,\"height\":null,\"width\":null,\"scale\":1,\"angle\":0},{\"type\":\"VideoOverlay\",\"assetId\":\"00000000-0000-0000-0000-000000000000\",\"assetName\":\"\",\"assetUrl\":\"\",\"xPosition\":0,\"yPosition\":0,\"height\":null,\"width\":null,\"scale\":1,\"length\":\"Full\",\"volume\":1,\"angle\":0},{\"type\":\"CircleOverlay\",\"centerX\":0,\"centerY\":0,\"radius\":100},{\"type\":\"EllipseOverlay\",\"centerX\":0,\"centerY\":0,\"radiusX\":100,\"radiusY\":100,\"angle\":0},{\"type\":\"RectangleOverlay\",\"xPosition\":0,\"yPosition\":0,\"height\":100,\"width\":100,\"angle\":0}]}]}",
  "createDate": "2023-09-18T03:56:58.8879836+00:00",
  "renderStartDate": null,
  "renderEndDate": null,
  "renderProgress": null,
  "status": "Queued",
  "visibility": "Public",
  "videoLength": null,
  "creditsSpent": 0,
  "warnings": []
}

2) POST - Requeue a Video Request by ID

This functionality is particularly useful for reprocessing or reattempting video generation tasks, ensuring efficient and flexible management of video creation processes.

curl --request GET \
     --url 'https://api.yepic.ai/v1/videos?PageSize=25&Page=1' \
     --header 'X-Api-Key: YOUR_API_KEY' \
     --header 'accept: application/json'

{
  "videos": [
    {
      "id": "video_id",
      "title": "",
      "videoUrl": "video_url",
      "svgPayload": "",
      "jsonPayload": "{\"videoTitle\":\"newvideo\",\"videoFormat\":\"mp4\",\"slides\":[],\"videoHeight\":1,\"videoWidth\":2}",
      "createDate": "2023-05-04T01:54:18.274509+00:00",
      "generationDate": null,
      "status": "Published",
      "visibility": "Private",
      "videoLength": null
    }
  ]
}

3) GET - Retrieve a Video request

By making this request, users can access details such as the status, parameters, and metadata associated with a particular video generation task. This functionality facilitates the tracking and monitoring of video requests, enabling users to obtain valuable insights and updates on their video creation processes.

curl -X 'GET' \
  'https://api.yepic.ai/v1/videos/cc625027-1014-41ff-86d5-d2c8be8bc77d' \
  -H 'accept: application/json' \
  -H 'X-Api-Key: YOUR_API_KEY'

{
  "id": "cc625027-1014-41ff-86d5-d2c8be8bc77d",
  "videoTitle": "My video from Swagger",
  "videoUrl": "https://storage.googleapis.com/yepic-generated-videos/00000000-0000-0000-0000-000000000000/downloads/video/6303d320-56f4-3f4a-fa87-94af9b6af610/00000000-0000-0000-0000-000000000000.mp4",
  "videoWatermarkedUrl": "https://storage.googleapis.com/yepic-generated-videos/00000000-0000-0000-0000-000000000000/downloads/video/watermarked_00000000-0000-0000-0000-000000000000.mp4",
  "svgPayload": "",
  "jsonPayload": "{\"parentId\":null,\"groupId\":null,\"draft\":false,\"videoTitle\":\"My video from Swagger\",\"videoFormat\":\"mp4\",\"videoHeight\":1080,\"videoWidth\":1920,\"slides\":[{\"id\":\"86623c44-4719-493d-aa53-44337094eb7e\",\"slideDuration\":null,\"backgroundColor\":\"#ffffff\",\"soundtrack\":null,\"transition\":null,\"overlays\":[{\"type\":\"AvatarOverlay\",\"assetId\":\"3bfc9743-a530-44d7-9980-6af1993e81b2\",\"assetName\":null,\"assetUrl\":null,\"xPosition\":448,\"yPosition\":56,\"height\":1024,\"width\":1024,\"script\":\"Creating eye-catching videos is a must-have for anyone, not just marketers, as the Internet becomes synonymous with video.\",\"voiceId\":\"en-US-JennyMultilingualNeural\",\"voiceOverId\":null,\"voiceOverName\":null,\"voiceOverUrl\":null,\"insideShape\":null,\"shapeBackgroundColor\":\"\"},{\"type\":\"TextOverlay\",\"text\":\"Creating eye-catching videos is a must-have for anyone, not just marketers, as the Internet becomes synonymous with video.\",\"xPosition\":0,\"yPosition\":0,\"font\":\"\",\"fontSize\":120},{\"type\":\"ImageOverlay\",\"assetId\":\"00000000-0000-0000-0000-000000000000\",\"assetName\":\"\",\"assetUrl\":\"\",\"xPosition\":0,\"yPosition\":0,\"height\":null,\"width\":null,\"scale\":1,\"angle\":0},{\"type\":\"VideoOverlay\",\"assetId\":\"00000000-0000-0000-0000-000000000000\",\"assetName\":\"\",\"assetUrl\":\"\",\"xPosition\":0,\"yPosition\":0,\"height\":null,\"width\":null,\"scale\":1,\"length\":\"Full\",\"volume\":1,\"angle\":0},{\"type\":\"CircleOverlay\",\"centerX\":0,\"centerY\":0,\"radius\":100},{\"type\":\"EllipseOverlay\",\"centerX\":0,\"centerY\":0,\"radiusX\":100,\"radiusY\":100,\"angle\":0},{\"type\":\"RectangleOverlay\",\"xPosition\":0,\"yPosition\":0,\"height\":100,\"width\":100,\"angle\":0}]}]}",
  "createDate": "2023-09-18T03:56:58.887983+00:00",
  "renderStartDate": null,
  "renderEndDate": null,
  "renderProgress": null,
  "status": "Queued",
  "visibility": "Public",
  "videoLength": null
}

4) GET - Retrieve a list of video requests

With this endpoint, you can get a list of video requests.

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

[
  {
    "id": "4ae0bc2b-20de-4ddd-b2a1-89394a60c73a",
    "videoTitle": "myfirstvideo",
    "videoUrl": "https://storage.googleapis.com/yepic-generated-videos/4ae0bc2b-20de-4ddd-b2a1-89394a60c73a/downloads/video/2df4df56-c970-75a5-a54a-2b08740f383d/4ae0bc2b-20de-4ddd-b2a1-89394a60c73a_mux.mp4",
    "videoWatermarkedUrl": "https://storage.googleapis.com/yepic-generated-videos/4ae0bc2b-20de-4ddd-b2a1-89394a60c73a/downloads/video/4ae0bc2b-20de-4ddd-b2a1-89394a60c73a.mp4",
    "svgPayload": "",
    "jsonPayload": "{\"videoTitle\":\"myfirstvideo\",\"videoFormat\":\"mp4\",\"slides\":[],\"videoHeight\":300,\"videoWidth\":500}",
    "createDate": "2023-07-19T07:55:59.008849+00:00",
    "renderStartDate": null,
    "renderEndDate": null,
    "renderProgress": null,
    "status": "Queued",
    "visibility": "Private",
    "videoLength": null
  },
  {
    "id": "287cd1de-3cc0-4e47-a131-50c9a2d62470",
    "videoTitle": "myfirstvideo",
    "videoUrl": "https://storage.googleapis.com/yepic-generated-videos/287cd1de-3cc0-4e47-a131-50c9a2d62470/downloads/video/42bc1d94-4ad5-2c98-4b6e-e5848235221b/287cd1de-3cc0-4e47-a131-50c9a2d62470_mux.mp4",
    "videoWatermarkedUrl": "https://storage.googleapis.com/yepic-generated-videos/287cd1de-3cc0-4e47-a131-50c9a2d62470/downloads/video/287cd1de-3cc0-4e47-a131-50c9a2d62470.mp4",
    "svgPayload": "",
    "jsonPayload": "{\"videoTitle\":\"myfirstvideo\",\"videoFormat\":\"mp4\",\"slides\":[],\"videoHeight\":300,\"videoWidth\":500}",
    "createDate": "2023-06-07T05:17:24.626966+00:00",
    "renderStartDate": null,
    "renderEndDate": null,
    "renderProgress": null,
    "status": "Queued",
    "visibility": "Private",
    "videoLength": null
  },
  {
    "id": "e9a72e9d-3d10-4d3e-849c-77209a368f89",
    "videoTitle": "myfirstvideo",
    "videoUrl": "https://storage.googleapis.com/yepic-generated-videos/e9a72e9d-3d10-4d3e-849c-77209a368f89/downloads/video/7507f83a-54d9-cea6-8a29-9165f312b7f2/e9a72e9d-3d10-4d3e-849c-77209a368f89_mux.mp4",
    "videoWatermarkedUrl": "https://storage.googleapis.com/yepic-generated-videos/e9a72e9d-3d10-4d3e-849c-77209a368f89/downloads/video/e9a72e9d-3d10-4d3e-849c-77209a368f89.mp4",
    "svgPayload": "",
    "jsonPayload": "{\"videoTitle\":\"myfirstvideo\",\"videoFormat\":\"mp4\",\"slides\":[],\"videoHeight\":1,\"videoWidth\":1}",
    "createDate": "2023-05-29T06:18:20.46639+00:00",
    "renderStartDate": null,
    "renderEndDate": null,
    "renderProgress": null,
    "status": "Queued",
    "visibility": "Private",
    "videoLength": null
  },
  {
    "id": "809286fc-cd26-4d35-9160-c72163d1a240",
    "videoTitle": "newvideo",
    "videoUrl": "https://storage.googleapis.com/yepic-generated-videos/809286fc-cd26-4d35-9160-c72163d1a240/downloads/video/b11bf3f9-18ab-dcd4-2bf9-b4b8c1a6d0d2/809286fc-cd26-4d35-9160-c72163d1a240_mux.mp4",
    "videoWatermarkedUrl": "https://storage.googleapis.com/yepic-generated-videos/809286fc-cd26-4d35-9160-c72163d1a240/downloads/video/809286fc-cd26-4d35-9160-c72163d1a240.mp4",
    "svgPayload": "",
    "jsonPayload": "{\"videoTitle\":\"newvideo\",\"videoFormat\":\"mp4\",\"slides\":[],\"videoHeight\":1,\"videoWidth\":2}",
    "createDate": "2023-05-04T01:54:18.274509+00:00",
    "renderStartDate": null,
    "renderEndDate": null,
    "renderProgress": null,
    "status": "Queued",
    "visibility": "Private",
    "videoLength": null
  },
  {
    "id": "6d9f79b6-4855-4bf2-9ca9-45956fe1a77d",
    "videoTitle": "firstvideo",
    "videoUrl": "https://storage.googleapis.com/yepic-generated-videos/6d9f79b6-4855-4bf2-9ca9-45956fe1a77d/downloads/video/2563c6b8-a61f-f22d-2052-07ebed3805c3/6d9f79b6-4855-4bf2-9ca9-45956fe1a77d_mux.mp4",
    "videoWatermarkedUrl": "https://storage.googleapis.com/yepic-generated-videos/6d9f79b6-4855-4bf2-9ca9-45956fe1a77d/downloads/video/6d9f79b6-4855-4bf2-9ca9-45956fe1a77d.mp4",
    "svgPayload": "",
    "jsonPayload": "{\"videoTitle\":\"firstvideo\",\"videoFormat\":\"mp4\",\"slides\":[],\"videoHeight\":1,\"videoWidth\":2}",
    "createDate": "2023-05-04T02:05:01.686036+00:00",
    "renderStartDate": null,
    "renderEndDate": null,
    "renderProgress": null,
    "status": "Queued",
    "visibility": "Private",
    "videoLength": null
  }
]

5) DELETE - Delete a video request

Use this endpoint to delete the existing video using its id.

curl -X 'DELETE' \
  'https://api.yepic.ai/v1/videos/cc625027-1014-41ff-86d5-d2c8be8bc77d' \
  -H 'accept: application/json' \
  -H 'X-Api-Key: YOUR_API_KEY'

{}

6) PATCH - Update a video request

Use this endpoint to update the existing video using its id and title.

curl -X 'PATCH' \
  'https://api.yepic.ai/v1/videos/cc625027-1014-41ff-86d5-d2c8be8bc77d' \
  -H 'accept: application/json' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "parentId": null,
  "groupId": null,
  "draft": false,
  "visibility": "Public",
  "videoTitle": "My video title. customer from Swagger"
}'

{
  "id": "cc625027-1014-41ff-86d5-d2c8be8bc77d",
  "parentId": null,
  "groupId": null,
  "draft": false,
  "videoTitle": "My video title. customer from Swagger",
  "videoUrl": "https://storage.googleapis.com/yepic-generated-videos/00000000-0000-0000-0000-000000000000/downloads/video/6303d320-56f4-3f4a-fa87-94af9b6af610/00000000-0000-0000-0000-000000000000.mp4",
  "videoWatermarkedUrl": "https://storage.googleapis.com/yepic-generated-videos/00000000-0000-0000-0000-000000000000/downloads/video/watermarked_00000000-0000-0000-0000-000000000000.mp4",
  "svgPayload": "",
  "jsonPayload": "{\"parentId\":null,\"groupId\":null,\"draft\":false,\"videoTitle\":\"My video from Swagger\",\"videoFormat\":\"mp4\",\"videoHeight\":1080,\"videoWidth\":1920,\"slides\":[{\"id\":\"86623c44-4719-493d-aa53-44337094eb7e\",\"slideDuration\":null,\"backgroundColor\":\"#ffffff\",\"soundtrack\":null,\"transition\":null,\"overlays\":[{\"type\":\"AvatarOverlay\",\"assetId\":\"3bfc9743-a530-44d7-9980-6af1993e81b2\",\"assetName\":null,\"assetUrl\":null,\"xPosition\":448,\"yPosition\":56,\"height\":1024,\"width\":1024,\"script\":\"Creating eye-catching videos is a must-have for anyone, not just marketers, as the Internet becomes synonymous with video.\",\"voiceId\":\"en-US-JennyMultilingualNeural\",\"voiceOverId\":null,\"voiceOverName\":null,\"voiceOverUrl\":null,\"insideShape\":null,\"shapeBackgroundColor\":\"\"},{\"type\":\"TextOverlay\",\"text\":\"Creating eye-catching videos is a must-have for anyone, not just marketers, as the Internet becomes synonymous with video.\",\"xPosition\":0,\"yPosition\":0,\"font\":\"\",\"fontSize\":120},{\"type\":\"ImageOverlay\",\"assetId\":\"00000000-0000-0000-0000-000000000000\",\"assetName\":\"\",\"assetUrl\":\"\",\"xPosition\":0,\"yPosition\":0,\"height\":null,\"width\":null,\"scale\":1,\"angle\":0},{\"type\":\"VideoOverlay\",\"assetId\":\"00000000-0000-0000-0000-000000000000\",\"assetName\":\"\",\"assetUrl\":\"\",\"xPosition\":0,\"yPosition\":0,\"height\":null,\"width\":null,\"scale\":1,\"length\":\"Full\",\"volume\":1,\"angle\":0},{\"type\":\"CircleOverlay\",\"centerX\":0,\"centerY\":0,\"radius\":100},{\"type\":\"EllipseOverlay\",\"centerX\":0,\"centerY\":0,\"radiusX\":100,\"radiusY\":100,\"angle\":0},{\"type\":\"RectangleOverlay\",\"xPosition\":0,\"yPosition\":0,\"height\":100,\"width\":100,\"angle\":0}]}]}",
  "createDate": "2023-09-18T03:56:58.887983+00:00",
  "renderStartDate": null,
  "renderEndDate": null,
  "renderProgress": null,
  "status": "Queued",
  "visibility": "Public",
  "videoLength": null
}

📌 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.