POST
/
api
/
ai_editing
/
preview
/

Authorizations

X-API-ID
string
headerrequired

API ID, from your settings page.

X-API-KEY
string
headerrequired

API Key, from your settings page.

Body

editing_style
enum<string>
required
  • film - Film
  • geometric_gradient - Geometric Gradient
  • glitch - Glitch
  • glitter_gradient - Glitter Gradient
  • paper - Paper
Available options:
film,
geometric_gradient,
glitch,
glitter_gradient,
paper
video_url
string
required
script
string | null

Text to be converted to video

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
created_at
string
required
updated_at
string
required
permission_type
enum<string>
required
  • private - Private
  • workspace - Workspace
  • public - Public
Available options:
private,
workspace,
public
is_hidden
boolean
required

Whether the job is hidden or not

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
is_talking_video
boolean

Whether the video is talking video or not

is_one_person_in_video
boolean

Whether the video is one person video or not

editing_style

Style to be used for the video

  • film - Film
  • geometric_gradient - Geometric Gradient
  • glitch - Glitch
  • glitter_gradient - Glitter Gradient
  • paper - Paper
Available options:
film,
geometric_gradient,
glitch,
glitter_gradient,
paper
duration
number

Duration of the video

audio_url
string | null

Audio to be used for the video

Maximum length: 255
video_url
string | null

Video to be used for the video

Maximum length: 255
size
number

Size of the video

created_from_api
boolean

Flow is created from api or not

Get AI Shorts item by idRender a AI Editing video