GigaReels LogoGigaReels
API Reference

Split Screen API

API reference for the split screen endpoint.

The Split Screen API allows you to programmatically create a split-screen video from your video and a background video.

Endpoint

POST /api/render/split

Authorization

All API requests require an API key to be included in the Authorization header.

Authorization: Bearer YOUR_API_KEY

Request Body

FieldTypeDescription
videoUrlstringRequired. The URL of your video.
positionstringRequired. Position of your video. Can be left, right, top, or bottom.
brollVideostringThe URL of the background/b-roll video. If not provided, a default is used.
objectFitstringThe object fit of the videos. Can be cover or contain. If not provided, smart defaults are applied based on position.

Smart Defaults

When objectFit is not specified:

  • For left or right positions: defaults to contain (assumes vertical video)
  • For top or bottom positions: defaults to cover (assumes horizontal video)

Example Request

{
  "videoUrl": "https://example.com/my-video.mp4",
  "position": "left",
  "objectFit": "cover"
}

Example Response

{
  "success": true,
  "renderId": "some-render-id"
}