---
title: "Add timed overlays"
method: POST
path: "/tools/add_timed_overlays"
---

# Add timed overlays

`POST /tools/add_timed_overlays`

## Request

- Base URL: `https://api.bannerbear.com/v5`
- URL: `https://api.bannerbear.com/v5/tools/add_timed_overlays`
- Auth: HTTP bearer

Place several overlay videos on one video at set times. Async — returns 202 with a pending job; poll GET /tool_jobs/{uid} until `status` is `completed` or `failed`.

## Request body

- object
  - `base_video_url` string, uri, required: Base video URL
  - `overlay_video_urls` string[], required: 1 to 10 overlays, in the same order as the start times
  - `starts` string[], required: When each overlay begins, one number for each overlay
  - `overlay_size` 'original' | 'match_base_width': match_base_width scales each overlay to the width of the base video. Defaults to original
  - `position` 'top_left' | 'top_center' | 'top_right' | 'center' | 'bottom_left' | 'bottom_center' | 'bottom_right': Snap to a corner or edge. Use this or x/y, not both
  - `margin` integer: Gap from the edge when using position. Defaults to 0
  - `x` integer: Absolute position from the left. Ignored when position is set
  - `y` integer: Absolute position from the top. Ignored when position is set
  - `metadata` string: Arbitrary metadata string stored with the tool run

## Response `202`

Tool run accepted

- object
  - `uid` string
  - `tool` 'add_timed_overlays'
  - `status` 'pending' | 'running' | 'completed' | 'failed': pending → running → completed / failed
  - `progress` integer: 0-100 job progress, 100 once completed
  - `inputs` object: Inputs the job was created with
  - `outputs` object
    - `video_url` string, uri
  - `metadata` string, nullable: Arbitrary metadata string round-tripped from the create request
  - `self` string, uri
  - `created_at` string, date-time
  - `completed_at` string, date-time, nullable
  - `error_message` string, nullable: Human-readable failure reason (only present on failed jobs)

## Other responses

- `402`: API quota exhausted — upgrade required
- `404`: Unknown tool
- `422`: Input validation failure

## Changes

- **2026-11-14** `357256cbd1e5`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/bannerbear/apis/bannerbear-v5-api/changes/tools/add_timed_overlays/post.md)

---

[API](https://skmtc.dev/bannerbear/apis/bannerbear-v5-api.md) - [All operations](https://skmtc.dev/bannerbear/apis/bannerbear-v5-api/llms.txt) - [OpenAPI document](https://skmtc.dev/bannerbear/apis/bannerbear-v5-api/revisions/357256cbd1e5?raw)
