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

Documentation Index

Fetch the complete documentation index at: https://tella.com/docs/llms.txt

Use this file to discover all available pages before exploring further.

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.

allowedEmbedDomains
string[]

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

Example:
["example.com", "mysite.org"]
captionsDefaultEnabled
boolean

Show subtitles/captions by default

Example:

true

commentEmailsEnabled
boolean

Send email notifications for new comments

Example:

false

commentsEnabled
boolean

Allow viewers to comment

Example:

true

customThumbnailURL
string<uri>

Custom thumbnail image URL

Example:

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

defaultPlaybackRate
number

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

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

1

description
string

Video description

Maximum string length: 5000
Example:

"Updated description for the video"

downloadsEnabled
boolean

Allow viewers to download the video

Example:

true

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"

name
string

Video title

Required string length: 1 - 255
Example:

"Updated Video Title"

password
string

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

Required string length: 1 - 255
Example:

"secretpassword"

publishDateEnabled
boolean

Show publish date on video page

Example:

true

rawDownloadsEnabled
boolean

Allow viewers to download raw source files

Example:

false

searchEngineIndexingEnabled
boolean

Allow search engines to index the video page

Example:

true

transcriptsEnabled
boolean

Show transcript panel to viewers

Example:

true

viewCountEnabled
boolean

Show view count on video page

Example:

true

Response

OK

video
object
required

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