Skip to main content
POST
/
v1
/
videos
/
{id}
/
clips
/
{clipId}
/
layouts
Add a layout to a clip
curl --request POST \
  --url https://api.tella.com/v1/videos/{id}/clips/{clipId}/layouts \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "layout": {
    "kind": "fullscreen"
  },
  "durationMs": 123,
  "media": {
    "sourceId": "<string>",
    "type": "image"
  },
  "startTimeMs": 4503599627370495
}
'
import requests

url = "https://api.tella.com/v1/videos/{id}/clips/{clipId}/layouts"

payload = {
"layout": { "kind": "fullscreen" },
"durationMs": 123,
"media": {
"sourceId": "<string>",
"type": "image"
},
"startTimeMs": 4503599627370495
}
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({
layout: {kind: 'fullscreen'},
durationMs: 123,
media: {sourceId: '<string>', type: 'image'},
startTimeMs: 4503599627370495
})
};

fetch('https://api.tella.com/v1/videos/{id}/clips/{clipId}/layouts', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api.tella.com/v1/videos/{id}/clips/{clipId}/layouts",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'layout' => [
'kind' => 'fullscreen'
],
'durationMs' => 123,
'media' => [
'sourceId' => '<string>',
'type' => 'image'
],
'startTimeMs' => 4503599627370495
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"strings"
"net/http"
"io"
)

func main() {

url := "https://api.tella.com/v1/videos/{id}/clips/{clipId}/layouts"

payload := strings.NewReader("{\n \"layout\": {\n \"kind\": \"fullscreen\"\n },\n \"durationMs\": 123,\n \"media\": {\n \"sourceId\": \"<string>\",\n \"type\": \"image\"\n },\n \"startTimeMs\": 4503599627370495\n}")

req, _ := http.NewRequest("POST", url, payload)

req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://api.tella.com/v1/videos/{id}/clips/{clipId}/layouts")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"layout\": {\n \"kind\": \"fullscreen\"\n },\n \"durationMs\": 123,\n \"media\": {\n \"sourceId\": \"<string>\",\n \"type\": \"image\"\n },\n \"startTimeMs\": 4503599627370495\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.tella.com/v1/videos/{id}/clips/{clipId}/layouts")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"layout\": {\n \"kind\": \"fullscreen\"\n },\n \"durationMs\": 123,\n \"media\": {\n \"sourceId\": \"<string>\",\n \"type\": \"image\"\n },\n \"startTimeMs\": 4503599627370495\n}"

response = http.request(request)
puts response.read_body
{
  "layout": {
    "id": "<string>",
    "media": [
      {
        "height": 0,
        "imageUrl": "<string>",
        "sourceId": "<string>",
        "width": 0
      }
    ],
    "durationMs": 5000,
    "layout": {
      "kind": "fullscreen"
    },
    "startTimeMs": 0
  }
}
{
"error": {
"code": "bad_request",
"doc_url": "https://tella.tv/docs/api-reference/errors#bad-request",
"message": "The request was malformed or contained invalid parameters."
}
}
{
"error": {
"code": "unauthorized",
"doc_url": "https://tella.tv/docs/api-reference/errors#unauthorized",
"message": "Authentication is required. Provide a valid API key."
}
}
{
"error": {
"code": "forbidden",
"doc_url": "https://tella.tv/docs/api-reference/errors#forbidden",
"message": "You don't have permission to access this resource."
}
}
{
"error": {
"code": "not_found",
"doc_url": "https://tella.tv/docs/api-reference/errors#not-found",
"message": "The requested resource was not found."
}
}
{
"error": {
"code": "unprocessable_entity",
"doc_url": "https://tella.tv/docs/api-reference/errors#unprocessable-entity",
"message": "The request was well-formed but contained semantic errors."
}
}
{
"error": {
"code": "rate_limit_exceeded",
"doc_url": "https://tella.tv/docs/api-reference/errors#rate-limit-exceeded",
"message": "You have exceeded the rate limit. Please slow down."
}
}
{
"error": {
"code": "internal_server_error",
"doc_url": "https://tella.tv/docs/api-reference/errors#internal-server-error",
"message": "An unexpected error occurred on the server."
}
}

Authorizations

Authorization
string
header
required

API key obtained from your Tella account settings

Path Parameters

id
string
required

Video identifier

Example:

"vid_abc123def456"

clipId
string
required

Clip identifier

Example:

"cl_xyz789ghi012"

Body

application/json

Add a layout to a clip

layout
Fullscreen · object
required

Single-layer fullscreen. Camera-subject clips take an optional style (regular/stretch); basic-subject clips take an optional screenFit.

durationMs
integer

Optional. Provide together with startTimeMs for a time-ranged layout.

Required range: x <= 9007199254740991
media
ClipMediaImage · object

Optional media content to show during this layout. Only valid on time-ranged layouts.

startTimeMs
integer

Optional. Provide together with durationMs for a time-ranged layout. In ms on the clip's playback timeline (cuts applied).

Required range: 0 <= x <= 9007199254740991
transitionStyle
enum<string>

Optional. Only valid on time-ranged layouts. Defaults to the clip's setting when omitted.

Available options:
spring,
hardCut

Response

OK

A layout on a clip

layout
object
required

A layout attached to a clip. Times are in ms on the clip's playback timeline (cuts applied). Internally the layout stays anchored to the footage, so it doesn't drift when cuts change later.