GET
/
api
/
ai_shorts
/
cURL
curl --request GET \
  --url https://api.creatify.ai/api/ai_shorts/ \
  --header 'X-API-ID: <api-key>' \
  --header 'X-API-KEY: <api-key>'
[
  {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "status": "pending",
    "failed_reason": "<string>",
    "video_output": "<string>",
    "preview": "<string>",
    "editor_url": "<string>",
    "is_hidden": true,
    "progress": 123,
    "credits_used": 123,
    "duration": 123,
    "media_job": "<string>",
    "permission_type": "private",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "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",
    "brand": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "accent": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  }
]

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.

Query Parameters

​
ids
string

Comma-separated list of UUIDs to filter. Maximum 100 entries allowed.

Minimum length: 1
​
ordering
string

Which field to use when ordering the results.

Response

200 - application/json
​
id
string<uuid>
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
​
failed_reason
string
required

Failed reason

​
video_output
string | null
required

Video output URL

​
preview
string | null
required

Preview URL

​
editor_url
string | null
required

Editor URL for the video. Expires in 24 hours. Available only if your API account has API editor access enabled. , expires in 24 hours.

​
is_hidden
boolean
required

Is the video hidden in the website projects page

​
progress
number
required

Progress of the job

​
credits_used
integer
required

Credits used in this API call

​
duration
integer
required

Duration of the video in seconds

​
media_job
string | null
required
​
permission_type
enum<string>
required
  • private - Private
  • workspace - Workspace
  • public - Public
Available options:
private,
workspace,
public
​
created_at
string<date-time>
required
​
updated_at
string<date-time>
required
​
user
integer | null
required
​
workspace
string<uuid> | 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

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

​
background_music_url
string<uri> | null

Background music URL for the video. Default is null, video will use random music.

Maximum length: 255
​
background_music_volume
number | null

Volume of the background music, ranging from 0.0 to 1.0. Default is null, video will use default music volume of visual_style.

Required range: 0 <= x <= 1
​
voiceover_volume
number | null

Volume of the voiceover, ranging from 0.0 to 1.0. Default is null, video will use default voiceover volume of visual_style.

Required range: 0 <= x <= 1
​
webhook_url
string<uri> | null

Webhook URL for status updates. Default is null.

Maximum length: 200
​
brand
string<uuid> | null
​
accent
string<uuid> | null

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