CRcreatify
ai_editing

POST /api/ai_editing/preview/

Changed on

Request

  • The document declares no server URL.
  • Auth
    API key in header X-API-ID and API key in header X-API-KEY

Request body

editing_style'film' | 'geometric_gradient' | 'glitch' | 'glitter_gradient' | 'paper' required
  • film - Film
  • geometric_gradient - Geometric Gradient
  • glitch - Glitch
  • glitter_gradient - Glitter Gradient
  • paper - Paper
video_urlstring uri required
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

is_talking_videoboolean

Whether the video is talking video or not

is_one_person_in_videoboolean

Whether the video is one person video or not

audio_urlstring nullable

Audio to be used for the video

video_urlstring nullable

Video to be used for the video

sizenumber double

Size of the video

created_from_apiboolean

Flow is created from api or not

caption_settingunknown
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

Changes

  • 8423ba73b422Revision changes
    • info

      added the new Abril Fatface enum value to the request property ///////// (media type: application/json)

    • info

      added the new Abril Fatface enum value to the request property ///////// (media type: application/x-www-form-urlencoded)

    • info

      added the new Abril Fatface enum value to the request property ///////// (media type: multipart/form-data)

    • info

      added the new Alata enum value to the request property ///////// (media type: application/json)

    • info

      added the new Alata enum value to the request property ///////// (media type: application/x-www-form-urlencoded)

    • info

      added the new Alata enum value to the request property ///////// (media type: multipart/form-data)

    • info

      added the new Alice enum value to the request property ///////// (media type: application/json)

    • info

      added the new Alice enum value to the request property ///////// (media type: application/x-www-form-urlencoded)

    • info

      added the new Alice enum value to the request property ///////// (media type: multipart/form-data)

    • info

      added the new Allura enum value to the request property ///////// (media type: application/json)

    • info

      added the new Allura enum value to the request property ///////// (media type: application/x-www-form-urlencoded)

    • info

      added the new Allura enum value to the request property ///////// (media type: multipart/form-data)

    • info

      added the new Anton enum value to the request property ///////// (media type: application/json)

    • info

      added the new Anton enum value to the request property ///////// (media type: application/x-www-form-urlencoded)

    • info

      added the new Anton enum value to the request property ///////// (media type: multipart/form-data)

    • info

      added the new Archivo Black enum value to the request property ///////// (media type: application/json)

    • info

      added the new Archivo Black enum value to the request property ///////// (media type: application/x-www-form-urlencoded)

    • info

      added the new Archivo Black enum value to the request property ///////// (media type: multipart/form-data)

    • info

      added the new Arimo enum value to the request property ///////// (media type: application/json)

    • info

      added the new Arimo enum value to the request property ///////// (media type: application/x-www-form-urlencoded)

    • info

      added the new Arimo enum value to the request property ///////// (media type: multipart/form-data)

    • info

      added the new Ballet enum value to the request property ///////// (media type: application/json)

    • info

      added the new Ballet enum value to the request property ///////// (media type: application/x-www-form-urlencoded)

    • info

      added the new Ballet enum value to the request property ///////// (media type: multipart/form-data)

    • info

      added the new Berkshire Swash enum value to the request property ///////// (media type: application/json)

    • info

      added the new Berkshire Swash enum value to the request property ///////// (media type: application/x-www-form-urlencoded)

    • info

      added the new Berkshire Swash enum value to the request property ///////// (media type: multipart/form-data)

    • info

      added the new Bodoni Moda enum value to the request property ///////// (media type: application/json)

    • info

      added the new Bodoni Moda enum value to the request property ///////// (media type: application/x-www-form-urlencoded)

    • info

      added the new Bodoni Moda enum value to the request property ///////// (media type: multipart/form-data)

    • info

      added the new Cinzel enum value to the request property ///////// (media type: application/json)

    • info

      added the new Cinzel enum value to the request property ///////// (media type: application/x-www-form-urlencoded)

    • info

      added the new Cinzel enum value to the request property ///////// (media type: multipart/form-data)

    • info

      added the new Comic Neue enum value to the request property ///////// (media type: application/json)

    • info

      added the new Comic Neue enum value to the request property ///////// (media type: application/x-www-form-urlencoded)

    • info

      added the new Comic Neue enum value to the request property ///////// (media type: multipart/form-data)

    • info

      added the new DM Sans enum value to the request property ///////// (media type: application/json)

    • info

      added the new DM Sans enum value to the request property ///////// (media type: application/x-www-form-urlencoded)

    • info

      added the new DM Sans enum value to the request property ///////// (media type: multipart/form-data)

    • info

      added the new Figtree enum value to the request property ///////// (media type: application/json)

    • info

      added the new Figtree enum value to the request property ///////// (media type: application/x-www-form-urlencoded)

    • info

      added the new Figtree enum value to the request property ///////// (media type: multipart/form-data)

    • info

      added the new Fredoka enum value to the request property ///////// (media type: application/json)

    • info

      added the new Fredoka enum value to the request property ///////// (media type: application/x-www-form-urlencoded)

    • info

      added the new Fredoka enum value to the request property ///////// (media type: multipart/form-data)

    • info

      added the new IBM Plex Mono enum value to the request property ///////// (media type: application/json)

    • info

      added the new IBM Plex Mono enum value to the request property ///////// (media type: application/x-www-form-urlencoded)

    • info

      added the new IBM Plex Mono enum value to the request property ///////// (media type: multipart/form-data)

    • info

      added the new Joti One enum value to the request property ///////// (media type: application/json)

    • info

      added the new Joti One enum value to the request property ///////// (media type: application/x-www-form-urlencoded)

    • info

      added the new Joti One enum value to the request property ///////// (media type: multipart/form-data)

    • info

      added the new League Spartan enum value to the request property ///////// (media type: application/json)

    • info

      added the new League Spartan enum value to the request property ///////// (media type: application/x-www-form-urlencoded)

    • info

      added the new League Spartan enum value to the request property ///////// (media type: multipart/form-data)

    • info

      added the new Lora enum value to the request property ///////// (media type: application/json)

    • info

      added the new Lora enum value to the request property ///////// (media type: application/x-www-form-urlencoded)

    • info

      added the new Lora enum value to the request property ///////// (media type: multipart/form-data)

    • info

      added the new Noto Serif enum value to the request property ///////// (media type: application/json)

    • info

      added the new Noto Serif enum value to the request property ///////// (media type: application/x-www-form-urlencoded)

    • info

      added the new Noto Serif enum value to the request property ///////// (media type: multipart/form-data)

    • info

      added the new Open Sans enum value to the request property ///////// (media type: application/json)

    • info

      added the new Open Sans enum value to the request property ///////// (media type: application/x-www-form-urlencoded)

    • info

      added the new Open Sans enum value to the request property ///////// (media type: multipart/form-data)

    • info

      added the new Orbitron enum value to the request property ///////// (media type: application/json)

    • info

      added the new Orbitron enum value to the request property ///////// (media type: application/x-www-form-urlencoded)

    • info

      added the new Orbitron enum value to the request property ///////// (media type: multipart/form-data)

    • info

      added the new Oswald enum value to the request property ///////// (media type: application/json)

    • info

      added the new Oswald enum value to the request property ///////// (media type: application/x-www-form-urlencoded)

    • info

      added the new Oswald enum value to the request property ///////// (media type: multipart/form-data)

    • info

      added the new Pacifico enum value to the request property ///////// (media type: application/json)

    • info

      added the new Pacifico enum value to the request property ///////// (media type: application/x-www-form-urlencoded)

    • info

      added the new Pacifico enum value to the request property ///////// (media type: multipart/form-data)

    • info

      added the new Playfair Display enum value to the request property ///////// (media type: application/json)

    • info

      added the new Playfair Display enum value to the request property ///////// (media type: application/x-www-form-urlencoded)

    • info

      added the new Playfair Display enum value to the request property ///////// (media type: multipart/form-data)

    • info

      added the new Radio Canada enum value to the request property ///////// (media type: application/json)

    • info

      added the new Radio Canada enum value to the request property ///////// (media type: application/x-www-form-urlencoded)

    • info

      added the new Radio Canada enum value to the request property ///////// (media type: multipart/form-data)

    • info

      added the new Roboto enum value to the request property ///////// (media type: application/json)

    • info

      added the new Roboto enum value to the request property ///////// (media type: application/x-www-form-urlencoded)

    • info

      added the new Roboto enum value to the request property ///////// (media type: multipart/form-data)

    • info

      added the new Rubik Dirt enum value to the request property ///////// (media type: application/json)

    • info

      added the new Rubik Dirt enum value to the request property ///////// (media type: application/x-www-form-urlencoded)

    • info

      added the new Rubik Dirt enum value to the request property ///////// (media type: multipart/form-data)

    • info

      added the new Space Grotesk enum value to the request property ///////// (media type: application/json)

    • info

      added the new Space Grotesk enum value to the request property ///////// (media type: application/x-www-form-urlencoded)

    • info

      added the new Space Grotesk enum value to the request property ///////// (media type: multipart/form-data)

    • info

      added the new Stalemate enum value to the request property ///////// (media type: application/json)

    • info

      added the new Stalemate enum value to the request property ///////// (media type: application/x-www-form-urlencoded)

    • info

      added the new Stalemate enum value to the request property ///////// (media type: multipart/form-data)

    • info

      added the new Tektur enum value to the request property ///////// (media type: application/json)

    • info

      added the new Tektur enum value to the request property ///////// (media type: application/x-www-form-urlencoded)

    • info

      added the new Tektur enum value to the request property ///////// (media type: multipart/form-data)