POST
/
api
/
ai_shorts
/
preview
/

​
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
headerrequired

API ID, from your settings page.

X-API-KEY
string
headerrequired

API Key, from your settings page.

Body

aspect_ratio
enum<string>
required
  • 9x16 - 9X16
  • 16x9 - 16X9
  • 1x1 - 1X1
Available options:
9x16,
16x9,
1x1
script
string
required
style
enum<string>
required
  • 4K realistic - _4K_REALISTIC
  • 3D - _3D
  • Cinematic - CINEMATIC
  • Cartoonish - CARTOONISH
  • Line art - LINE_ART
  • Pixel art - PIXEL_ART
  • Mysterious - MYSTERIOUS
  • Steam punk - STEAM_PUNK
  • Collage - COLLAGE
  • Kawaii - KAWAII
Available options:
4K realistic,
3D,
Cinematic,
Cartoonish,
Line art,
Pixel art,
Mysterious,
Steam punk,
Collage,
Kawaii
accent
string | null

Accent to be used for the video, default null and default voice will be used

caption_setting
object

Caption setting, default null and default caption setting will be used

Response

200 - application/json
id
string
required
media_job
string | null
required
status
enum<string>
required
  • pending - Pending
  • in_queue - In Queue
  • running - Running
  • failed - Failed
  • done - Done
  • rejected - Rejected
Available options:
pending,
in_queue,
running,
failed,
done,
rejected
video_output
string | null
required
preview
string | null
required
is_hidden
boolean
required
created_at
string
required
updated_at
string
required
permission_type
enum<string>
required
  • private - Private
  • workspace - Workspace
  • public - Public
Available options:
private,
workspace,
public
user
integer | null
required
workspace
string | null
required
name
string
Maximum length: 255
script
string | null

Text to be converted to video

aspect_ratio

Aspect ratio of the video

  • 9x16 - 9X16
  • 16x9 - 16X9
  • 1x1 - 1X1
Available options:
9x16,
16x9,
1x1
style

Style to be used for the video

  • 4K realistic - _4K_REALISTIC
  • 3D - _3D
  • Cinematic - CINEMATIC
  • Cartoonish - CARTOONISH
  • Line art - LINE_ART
  • Pixel art - PIXEL_ART
  • Mysterious - MYSTERIOUS
  • Steam punk - STEAM_PUNK
  • Collage - COLLAGE
  • Kawaii - KAWAII
Available options:
4K realistic,
3D,
Cinematic,
Cartoonish,
Line art,
Pixel art,
Mysterious,
Steam punk,
Collage,
Kawaii
created_from_api
boolean

Flow is created from api or not

caption_setting
any | null

Caption setting, default null and default caption setting will be used

accent
string | null

Accent to be used for the video, default null and default voice will be used

Create a AI Shorts taskRender a AI Shorts video