apply layout

Frame clips into a split-screen, picture-in-picture, sidebar or grid: a layout, its slots filled by name, each clip framed into its slot in one step. clip_id per slot frames clips already on the timeline (the first slot's clip stays, the others move onto fresh layers aligned to its start; a clip already in the arrangement is re-framed, so calling again moves nothing); clip_ids gives one slot several clips; the same clip_id in every slot lays one shot out as a tile per person. item per slot places library media over range instead, one layer per slot. Video and image only. fit fill (default) crops to the slot, fit letterboxes the whole source; anchor per slot picks what survives the crop. Layouts and slots, first named first: split-h: left, right; split-v: top, bottom; pip-bottom-right, pip-bottom-left, pip-top-right, pip-top-left: main, inset; main-sidebar: main, sidebar; row3: left, center, right; stack3: top, middle, bottom; grid-2x2, grid-3x3, grid-4x4: r1c1 to r4c4, row 1 at the top. edit_timeline updateClip {frame: null} takes a clip out of its layout. Free.

POST

tools

apply_layout

apply layout

curl --request POST \
  --url https://eversince.ai/api/v1/tools/apply_layout \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "timeline_id": "<string>",
  "slots": [
    {
      "slot": "<string>",
      "clip_id": "<string>",
      "clip_ids": [
        "<string>"
      ],
      "item": "<string>"
    }
  ]
}
'

import requests

url = "https://eversince.ai/api/v1/tools/apply_layout"

payload = {
    "timeline_id": "<string>",
    "slots": [
        {
            "slot": "<string>",
            "clip_id": "<string>",
            "clip_ids": ["<string>"],
            "item": "<string>"
        }
    ]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    timeline_id: '<string>',
    slots: [
      {
        slot: '<string>',
        clip_id: '<string>',
        clip_ids: ['<string>'],
        item: '<string>'
      }
    ]
  })
};

fetch('https://eversince.ai/api/v1/tools/apply_layout', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "ok": true,
  "data": {},
  "meta": {
    "request_id": "<string>",
    "cost": {},
    "cloud_processing": {
      "ran_on": "cloud",
      "minutes": 123,
      "queued_minutes": 123,
      "left_minutes": 123,
      "bought_minutes": 123,
      "note": "<string>"
    }
  },
  "media": [
    {}
  ]
}

{
  "ok": false,
  "error": {
    "code": "<string>",
    "message": "<string>",
    "retryable": true,
    "suggested_action": "<string>",
    "cloud_processing": {
      "ran_on": "cloud",
      "minutes": 123,
      "queued_minutes": 123,
      "left_minutes": 123,
      "bought_minutes": 123,
      "note": "<string>"
    }
  }
}

Authorizations

Authorization

string

header

required

An API key (es_live_…) from Settings, under API keys, or an OAuth access token.

Headers

Idempotency-Key

string

Retry a paid dispatch safely: the same key returns the job already dispatched instead of charging again.

x-workspace-id

string

The workspace this one call acts in, when it is not the key's own.

Body

application/json

timeline_id

string

required

The timeline id.

layout

enum<string>

required

Available options:

split-h,

split-v,

pip-bottom-right,

pip-bottom-left,

pip-top-right,

pip-top-left,

main-sidebar,

row3,

stack3,

grid-2x2,

grid-3x3,

grid-4x4

slots

object[]

required

Minimum array length: 1

Show child attributes

fit

enum<string>

Available options:

fill,

fit

range

object

Placing items only: the span of the timeline the layout occupies, in seconds. Required with item, ignored with clip_id.

Show child attributes

if_revision

The revision get_timeline returned. A stale one fails with revision_conflict instead of applying; so does no revision once a user edited the timeline in the app since this connection last read it.

context

string

Optional: one sentence shown to the user beside this action.

Maximum string length: 600

Response

Done, or a job started for work that runs longer (follow it with get_jobs).

any

required

data

object

required

meta

object

required

Show child attributes

media

object[]

apply layout

curl --request POST \
  --url https://eversince.ai/api/v1/tools/apply_layout \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "timeline_id": "<string>",
  "slots": [
    {
      "slot": "<string>",
      "clip_id": "<string>",
      "clip_ids": [
        "<string>"
      ],
      "item": "<string>"
    }
  ]
}
'

import requests

url = "https://eversince.ai/api/v1/tools/apply_layout"

payload = {
    "timeline_id": "<string>",
    "slots": [
        {
            "slot": "<string>",
            "clip_id": "<string>",
            "clip_ids": ["<string>"],
            "item": "<string>"
        }
    ]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    timeline_id: '<string>',
    slots: [
      {
        slot: '<string>',
        clip_id: '<string>',
        clip_ids: ['<string>'],
        item: '<string>'
      }
    ]
  })
};

fetch('https://eversince.ai/api/v1/tools/apply_layout', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "ok": true,
  "data": {},
  "meta": {
    "request_id": "<string>",
    "cost": {},
    "cloud_processing": {
      "ran_on": "cloud",
      "minutes": 123,
      "queued_minutes": 123,
      "left_minutes": 123,
      "bought_minutes": 123,
      "note": "<string>"
    }
  },
  "media": [
    {}
  ]
}

{
  "ok": false,
  "error": {
    "code": "<string>",
    "message": "<string>",
    "retryable": true,
    "suggested_action": "<string>",
    "cloud_processing": {
      "ran_on": "cloud",
      "minutes": 123,
      "queued_minutes": 123,
      "left_minutes": 123,
      "bought_minutes": 123,
      "note": "<string>"
    }
  }
}

Discovery

Timeline

Workspace

Library

Canvas

Generation

Research

Account

Models

Uploads

Webhooks

apply layout

Authorizations

Headers

Body

Response