Skip to main content
PATCH
/
v1
/
videos
/
{id}
Update a video
curl --request PATCH \
  --url https://api.tella.com/v1/videos/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Updated Video Title",
  "description": "Updated description for the video",
  "defaultPlaybackRate": 1,
  "captionsDefaultEnabled": true,
  "transcriptsEnabled": true,
  "publishDateEnabled": true,
  "viewCountEnabled": true,
  "commentsEnabled": true,
  "commentEmailsEnabled": false,
  "downloadsEnabled": true,
  "rawDownloadsEnabled": false,
  "linkScope": "public",
  "password": "secretpassword",
  "searchEngineIndexingEnabled": true,
  "allowedEmbedDomains": [
    "example.com",
    "mysite.org"
  ],
  "customThumbnailURL": "https://example.com/custom-thumbnail.jpg"
}
'
{
  "video": {
    "id": "vid_abc123def456",
    "name": "Getting Started with Tella",
    "description": "Learn how to create and share your first video",
    "views": 1234,
    "aspectRatio": "16:9",
    "createdAt": "2024-01-15T10:30:00.000Z",
    "updatedAt": "2024-01-15T14:45:00.000Z",
    "durationSeconds": 125.5,
    "chapters": [
      {
        "id": "ch_abc123",
        "title": "Introduction",
        "description": "Overview of what we'll cover",
        "timestampSeconds": 0
      }
    ],
    "transcript": {
      "status": "ready",
      "language": "en",
      "text": "Hello and welcome to this tutorial...",
      "sentences": [
        {
          "text": "Hello and welcome to this tutorial.",
          "startSeconds": 0.5,
          "endSeconds": 2.3
        }
      ]
    },
    "thumbnails": {
      "xl": {
        "jpg": "https://cdn.tella.tv/thumbnails/vid_abc123/1920x1080.jpg",
        "webp": "https://cdn.tella.tv/thumbnails/vid_abc123/1920x1080.webp",
        "gif": "https://cdn.tella.tv/thumbnails/vid_abc123/640x360.gif",
        "mp4": "https://cdn.tella.tv/thumbnails/vid_abc123/640x360.mp4"
      },
      "large": {
        "jpg": "https://cdn.tella.tv/thumbnails/vid_abc123/1920x1080.jpg",
        "webp": "https://cdn.tella.tv/thumbnails/vid_abc123/1920x1080.webp",
        "gif": "https://cdn.tella.tv/thumbnails/vid_abc123/640x360.gif",
        "mp4": "https://cdn.tella.tv/thumbnails/vid_abc123/640x360.mp4"
      },
      "medium": {
        "jpg": "https://cdn.tella.tv/thumbnails/vid_abc123/1920x1080.jpg",
        "webp": "https://cdn.tella.tv/thumbnails/vid_abc123/1920x1080.webp",
        "gif": "https://cdn.tella.tv/thumbnails/vid_abc123/640x360.gif",
        "mp4": "https://cdn.tella.tv/thumbnails/vid_abc123/640x360.mp4"
      },
      "small": {
        "jpg": "https://cdn.tella.tv/thumbnails/vid_abc123/1920x1080.jpg",
        "webp": "https://cdn.tella.tv/thumbnails/vid_abc123/1920x1080.webp",
        "gif": "https://cdn.tella.tv/thumbnails/vid_abc123/640x360.gif",
        "mp4": "https://cdn.tella.tv/thumbnails/vid_abc123/640x360.mp4"
      }
    },
    "exports": [
      {
        "exportId": "exp_abc123def456",
        "status": "completed",
        "progress": 100,
        "downloadUrl": "https://cdn.tella.tv/exports/vid_abc123/video.mp4",
        "updatedAt": "2024-01-15T15:00:00.000Z"
      }
    ],
    "settings": {
      "defaultPlaybackRate": 1,
      "captionsDefaultEnabled": true,
      "transcriptsEnabled": true,
      "publishDateEnabled": true,
      "viewCountEnabled": true,
      "commentsEnabled": true,
      "commentEmailsEnabled": false,
      "downloadsEnabled": true,
      "rawDownloadsEnabled": false,
      "linkScope": "public",
      "searchEngineIndexingEnabled": true,
      "allowedEmbedDomains": [
        "example.com",
        "mysite.org"
      ],
      "customThumbnailURL": "https://example.com/custom-thumbnail.jpg"
    },
    "links": {
      "viewPage": "https://www.tella.tv/video/vid_abc123def456/view",
      "embedPage": "https://www.tella.tv/video/vid_abc123def456/embed"
    },
    "playlistIds": [
      "pl_abc123",
      "pl_def456"
    ]
  }
}

Authorizations

​
Authorization
string
header
required

API key obtained from your Tella account settings

Path Parameters

​
id
string
required

Unique video identifier

Example:

"vid_abc123def456"

Body

application/json

Request body for updating a video. At least one field must be provided.

​
name
string

Video title

Required string length: 1 - 255
Example:

"Updated Video Title"

​
description
string

Video description

Maximum string length: 5000
Example:

"Updated description for the video"

​
defaultPlaybackRate
number

Default playback speed (0.5-2.0). Viewers can still adjust.

Required range: 0.5 <= x <= 2
Example:

1

​
captionsDefaultEnabled
boolean

Show subtitles/captions by default

Example:

true

​
transcriptsEnabled
boolean

Show transcript panel to viewers

Example:

true

​
publishDateEnabled
boolean

Show publish date on video page

Example:

true

​
viewCountEnabled
boolean

Show view count on video page

Example:

true

​
commentsEnabled
boolean

Allow viewers to comment

Example:

true

​
commentEmailsEnabled
boolean

Send email notifications for new comments

Example:

false

​
downloadsEnabled
boolean

Allow viewers to download the video

Example:

true

​
rawDownloadsEnabled
boolean

Allow viewers to download raw source files

Example:

false

​
linkScope
enum<string>

Access level: public (anyone with link), private (org members only), password (requires password), embedonly (only viewable when embedded)

Available options:
public,
private,
password,
embedonly
Example:

"public"

​
password
string

Password for viewing. Required when linkScope is 'password', ignored otherwise.

Required string length: 1 - 255
Example:

"secretpassword"

​
searchEngineIndexingEnabled
boolean

Allow search engines to index the video page

Example:

true

​
allowedEmbedDomains
string[]

Restrict embedding to these domains only (Premium feature). Empty array allows all domains.

Example:
["example.com", "mysite.org"]
​
customThumbnailURL
string<uri>

Custom thumbnail image URL

Example:

"https://example.com/custom-thumbnail.jpg"

Response

OK

​
video
object
required

Detailed information about a video including chapters, transcript, and exports