---
title: "Add a staged overlay to a Subscribr Video revision"
method: POST
path: "/api/v1/video/projects/{project}/revision/overlays"
tags: ["video"]
---

# Add a staged overlay to a Subscribr Video revision

`POST /api/v1/video/projects/{project}/revision/overlays`

## Request

- Base URL: `https://subscribr.ai`
- URL: `https://subscribr.ai/api/v1/video/projects/{project}/revision/overlays`
- Auth: HTTP bearer

## Path parameters

- `project` string, required

## Headers

- `Idempotency-Key` string
- `If-Match` string

## Request body

- VideoAddOverlayRequest
  - `beat_sequence` integer
  - `client_request_id` string, uuid
  - `end_time` number
  - `inputs` object, required
  - `playhead_time` number
  - `span_scope` string
  - `start_time` number
  - `template` string, required

## Response `201`

Add a staged overlay to a Subscribr Video revision.

- VideoAddOverlayResponse
  - `data` object, required
    - `end_time` number
    - `id` string
    - `overlay_id` string
    - `revision_item_id` string
    - `start_time` number
    - `status` string
    - `template` string
  - `meta` object, required
    - `idempotent_replay` boolean

## Other responses

- `400`: The request could not be processed.
- `401`: Authentication is required.
- `403`: The token, role, entitlement, or object policy denies this action.
- `404`: The resource was not found or is not visible.
- `409`: The request conflicts with current state, revision, idempotency, or canonical replacement.
- `422`: One or more request fields are invalid.
- `429`: The request exceeded a rate limit.
- `500`: The service is temporarily unavailable.

---

[API](https://skmtc.dev/subscribr/apis/subscribr-customer-api.md) · [All operations](https://skmtc.dev/subscribr/apis/subscribr-customer-api/llms.txt) · [OpenAPI document](https://skmtc.dev/subscribr/apis/subscribr-customer-api/revisions/d1f105b58bbd?raw)