API Reference

🏃‍♀️ With 3 easy steps, you'll be up and running in a jiffy!

This quickstart guide will assist you in getting started with YEPIC AI's API, obtaining your YEPIC AI's API key, and making it easy for you to use our API.

Step 1: Create an account

Start generating videos by creating an account with Yepic Studio.

Step 2: Authentication

Authentication enables you to manage all aspects of user identity, such as accessing the API endpoints. Request your API key from our support team via [email protected].

📘

Info

See the Authentication page to get a better understanding of the API's authentication.

Step 3: Create your first video

Creating a video with Yepic API is simple.

You need to specify parameters related to the video, such as the title, background appearance, and parameters associated with the avatar, such as its id, the script being narrated, the voice, position, style, and scale.

Don't forget to replace YOUR_API_KEY with your unique API key.

curl --request POST \
     --url https://api.yepic.ai/v1/videos \
     --header 'X-Api-Key: YOUR_API_KEY' \
     --header 'content-type: application/json' \
     --data @- <<EOF
{
     "slides": [
          {
               "overlays": [
                    {
                         "type": "AvatarOverlay",
                         "assetId": "1a901a33-8783-418e-af6a-a66dae945673",
                         "voiceId": "en-US-JennyMultilingualNeural",
                         "script": "Well done! This is your first video using Yepic's API.",
                         "xPosition": 448,
                         "yPosition": 56,
                         "width": 1024,
                         "height": 1024
                    }
               ]
          }
     ],
     "videoTitle": "My first video"
}
EOF

✅ Create your first video with YEPIC AI's API.

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