Create a video

An endpoint to create a new video

POST https://api.aipixy.com/v1/bot

Headers

Name	Type	Description
Authorization*	String	Authorization: Bearer YOUR_API_KEY

Request Body

Name	Type	Description
webhook *	String	a webhook url to get notified when the process is done and the video is ready. (Replace www.website.com/video-process-done-endpoint with your actual webhook URL)
create_video	boolean	set to true to create a video or false to create voice only.
clips	String	array of objects - an array containing information about each video clip. In this case, it includes details about a single clip with parameters such as bot_uid, text, bot_position, remove_bot_background, background, background_volume, transitions, reusable_clip, and clip_name. (Adjust the values as needed.)

400: Bad Request

401: Unauthorized

201: Created

500: Internal Server Error

Bash

curl -X POST \
     -H "Authorization: Bearer YOUR_API_KEY" \
     -F "webhook=www.website.com/video-process-done-endpoint" \
     -F "create_video=true" \
     -F "clips=[{ \"bot_uid\": 'YOUR_BOT_UID', \"text\": \"This is the text that I want to say\", \"bot_position\": 'bottom-right', \"remove_bot_background\": false, \"background\": 'https://url_to_your_background.mp4', \"background_volume\": 0.1, \"transitions\": 'fade_in fade_out', \"reusable_clip\": true, \"clip_name\": 'A name for this video' }]" \
     https://api.example.com/v1/create_video

Python

ap = Aipixy(api_key='API_KEY')

clips = [
    {
        "bot_uid": 'YOUR_BOT_UID',
        "text": "This is the text that I want to say",
        "bot_position": 'bottom-right',
        "remove_bot_background": False,
        "background": 'https://url_to_your_background.mp4',
        "background_volume": 0.1,
        "transitions": 'fade_in fade_out',
        "reusable_clip": True,
        "clip_name": 'A name for this video',
    }
]
new_video = ap.create_video(webhook='www.website.com/video-process-done-endpoint',
                            create_video=True,
                            clips=clips)