POST
/
api
/
ai_shorts
/
preview
/
curl --request POST \
  --url https://api.creatify.ai/api/ai_shorts/preview/ \
  --header 'Content-Type: application/json' \
  --header 'X-API-ID: <api-key>' \
  --header 'X-API-KEY: <api-key>' \
  --data '{
  "aspect_ratio": "9x16",
  "script": "<string>",
  "style": "4K realistic",
  "accent": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "caption_setting": {
    "style": "normal-black",
    "offset": {
      "x": 0,
      "y": 0.4
    },
    "font_family": "Montserrat",
    "font_size": 70,
    "font_style": "font-bold",
    "background_color": "<string>",
    "text_color": "<string>",
    "highlight_text_color": "<string>",
    "max_width": 123,
    "line_height": 123,
    "text_shadow": "<string>",
    "hidden": false
  },
  "background_music_url": "<string>",
  "background_music_volume": 0.5,
  "voiceover_volume": 0.5,
  "webhook_url": "<string>"
}'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "credits_used": 123,
  "duration": 123,
  "media_job": "<string>",
  "status": "pending",
  "video_output": "<string>",
  "preview": "<string>",
  "is_hidden": true,
  "progress": 123,
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "permission_type": "private",
  "name": "<string>",
  "script": "<string>",
  "aspect_ratio": "9x16",
  "style": "4K realistic",
  "created_from_api": true,
  "caption_setting": "<any>",
  "background_music_url": "<string>",
  "background_music_volume": 0.5,
  "voiceover_volume": 0.5,
  "webhook_url": "<string>",
  "user": 123,
  "workspace": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "accent": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

​
Queue a preview generation task

Generate a preview of AI Shorts video.

import requests

url = "https://api.creatify.ai/api/ai_shorts/preview/"

payload = {
    "script": "Meet the Tesla Model X, where cutting-edge technology meets unparalleled performance. Designed with luxury and comfort in mind, the Model X offers a driving experience like no other.",
    "aspect_ratio": "9x16",
    "style": "4K realistic"
}
headers = {
    "X-API-ID": "<your-x-api-id>",
    "X-API-KEY": "<your-x-api-key>",
    "Content-Type": "application/json"
}

response = requests.request("POST", url, json=payload, headers=headers)

print(response.text)

​
Check preview status

Now our AI model is generating preview of AI Shorts video. It will return a id of the AI Shorts video. Then you can check the preview status of your video by sending a GET request to Get AI Shorts video by id endpoint.

import requests

url = "https://api.creatify.ai/api/ai_shorts/{id}/"

headers = {
    "X-API-ID": "<your-x-api-id>",
    "X-API-KEY": "<your-x-api-key>"
}

response = requests.request("GET", url, headers=headers)

print(response.text)

Once the preview of AI Shorts video is generated, there will be data in preview field. Then you can render the video by sending a POST request to Render a AI Shorts video endpoint.

​
Render the video

import requests

url = "https://api.creatify.ai/api/ai_shorts/{id}/render/"

payload = {}

headers = {
    "X-API-ID": "<your-x-api-id>",
    "X-API-KEY": "<your-x-api-key>",
    "Content-Type": "application/json"
}

response = requests.request("POST", url, json=payload, headers=headers)

print(response.text)

​
Check render status

import requests

url = "https://api.creatify.ai/api/ai_shorts/{id}/"

headers = {
    "X-API-ID": "<your-x-api-id>",
    "X-API-KEY": "<your-x-api-key>"
}

response = requests.request("GET", url, headers=headers)

print(response.text)

You will find the status to be done when finished. Meanwhile you can find the video output in video_output field.

Authorizations

​
X-API-ID
string
header
required

API ID, from your settings page.

​
X-API-KEY
string
header
required

API Key, from your settings page.

Body

Response

200 - application/json

The response is of type object.