Videos

Create a video edit

Create a new video generation job by editing a source video or existing generated video.

post/videos/edits

Request body

promptstring required

Text prompt that describes how to edit the source video.

Example request

{
  "video": {
    "id": "video_123"
  }
}

Response

Success

idstring required

Unique identifier for the video job.

object'video' required

The object type, which is always video.

status'queued' | 'in_progress' | 'completed' | 'failed' required
progressinteger required

Approximate completion percentage for the generation task.

created_atinteger required

Unix timestamp (seconds) for when the job was created.

completed_atinteger nullable required

Unix timestamp (seconds) for when the job completed, if finished.

expires_atinteger nullable required

Unix timestamp (seconds) for when the downloadable assets expire, if set.

promptstring nullable required

The prompt that was used to generate the video.

size'720x1280' | '1280x720' | '1024x1792' | '1792x1024' required
secondsstring required

Duration of the generated clip in seconds. For extensions, this is the stitched total duration.

remixed_from_video_idstring nullable required

Identifier of the source video if this video is a remix.

Changes

Changed in 7 of the 163 revisions of this API.10

    • ○

      added the non-success response with the status

      response-non-success-status-added

    • ○

      added the non-success response with the status

      response-non-success-status-added

    • ○

      added the non-success response with the status

      response-non-success-status-added

    • ○

      added the optional property // to the response with the status

      response-optional-property-added

    • ○

      added the non-success response with the status

      response-non-success-status-added

    • ○

      added the optional property // to the response with the status

      response-optional-property-added

    • ○

      added the optional property / to the response with the status

      response-optional-property-added

    • ○

      added the non-success response with the status

      response-non-success-status-added

    • ○

      endpoint deprecated

      endpoint-deprecated

    • ○

      endpoint added

      endpoint-added

    This revision also has 40 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog