Combine video clips into a new video

post

https://api.autoreelapp.com/api/v1/combine_video_clips

Combine multiple existing video clips (previously generated via AutoReel) into a single combined video. All clips must share the same orientation and resolution.

Recent Requests

Log in to see full request history

Time	Status	User Agent
Retrieving recent requests…

Loading…

Authentication

Authorization: <YOUR_API_KEY>

Request Body Fields

Field	Type	Required	Description
`video_clip_uuids`	string[]	Yes	List of UUIDs of previously created video clips. Maximum count depends on your plan's per-video clip limit. Note: all video_clips must be made with the same `ai_engine`
`orientation`	string	Yes	Must be `landscape` or `portrait`. All clips must match this.
`resolution`	string	Yes	Must be `720p` or `1080p`. All clips must match this.
`audio_url`	string	No	Public URL to optional background audio (≤ 10 MB)
`project`	string	No	UUID of a project to link the combined video to. Omit it to use your API key's default project.
`branding`	object	optional	Apply an intro and/or outro template to this video. Both slots optional - see the `Branding` object below for its shape, and List templates to discover available template ids and fields.

`Branding` object

Field	Type	Required	Description
intro	object	No	`TemplateSlot` applied to the intro (first ~3s). See below.
outro	object	No	`TemplateSlot` applied to the outro (3s end card appended after the last clip). See below.

`TemplateSlot` object

Field	Type	Required	Description
template	string	Yes	Template id from List templates. Must match this slot's placement (intro/outro).
config	object	No	Field values keyed by field key. See Intro Templates / Outro Templates for each template's keys, and the object structure examples there.

Example Request Body

{
  "video_clip_uuids": [
    "b9f4201e-ef9e-4de0-9f3c-b958bd9dd0b0",
    "db1e97f0-b77f-455a-b5d7-83f8a5beed71"
  ],
  "orientation": "landscape",
  "resolution": "720p",
  "project": "b1f2c3d4-5678-4abc-9def-0123456789ab",
  "branding": {
    "intro": {
      "template": "gold-frame",
      "config": {
        "title": { "value": "Just Listed" },
        "subtitle": { "value": "$650,000" }
      }
    },
    "outro": {
      "template": "classic",
      "config": {
        "outro_text": { "value": "Jane Doe\n(415) 555-0137" },
        "brand_logo": { "url": "https://example.com/logo.png" }
      }
    }
  }
}

Successful Response

Field	Type	Description
`uuid`	`string`	UUID of the new combined video
`project`	`string`	UUID of the project this video was linked to — either the one you passed in `project`, or your API key's default project if you didn't.
`status`	`string`	Status of the new video (`queued`, `in_progress`, `complete`)
`video_url`	`string`	Empty initially; will be populated when processing is complete
`video_clips`	`VideoClip[]`	List of included clips in the combined video
`orientation`	`string`	Orientation of the combined video (`landscape` or `portrait`)
`resolution`	`string`	Resolution of the combined video (`720p` or `1080p`)
`ai_engine`	`string`	AI Engine used (`v24` or `v25`)
`branding`	object	Present only if branding was requested. Tracks the separate branded render - see Branding object below.

`video_clips[]` object

Field	Type	Description
`uuid`	`string`	UUID of the individual clip used
`image_url`	`string`	URL of the image associated with the clip
`clip_url`	`string`	URL of the video clip
`camera_motion`	`string`	Camera motion used
`orientation`	`string`	Orientation of the clip
`resolution`	`string`	Resolution of the clip
`ai_engine`	`string`	AI Engine used to make the clip (`v24` or `v25`)
`vfx`	object \| null	VFX applied to that clip (mirrors the original create_video input), or null if none.

Branding

Field	Type	Description
`status`	string	Status of the branded render. One of `queued`, `in_progress`, `complete`, or `error`. This is independent of the top-level video `status`.
`video_url`	string	URL of the branded video. Empty until `status` is `complete`. The branded render typically finishes a few minutes after the top-level `video_url` is available. Poll `GET /get_video` to retrieve the updated URL.
`templates`	object	Echoes the intro/outro template configuration provided in the request. Has the same structure as the `branding` request parameter.

Response

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json