# Video Overlay

Video Overlay composites an image or second video on top of your footage, placing logos, lower-thirds, or picture-in-picture with precise control.

## API Information

- **Model Slug:** video-overlay
- **Branded URL:** https://www.eachlabs.ai/eachlabs/video-api/video-overlay
- **Provider:** each::labs
- **Category:** Video to Video
- **Output Type:** video
- **Status:** active
- **Base Cost:** Execution-time pricing: approximately $0.00128/sec based on run_time
- **Estimated Processing Time:** 20 seconds
- **Interactive Demo:** https://www.eachlabs.ai/ai-models/video-overlay

## Pricing

- **Charge Type:** dynamic
- **Pricing Details:** Execution-time pricing: approximately $0.00128/sec based on run_time

### Pricing Rules

| Condition | Pricing |
| --- | --- |
| Rule 1 | Execution-time pricing: approximately $0.00128/sec based on run_time |

## Input Schema

| Parameter | Type | Required | Default | Constraints | Description |
|-----------|------|----------|---------|-------------|-------------|
| video | string | Yes | - | - | URL of the source video file. |
| overlay | string | Yes | - | - | URL of the overlay media file. |
| margin | integer | Yes | - | - | Margin in pixels between the overlay and the selected video edge. |
| overlay_scale | number | Yes | - | - | Scale factor applied to the overlay before compositing. |
| position | string | Yes | - | top_left, top_right, bottom_left, bottom_right, center | Overlay placement within the source video frame. |

## Example Request

```bash
curl -X POST https://api.eachlabs.ai/v1/prediction/ \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "model": "video-overlay",
  "input": {
    "margin": 24,
    "overlay": "https://cdn-us.eachlabs.ai/defaults/a9222b5d4f5a4f95bb40be16fcc333fb.mp4",
    "overlay_scale": 0.3,
    "position": "center",
    "video": "https://cdn-us.eachlabs.ai/defaults/51f03f43f63243e6991ac920a907a0cb.mp4"
  }
}'
```

## Output Schema

Response returned by `GET /v1/prediction/{id}` when the job completes:

```json
{
  "status": "success",
  "predictionID": "string",
  "output": "string (URL of generated video)",
  "metrics": {
    "predict_time": "number (seconds)"
  }
}
```

## Polling

```bash
curl https://api.eachlabs.ai/v1/prediction/{PREDICTION_ID} \
  -H "Authorization: Bearer YOUR_API_KEY"
```

| Status | Meaning |
|--------|---------|
| `processing` | Still running — poll again |
| `success` | Done — read `output` |
| `error` | Failed — read `message` / `details` |

## Webhook (alternative to polling)

Pass `"webhook_url": "https://your.host/path"` in the create request. Eachlabs POSTs this payload when the job ends:

```json
{
  "exec_id": "prediction-uuid",
  "status": "succeeded",
  "output": "https://...",
  "error": ""
}
```

`status` is `"succeeded"` or `"failed"`. `exec_id` equals the `predictionID` from create. Return 2xx within 30 seconds.

## Errors

Error body: `{ "status": "error", "message": "...", "details": "..." }`

| Code | Meaning |
|------|---------|
| `400` | Invalid input |
| `401` | Missing / invalid `Authorization` bearer token |
| `404` | Unknown model or prediction id |
| `429` | Rate limit — 100 creates / min, 10 concurrent per key |
| `5xx` | Retry with backoff |

## Usage Notes

- API Base URL: `https://api.eachlabs.ai/v1`
- Authentication: send `Authorization: Bearer YOUR_API_KEY`. Generate a key from the Eachlabs dashboard at https://www.eachlabs.ai/dashboard/api-keys.
- File-typed parameters (`*_url`, `image_url`, `video_url`, `audio_url`, etc.) accept publicly-reachable HTTPS URLs only. Upload your asset first (GCS / S3 / your CDN) and pass the resulting URL. Data-URIs and localhost URLs are rejected.
- For structured parameters (arrays / objects) send real JSON values, not stringified payloads.
- Monetary values are reported in USD; per-token / per-megapixel rates may be billed in micro-cents internally.
- Prefer `webhook_url` over polling for long-running predictions — see the Webhook Callback section.