Skip to main content
PATCH
/
v1
/
videos
/
{id}
/
clips
/
{clipId}
/
zooms
/
{zoomId}
Update a zoom
curl --request PATCH \
  --url https://api.tella.com/v1/videos/{id}/clips/{clipId}/zooms/{zoomId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "durationMs": 123,
  "scale": 2,
  "startTimeMs": 4503599627370495,
  "type": "manualZoom"
}
'
import requests

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

payload = {
"durationMs": 123,
"scale": 2,
"startTimeMs": 4503599627370495,
"type": "manualZoom"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}

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

print(response.text)
const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({durationMs: 123, scale: 2, startTimeMs: 4503599627370495, type: 'manualZoom'})
};

fetch('https://api.tella.com/v1/videos/{id}/clips/{clipId}/zooms/{zoomId}', 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}/zooms/{zoomId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'durationMs' => 123,
'scale' => 2,
'startTimeMs' => 4503599627370495,
'type' => 'manualZoom'
]),
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}/zooms/{zoomId}"

payload := strings.NewReader("{\n \"durationMs\": 123,\n \"scale\": 2,\n \"startTimeMs\": 4503599627370495,\n \"type\": \"manualZoom\"\n}")

req, _ := http.NewRequest("PATCH", 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.patch("https://api.tella.com/v1/videos/{id}/clips/{clipId}/zooms/{zoomId}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"durationMs\": 123,\n \"scale\": 2,\n \"startTimeMs\": 4503599627370495,\n \"type\": \"manualZoom\"\n}")
.asString();
require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"durationMs\": 123,\n \"scale\": 2,\n \"startTimeMs\": 4503599627370495,\n \"type\": \"manualZoom\"\n}"

response = http.request(request)
puts response.read_body
{
  "zoom": {
    "durationMs": 2000,
    "id": "ef_abc123",
    "startTimeMs": 1000,
    "type": "manualZoom",
    "focusPoint": {
      "xPct": 50,
      "yPct": 50
    },
    "scale": 2
  }
}
{
"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 ID

clipId
string
required

Clip ID

zoomId
string
required

Zoom ID

Body

application/json

Update an existing zoom

durationMs
integer
Required range: x <= 9007199254740991
focusPoint
object

Point on the screen recording to zoom into, expressed as percentages of the screen dimensions. Required for manualZoom; ignored for trackingZoom.

scale
number

Magnification factor (1 = no zoom, 3.5 = max).

Required range: 1 <= x <= 3.5
Example:

2

startTimeMs
integer

Start time in ms on the clip's playback timeline (cuts applied)

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

manualZoom zooms into a fixed focusPoint on the screen. trackingZoom automatically follows the cursor in the screen recording.

Available options:
manualZoom,
trackingZoom
Example:

"manualZoom"

Response

OK

A zoom on a clip

zoom
object
required

A zoom effect applied to the clip's screen layer (does not affect the camera). Use manualZoom with a focusPoint, or trackingZoom to follow the cursor automatically. Times are in ms on the clip's playback timeline (cuts applied). Internally the zoom stays anchored to the footage, so it doesn't drift when cuts change later.