Sign in

v1

latestOpenAPI 3.0.32026-07-2691139249.7 KB
ai_shorts

post/api/ai_shorts/preview/

Request body

aspect_ratio'9x16' | '16x9' | '1x1' required
  • 9x16 - 9X16
  • 16x9 - 16X9
  • 1x1 - 1X1
scriptstring required
style'4K realistic' | '3D' | 'Cinematic' | 'Cartoonish' | 'Line art' | 'Pixel art' | 'Mysterious' | 'Steam punk' | 'Collage' | 'Kawaii' 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
accentstring uuid nullable

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

background_music_urlstring uri nullable

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

background_music_volumenumber double nullable

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

voiceover_volumenumber double nullable

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

webhook_urlstring uri nullable

Webhook URL for status updates. Default is null.

Response

idstring uuid required
status'pending' | 'in_queue' | 'running' | 'failed' | 'done' | 'rejected' required
  • pending - Pending
  • in_queue - In Queue
  • running - Running
  • failed - Failed
  • done - Done
  • rejected - Rejected
failed_reasonstring required

Failed reason

video_outputstring nullable required

Video output URL

previewstring nullable required

Preview URL

editor_urlstring nullable 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_hiddenboolean required

Is the video hidden in the website projects page

progressnumber double required

Progress of the job

credits_usednumber required

Credits used in this API call

durationinteger required

Duration of the video in seconds

media_jobstring nullable required
permission_type'private' | 'workspace' | 'public' required
  • private - Private
  • workspace - Workspace
  • public - Public
created_atstring date-time required
updated_atstring date-time required
namestring
scriptstring nullable

Text to be converted to video

created_from_apiboolean

Flow is created from api or not

{"stackTrail":"components:schemas:ArtsyVideoFlow:properties:caption_setting","oasType":"schema","type":"unknown","description":"Caption setting, default null and default caption setting will be used","nullable":true}
background_music_urlstring uri nullable

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

background_music_volumenumber double nullable

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

voiceover_volumenumber double nullable

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

webhook_urlstring uri nullable

Webhook URL for status updates. Default is null.

userinteger nullable required
workspacestring uuid nullable required
brandstring uuid nullable
accentstring uuid nullable

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