---
title: "Add image overlay"
method: POST
path: "/tools/overlay_image"
---

# Add image overlay

`POST /tools/overlay_image`

Burn a logo, watermark, or badge onto a video. Async — returns 202 with a pending job; poll GET /tool_jobs/{uid} until `status` is `completed` or `failed`.

## Request body

- object
  - `video_url` string, uri, required — Video URL
  - `image_url` string, uri, required — Overlay image URL
  - `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
  - `opacity` number — 0.0 to 1.0
  - `metadata` string — Arbitrary metadata string stored with the tool run

## Response `202`

Tool run accepted

- object
  - `uid` string
  - `tool` 'overlay_image'
  - `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

---

[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-service-production.skmtc.workers.dev/v1/apis/bannerbear/bannerbear-v5-api/revisions/6aa425420a10/schema)