Tella API

https://docs.tella.com
Admin
The Tella Public API allows programmatic access to videos and playlists, including transcripts,...
Tokens:53,612
Snippets:249
Trust Score:10
Update:10 months ago
Show doc for...
Tokens:
Raw
### Get Video Details

Source: https://docs.tella.com/quickstart

This endpoint retrieves full details for a specific video, including its transcript. It requires the video ID and an API key for authentication.

```APIDOC
## GET /v1/videos/{id}

### Description
Retrieves full details for a specific video, including the transcript.

### Method
GET

### Endpoint
https://api.tella.com/v1/videos/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The unique identifier of the video.

#### Query Parameters
None

#### Request Body
None

### Request Example
```bash
curl -H "Authorization: Bearer tella_pk_your_api_key" \
  https://api.tella.com/v1/videos/abc123xyz
```

### Response
#### Success Response (200)
- **transcript** (string) - The transcript of the video.
(Other video details are also returned)

#### Response Example
```json
{
  "id": "abc123xyz",
  "name": "Product Demo",
  "description": "A walkthrough of our new feature",
  "views": 1234,
  "durationSeconds": 125.5,
  "aspectRatio": "16:9",
  "createdAt": "2024-01-15T10:30:00Z",
  "updatedAt": "2024-01-15T10:30:00Z",
  "links": {
    "viewPage": "https://www.tella.tv/video/abc123xyz/view",
    "embedPage": "https://www.tella.tv/video/abc123xyz/embed"
  },
  "transcript": "This is the full transcript of the video..."
}
```
```

--------------------------------

### Get specific video details using cURL and JavaScript

Source: https://docs.tella.com/quickstart

This snippet shows how to retrieve full details for a specific video, including its transcript, using cURL and JavaScript. It requires the video's ID and an API key for authentication, targeting the `/v1/videos/{video_id}` endpoint. The response contains detailed video information.

```cURL
curl -H "Authorization: Bearer tella_pk_your_api_key" \
    https://api.tella.com/v1/videos/abc123xyz
```

```javascript
const response = await fetch("https://api.tella.com/v1/videos/abc123xyz", {
  headers: {
    Authorization: "Bearer tella_pk_your_api_key",
  },
});

const video = await response.json();
console.log(video.transcript);
```

--------------------------------

### Custom Video Controller Example

Source: https://docs.tella.com/embed-api

An example demonstrating how to build a custom video controller for Tella videos using JavaScript and iframe messaging.

```APIDOC
## Complete Example

Here's a complete example showing how to build a custom video controller:

```html
<!DOCTYPE html>
<html>
  <head>
    <title>Custom Tella Player</title>
  </head>
  <body>
    <iframe
      id="player"
      src="https://www.tella.tv/video/YOUR_VIDEO_ID/embed"
      width="640"
      height="360"
      allow="autoplay; fullscreen"
    ></iframe>

    <div id="controls" style="display: none;">
      <button id="playBtn">Play</button>
      <button id="pauseBtn">Pause</button>
      <input type="range" id="progress" min="0" max="100" value="0" />
      <span id="time">0:00 / 0:00</span>
    </div>

    <script>
      const iframe = document.getElementById("player");
      const controls = document.getElementById("controls");
      const progress = document.getElementById("progress");
      const timeDisplay = document.getElementById("time");

      let duration = 0;
      const origin = "https://www.tella.tv";

      function formatTime(seconds) {
        const mins = Math.floor(seconds / 60);
        const secs = Math.floor(seconds % 60);
        return `${mins}:${secs.toString().padStart(2, "0")}`;
      }

      function send(message) {
        iframe.contentWindow.postMessage(message, origin);
      }

      // Listen for events from the player
      window.addEventListener("message", (event) => {
        if (event.origin !== origin) return;

        switch (event.data.type) {
          case "ready":
            controls.style.display = "block";
            break;

          case "playbackState":
          case "timeUpdate":
            duration = event.data.duration;
            const current = event.data.currentTime;
            progress.value = (current / duration) * 100;
            timeDisplay.textContent = `${formatTime(current)} / ${formatTime(
              duration,
            )}`;
            break;
        }
      });

      // Wire up controls
      document.getElementById("playBtn").onclick = () => send({ type: "play" });
      document.getElementById("pauseBtn").onclick = () =>
        send({ type: "pause" });

      progress.addEventListener("change", () => {
        const time = (progress.value / 100) * duration;
        send({ type: "seek", time });
      });
    </script>
  </body>
</html>
```
```

--------------------------------

### Start Video Export

Source: https://docs.tella.com/api-reference/videos/start-a-video-export

Starts an export of the specified video. Returns the export status including download URL when completed.

```APIDOC
## POST /websites/tella/exports

### Description
Starts an export of the specified video. Returns the export status including download URL when completed.

### Method
POST

### Endpoint
/websites/tella/exports

### Parameters
#### Request Body
- **video_id** (string) - Required - The ID of the video to export.

### Request Example
```json
{
  "video_id": "clj2p74j600023opq5j45p6f8"
}
```

### Response
#### Success Response (200)
- **export_id** (string) - The ID of the export job.
- **status** (string) - The current status of the export (e.g., "processing", "completed", "failed").
- **download_url** (string, optional) - The URL to download the exported video if the status is "completed".

#### Response Example
```json
{
  "export_id": "cle1b3h8j00000opq5j45p6f8",
  "status": "completed",
  "download_url": "https://example.com/exports/video.mp4"
}
```
```

--------------------------------

### List Videos

Source: https://docs.tella.com/quickstart

This endpoint allows you to list all videos in your workspace. It requires an API key for authentication.

```APIDOC
## GET /v1/videos

### Description
Lists all videos in your workspace.

### Method
GET

### Endpoint
https://api.tella.com/v1/videos

### Parameters
#### Query Parameters
None

#### Request Body
None

### Request Example
```bash
curl -H "Authorization: Bearer tella_pk_your_api_key" \
  https://api.tella.com/v1/videos
```

### Response
#### Success Response (200)
- **videos** (array) - An array of video objects.
- **pagination** (object) - Pagination details.

#### Response Example
```json
{
  "videos": [
    {
      "id": "abc123xyz",
      "name": "Product Demo",
      "description": "A walkthrough of our new feature",
      "views": 1234,
      "durationSeconds": 125.5,
      "aspectRatio": "16:9",
      "createdAt": "2024-01-15T10:30:00Z",
      "updatedAt": "2024-01-15T10:30:00Z",
      "links": {
        "viewPage": "https://www.tella.tv/video/abc123xyz/view",
        "embedPage": "https://www.tella.tv/video/abc123xyz/embed"
      }
    }
  ],
  "pagination": {
    "nextCursor": null,
    "hasMore": false
  }
}
```
```

--------------------------------

### POST /v1/videos/{id}/exports

Source: https://docs.tella.com/api-reference/videos/start-a-video-export

Starts an export of the specified video. Returns the export status including download URL when completed.

```APIDOC
## POST /v1/videos/{id}/exports

### Description
Starts an export of the specified video. Returns the export status including download URL when completed.

### Method
POST

### Endpoint
/v1/videos/{id}/exports

### Parameters
#### Path Parameters
- **id** (string) - Required - Unique video identifier

#### Request Body
- **format** (string) - Required - The desired export format (e.g., "mp4", "webm").
- **quality** (string) - Optional - The desired video quality (e.g., "720p", "1080p").

### Request Example
```json
{
  "format": "mp4",
  "quality": "1080p"
}
```

### Response
#### Success Response (200)
- **id** (string) - The unique identifier for the export job.
- **status** (string) - The current status of the export (e.g., "processing", "completed", "failed").
- **download_url** (string) - The URL to download the exported video (available when status is "completed").
- **created_at** (string) - The timestamp when the export job was created.

#### Response Example
```json
{
  "id": "exp_xyz789",
  "status": "completed",
  "download_url": "https://cdn.tella.com/exports/vid_abc123def456/export_xyz789.mp4",
  "created_at": "2023-10-27T10:00:00Z"
}
```

#### Error Responses
- **400 Bad Request**: The request was malformed or contained invalid parameters.
- **401 Unauthorized**: Authentication is required. Provide a valid API key.
- **403 Forbidden**: You don't have permission to access this resource.
- **404 Not Found**: The requested resource was not found.
- **422 Unprocessable Entity**: The request was well-formed but contained semantic errors.
- **429 Too Many Requests**: You have exceeded the rate limit. Please slow down.
- **500 Internal Server Error**: An unexpected error occurred on the server.
```

--------------------------------

### List all videos using cURL, JavaScript, and Python

Source: https://docs.tella.com/quickstart

This snippet demonstrates how to list all videos in your Tella workspace using cURL, JavaScript (fetch API), and Python (requests library). It requires an API key for authentication and targets the `/v1/videos` endpoint. The output is a JSON object containing a list of videos and pagination information.

```cURL
curl -H "Authorization: Bearer tella_pk_your_api_key" \
    https://api.tella.com/v1/videos
```

```javascript
const response = await fetch("https://api.tella.com/v1/videos", {
  headers: {
    Authorization: "Bearer tella_pk_your_api_key",
  },
});

const data = await response.json();
console.log(data);
```

```python
import requests

response = requests.get(
    'https://api.tella.com/v1/videos',
    headers={'Authorization': 'Bearer tella_pk_your_api_key'}
)

print(response.json())
```

--------------------------------

### Example API Request using cURL

Source: https://docs.tella.com/authentication

Demonstrates how to make an API request to fetch videos using cURL, including the 'Authorization' header with your API key.

```bash
curl -H "Authorization: Bearer tella_pk_your_api_key" \
  https://api.tella.com/v1/videos
```

--------------------------------

### GET /v1/videos/{id}

Source: https://docs.tella.com/api-reference/videos/get-video-information

Retrieves detailed information about a specific video, including its chapters, transcript, and thumbnails.

```APIDOC
## GET /v1/videos/{id}

### Description
Returns detailed information about a video including chapters, transcript, and thumbnails.

### Method
GET

### Endpoint
/v1/videos/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - Unique video identifier

### Request Example
```json
{
  "example": "Not applicable for GET request"
}
```

### Response
#### Success Response (200)
- **video** (object) - Contains detailed video information, including chapters, transcript, and thumbnails.

#### Response Example
```json
{
  "video": {
    "id": "vid_abc123def456",
    "title": "My Awesome Video",
    "description": "This is a sample video description.",
    "duration": 3600,
    "created_at": "2023-10-27T10:00:00Z",
    "thumbnail_url": "https://api.tella.com/thumbnails/vid_abc123def456.jpg",
    "chapters": [
      {
        "timestamp": 60,
        "title": "Introduction"
      },
      {
        "timestamp": 120,
        "title": "Main Content"
      }
    ],
    "transcript": [
      {
        "timestamp": 1.5,
        "text": "Hello and welcome to this video."
      },
      {
        "timestamp": 5.2,
        "text": "Today we will be discussing the Tella API."
      }
    ]
  }
}
```

#### Error Responses
- **400 Bad Request**: The request was malformed or contained invalid parameters.
- **401 Unauthorized**: Authentication is required. Provide a valid API key.
- **403 Forbidden**: You don't have permission to access this resource.
- **404 Not Found**: The requested resource was not found.
- **422 Unprocessable Entity**: The request was well-formed but contained semantic errors.
- **429 Too Many Requests**: You have exceeded the rate limit. Please slow down.
```

--------------------------------

### GET /v1/playlists/{id}

Source: https://docs.tella.com/api-reference/playlists/get-playlist-details

Retrieves detailed information about a specific playlist, including all associated videos.

```APIDOC
## GET /v1/playlists/{id}

### Description
Returns detailed information about a playlist including its videos.

### Method
GET

### Endpoint
`/v1/playlists/{id}`

### Parameters
#### Path Parameters
- **id** (string) - Required - Unique playlist identifier

### Request Example
```json
{
  "example": ""
}
```

### Response
#### Success Response (200)
- **playlist** (object) - Details of the playlist

#### Response Example
```json
{
  "example": "{
  \"playlist\": { /* PlaylistDetail object */ }
}"
}
```

#### Error Responses
- **400**: Bad Request - The request was malformed or contained invalid parameters.
- **401**: Unauthorized - Authentication is required. Provide a valid API key.
- **403**: Forbidden - You don't have permission to access this resource.
- **404**: Not Found - The requested resource was not found.
- **422**: Unprocessable Entity - The request was well-formed but contained semantic errors.
- **429**: Too Many Requests - You have exceeded the rate limit. Please slow down.
- **500**: Internal Server Error - An unexpected error occurred on the server.
```

--------------------------------

### Using Environment Variables for API Keys

Source: https://docs.tella.com/authentication

This example shows how to set your Tella API key as an environment variable and use it in a cURL request, promoting secure key management.

```bash
# Set the environment variable
export TELLA_API_KEY="tella_pk_your_api_key"

# Use it in your code
curl -H "Authorization: Bearer $TELLA_API_KEY" \
  https://api.tella.com/v1/videos
```

--------------------------------

### Customizing Tella Embed URL Parameters (HTML)

Source: https://docs.tella.com/embed-api

This example shows how to use URL parameters within the iframe `src` attribute to customize the Tella video player's initial behavior. Parameters like `autoPlay`, `loop`, `muted`, and `t` (start time) can be appended to the embed URL to control playback. This allows for pre-configured video playback settings directly from the embed code.

```html
<!-- Auto-play muted, starting at 30 seconds -->
<iframe
  src="https://www.tella.tv/video/ID/embed?autoPlay=true&muted=1&t=30"
></iframe>
```

--------------------------------

### Complete Custom Tella Video Controller Example (HTML, JavaScript)

Source: https://docs.tella.com/embed-api

This snippet demonstrates a full implementation of a custom video controller. It embeds a Tella video player in an iframe and uses JavaScript to listen for player events and send commands back to the player. It includes basic controls like play, pause, progress tracking, and time display. Dependencies include the Tella player iframe and basic HTML elements for controls. Outputs are UI updates and player control.

```html
<!DOCTYPE html>
<html>
  <head>
    <title>Custom Tella Player</title>
  </head>
  <body>
    <iframe
      id="player"
      src="https://www.tella.tv/video/YOUR_VIDEO_ID/embed"
      width="640"
      height="360"
      allow="autoplay; fullscreen"
    ></iframe>

    <div id="controls" style="display: none;">
      <button id="playBtn">Play</button>
      <button id="pauseBtn">Pause</button>
      <input type="range" id="progress" min="0" max="100" value="0" />
      <span id="time">0:00 / 0:00</span>
    </div>

    <script>
      const iframe = document.getElementById("player");
      const controls = document.getElementById("controls");
      const progress = document.getElementById("progress");
      const timeDisplay = document.getElementById("time");

      let duration = 0;
      const origin = "https://www.tella.tv";

      function formatTime(seconds) {
        const mins = Math.floor(seconds / 60);
        const secs = Math.floor(seconds % 60);
        return `${mins}:${secs.toString().padStart(2, "0")}`;
      }

      function send(message) {
        iframe.contentWindow.postMessage(message, origin);
      }

      // Listen for events from the player
      window.addEventListener("message", (event) => {
        if (event.origin !== origin) return;

        switch (event.data.type) {
          case "ready":
            controls.style.display = "block";
            break;

          case "playbackState":
          case "timeUpdate":
            duration = event.data.duration;
            const current = event.data.currentTime;
            progress.value = (current / duration) * 100;
            timeDisplay.textContent = `${formatTime(current)} / ${formatTime(
              duration,
            )}`;
            break;
        }
      });

      // Wire up controls
      document.getElementById("playBtn").onclick = () => send({ type: "play" });
      document.getElementById("pauseBtn").onclick = () =>
        send({ type: "pause" });

      progress.addEventListener("change", () => {
        const time = (progress.value / 100) * duration;
        send({ type: "seek", time });
      });
    </script>
  </body>
</html>

```

--------------------------------

### JavaScript: Efficiently Fetch Data in Batches using Pagination

Source: https://docs.tella.com/rate-limiting

This JavaScript example demonstrates how to efficiently fetch multiple resources, such as videos, by leveraging API pagination. Instead of making individual requests for each item, it uses a cursor to retrieve data in batches, reducing the total number of API calls.

```javascript
// Instead of fetching videos one by one
// Fetch them in batches using the list endpoint
let cursor = null;
const allVideos = [];

do {
  const url = cursor
    ? `https://api.tella.com/v1/videos?cursor=${cursor}`
    : 'https://api.tella.com/v1/videos';

  const response = await fetch(url, { headers });
  const data = await response.json();

  allVideos.push(...data.data);
  cursor = data.pagination.next_cursor;
} while (cursor);
```

--------------------------------

### Get Video Information

Source: https://docs.tella.com/api-reference/videos/get-video-information

Retrieves detailed information about a specific video, including its chapters, transcript, and thumbnails.

```APIDOC
## GET /websites/tella/video

### Description
Returns detailed information about a video including chapters, transcript, and thumbnails.

### Method
GET

### Endpoint
/websites/tella/video

### Parameters
#### Query Parameters
- **videoId** (string) - Required - The unique identifier for the video.

### Response
#### Success Response (200)
- **title** (string) - The title of the video.
- **chapters** (array) - An array of chapter objects, each containing a title and start time.
- **transcript** (array) - An array of transcript objects, each containing a timestamp and text.
- **thumbnails** (object) - An object containing different sizes of video thumbnails.

#### Response Example
```json
{
  "title": "Introduction to Tella",
  "chapters": [
    { "title": "What is Tella?", "startTime": "00:00" },
    { "title": "Key Features", "startTime": "01:30" }
  ],
  "transcript": [
    { "timestamp": "00:00", "text": "Hello and welcome to Tella." },
    { "timestamp": "00:05", "text": "In this video, we'll explore the core functionalities..." }
  ],
  "thumbnails": {
    "small": "https://example.com/thumbnails/small.jpg",
    "large": "https://example.com/thumbnails/large.jpg"
  }
}
```
```

--------------------------------

### Get Video Details

Source: https://docs.tella.com/api-reference/videos/duplicate-a-video

Retrieves detailed information about a specific video, including its chapters, transcript, and export status.

```APIDOC
## GET /websites/tella/videos/{video_id}

### Description
Fetches detailed information for a specific video.

### Method
GET

### Endpoint
/websites/tella/videos/{video_id}

### Parameters
#### Path Parameters
- **video_id** (string) - Required - The unique identifier of the video.

#### Query Parameters
None

#### Request Body
None

### Request Example
```json
(No request body for GET requests)
```

### Response
#### Success Response (200)
- **id** (string) - Unique video identifier.
- **name** (string) - Video title.
- **description** (string) - Video description.
- **views** (integer) - Total view count.
- **aspectRatio** (string) - Video aspect ratio (e.g., '16:9', '9:16').
- **createdAt** (string) - ISO 8601 datetime.
- **updatedAt** (string) - ISO 8601 datetime.
- **durationSeconds** (number) - Video duration in seconds.
- **chapters** (array) - Video chapters/sections.
- **transcript** (object) - Video transcript data.
- **thumbnails** (object) - Available thumbnail URLs by format and resolution.
- **exports** (array) - Available exports and their status.
- **settings** (object) - Video playback and access settings.
- **links** (object) - Related URLs for the video.
- **playlistIds** (array) - IDs of playlists containing this video.

#### Response Example
```json
{
  "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": [
    {
      "startTime": 0,
      "endTime": 30,
      "title": "Introduction"
    }
  ],
  "transcript": {
    "segments": [
      {
        "startTime": 0,
        "endTime": 5,
        "text": "Hello and welcome."
      }
    ]
  },
  "thumbnails": {
    "default": {
      "url": "https://example.com/thumbnails/default.jpg",
      "width": 320,
      "height": 180
    },
    "high": {
      "url": "https://example.com/thumbnails/high.jpg",
      "width": 1280,
      "height": 720
    }
  },
  "exports": [
    {
      "format": "mp4",
      "url": "https://example.com/exports/vid_abc123def456.mp4",
      "status": "completed"
    }
  ],
  "settings": {
    "is_private": false,
    "allow_embedding": true
  },
  "links": {
    "view": "https://tella.tv/video/vid_abc123def456",
    "edit": "https://app.tella.tv/editor/vid_abc123def456"
  },
  "playlistIds": [
    "pl_abc123",
    "pl_def456"
  ]
}
```

### Error Handling
- **500 Internal Server Error**: An unexpected error occurred on the server.
```

--------------------------------

### GET /v1/webhooks/messages/{id}

Source: https://docs.tella.com/api-reference/webhooks/get-a-specific-webhook-message

Retrieves details of a specific webhook message using its unique ID.

```APIDOC
## GET /v1/webhooks/messages/{id}

### Description
Returns details of a specific webhook message by ID.

### Method
GET

### Endpoint
/v1/webhooks/messages/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The webhook message ID. Example: msg_abc123

### Request Example
(No request body for GET requests)

### Response
#### Success Response (200)
- **WebhookMessage** (object) - Schema reference for a webhook message object.

#### Error Response (400)
- **ErrorResponse** (object) - Schema reference for an error response object.
  Example:
  ```json
  {
    "error": {
      "code": "bad_request",
      "message": "The request was malformed or contained invalid parameters.",
      "doc_url": "https://tella.tv/docs/api-reference/errors#bad-request"
    }
  }
  ```

#### Error Response (401)
- **ErrorResponse** (object) - Schema reference for an error response object.
  Example:
  ```json
  {
    "error": {
      "code": "unauthorized",
      "message": "Authentication is required. Provide a valid API key.",
      "doc_url": "https://tella.tv/docs/api-reference/errors#unauthorized"
    }
  }
  ```

#### Error Response (403)
- **ErrorResponse** (object) - Schema reference for an error response object.
  Example:
  ```json
  {
    "error": {
      "code": "forbidden",
      "message": "You don't have permission to access this resource.",
      "doc_url": "https://tella.tv/docs/api-reference/errors#forbidden"
    }
  }
  ```

#### Error Response (404)
- **ErrorResponse** (object) - Schema reference for an error response object.
  Example:
  ```json
  {
    "error": {
      "code": "not_found",
      "message": "The requested resource was not found.",
      "doc_url": "https://tella.tv/docs/api-reference/errors#not-found"
    }
  }
  ```

#### Error Response (422)
- **ErrorResponse** (object) - Schema reference for an error response object.
  Example:
  ```json
  {
    "error": {
      "code": "unprocessable_entity",
      "message": "The request was well-formed but contained semantic errors.",
      "doc_url": "https://tella.tv/docs/api-reference/errors#unprocessable-entity"
    }
  }
  ```

#### Error Response (429)
- **ErrorResponse** (object) - Schema reference for an error response object.
  Example:
  ```json
  {
    "error": {
      "code": "rate_limit_exceeded",
      "message": "You have exceeded the rate limit. Please slow down.",
      "doc_url": "https://tella.tv/docs/api-reference/errors#rate-limit-exceeded"
    }
  }
  ```

#### Error Response (500)
- **ErrorResponse** (object) - Schema reference for an error response object.
  Example:
  ```json
  {
    "error": {
      "code": "internal_server_error",
      "message": "An unexpected error occurred on the server.",
      "doc_url": "https://tella.tv/docs/api-reference/errors#internal-server-error"
    }
  }
  ```

#### Response Example (200)
(Example for WebhookMessage schema would be placed here)
```

--------------------------------

### Get Webhook Message by ID

Source: https://docs.tella.com/api-reference/webhooks/get-a-specific-webhook-message

Retrieves the details of a specific webhook message using its unique ID.

```APIDOC
## GET /websites/tella/webhooks/{message_id}

### Description
Returns details of a specific webhook message by ID.

### Method
GET

### Endpoint
/websites/tella/webhooks/{message_id}

### Parameters
#### Path Parameters
- **message_id** (string) - Required - The unique identifier of the webhook message.

### Response
#### Success Response (200)
- **id** (string) - The unique identifier of the webhook message.
- **event_type** (string) - The type of event that triggered the webhook.
- **payload** (object) - The data associated with the webhook event.
- **created_at** (string) - The timestamp when the webhook message was created.

#### Response Example
```json
{
  "id": "msg_abc123xyz",
  "event_type": "user.created",
  "payload": {
    "user_id": "usr_456def",
    "username": "johndoe"
  },
  "created_at": "2023-10-27T10:00:00Z"
}
```
```

--------------------------------

### Create Playlist API

Source: https://docs.tella.com/api-reference/playlists/create-a-new-playlist

This endpoint allows users to create a new playlist with specified details such as name, description, and visibility settings.

```APIDOC
## POST /websites/tella/playlists

### Description
Creates a new playlist with the provided details.

### Method
POST

### Endpoint
/websites/tella/playlists

### Parameters
#### Request Body
- **name** (string) - Required - Playlist name (1-255 characters).
- **description** (string) - Optional - Playlist description (max 5000 characters).
- **emoji** (string) - Optional - Unicode emoji character for the playlist (max 10 characters).
- **linkScope** (PlaylistLinkScope) - Optional - Access level for the playlist (default: public).
- **password** (string) - Optional - Password for viewing. Required when linkScope is 'password'. (1-255 characters).
- **searchEngineIndexingEnabled** (boolean) - Optional - Allow search engine indexing (default: false).
- **visibility** (PlaylistVisibility) - Optional - Share with organization or keep personal (default: personal).

### Request Example
```json
{
  "name": "Product Tutorials",
  "description": "A collection of tutorial videos",
  "emoji": "🎬",
  "linkScope": "public",
  "password": "secretpassword",
  "searchEngineIndexingEnabled": false,
  "visibility": "org"
}
```

### Response
#### Success Response (201)
- **PlaylistDetail** (object) - Details of the newly created playlist.

#### Response Example
```json
{
  "id": "pl_abc123def456",
  "name": "Product Tutorials",
  "description": "A collection of tutorial videos for our product",
  "emoji": "🎬",
  "videos": 0,
  "linkScope": "public",
  "searchEngineIndexingEnabled": true,
  "visibility": "org",
  "createdAt": "2024-01-15T10:30:00.000Z",
  "updatedAt": "2024-01-15T14:45:00.000Z",
  "links": {
    "self": "/playlists/pl_abc123def456"
  }
}
```

#### Error Response
- **ErrorResponse** (object) - Standard error response format.
```

--------------------------------

### POST /websites/tella/playlists

Source: https://docs.tella.com/api-reference/playlists/create-a-new-playlist

Creates a new playlist for the authenticated user. This endpoint allows users to define a new playlist with a given name and description.

```APIDOC
## POST /websites/tella/playlists

### Description
Creates a new playlist for the authenticated user.

### Method
POST

### Endpoint
/websites/tella/playlists

### Parameters
#### Request Body
- **name** (string) - Required - The name of the playlist.
- **description** (string) - Optional - A description for the playlist.

### Request Example
```json
{
  "name": "My Awesome Playlist",
  "description": "A collection of my favorite songs"
}
```

### Response
#### Success Response (201)
- **id** (string) - The unique identifier for the newly created playlist.
- **name** (string) - The name of the playlist.
- **description** (string) - The description of the playlist.
- **createdAt** (string) - The timestamp when the playlist was created.

#### Response Example
```json
{
  "id": "pl_abc123",
  "name": "My Awesome Playlist",
  "description": "A collection of my favorite songs",
  "createdAt": "2023-10-27T10:00:00Z"
}
```
```

--------------------------------

### Get a Specific Webhook Message

Source: https://docs.tella.com/webhooks

Retrieves details of a specific webhook message by its ID.

```APIDOC
## GET /v1/webhooks/messages/{id}

### Description
Retrieves the details of a specific webhook message using its unique identifier.

### Method
GET

### Endpoint
https://api.tella.com/v1/webhooks/messages/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The unique identifier of the webhook message.

### Request Example
```bash
curl https://api.tella.com/v1/webhooks/messages/{id} \
  -H "Authorization: Bearer YOUR_API_KEY"
```

### Response
#### Success Response (200)
- **id** (string) - The unique identifier of the webhook message.
- **eventType** (string) - The type of the event that triggered the webhook.
- **timestamp** (string) - The timestamp when the event occurred.
- **payload** (object) - The actual data payload of the webhook event.

#### Response Example
```json
{
  "id": "msg_xyz789",
  "eventType": "video.created",
  "timestamp": "2023-10-27T10:00:00Z",
  "payload": {
    "videoId": "vid_12345",
    "workspaceId": "ws_abcde"
  }
}
```
```

--------------------------------

### Configure Tella MCP Server for Claude Desktop

Source: https://docs.tella.com/mcp-server

This JSON configuration snippet integrates the Tella MCP server into Claude Desktop. It specifies the command to run (`npx`) and its arguments, including the remote MCP URL, allowing AI assistants to access your Tella workspace.

```json
{
  "mcpServers": {
    "tella": {
      "command": "npx",
      "args": [
        "mcp-remote",
        "https://api.tella.com/mcp"
      ]
    }
  }
}
```

--------------------------------

### Get Playlist Details

Source: https://docs.tella.com/api-reference/playlists/get-playlist-details

Retrieves detailed information about a specific playlist, including a list of its videos. This endpoint is useful for displaying playlist content to users.

```APIDOC
## GET /websites/tella/playlists/{playlist_id}

### Description
Returns detailed information about a playlist including its videos.

### Method
GET

### Endpoint
/websites/tella/playlists/{playlist_id}

### Parameters
#### Path Parameters
- **playlist_id** (string) - Required - The unique identifier of the playlist.

### Request Example
(No request body for GET requests)

### Response
#### Success Response (200)
- **playlist_id** (string) - The unique identifier of the playlist.
- **name** (string) - The name of the playlist.
- **description** (string) - A description of the playlist.
- **videos** (array) - A list of video objects within the playlist.
  - **video_id** (string) - The unique identifier of the video.
  - **title** (string) - The title of the video.
  - **thumbnail_url** (string) - The URL of the video's thumbnail.

#### Response Example
{
  "playlist_id": "pl_abc123",
  "name": "My Awesome Playlist",
  "description": "A collection of great videos.",
  "videos": [
    {
      "video_id": "vid_xyz789",
      "title": "Introduction to API Documentation",
      "thumbnail_url": "https://example.com/thumbnails/intro.jpg"
    },
    {
      "video_id": "vid_def456",
      "title": "Best Practices for JSON",
      "thumbnail_url": "https://example.com/thumbnails/json.jpg"
    }
  ]
}
```

--------------------------------

### POST /v1/playlists

Source: https://docs.tella.com/api-reference/playlists/create-a-new-playlist

Creates a new playlist for the authenticated user. This endpoint allows for the creation of new playlist entries within the Tella platform.

```APIDOC
## POST /v1/playlists

### Description
Create a new playlist for the authenticated user.

### Method
POST

### Endpoint
/v1/playlists

### Parameters
#### Query Parameters
None

#### Request Body
- **schema** (object) - Required - Defines the structure for creating a playlist. Expects a `CreatePlaylistRequest` object.

### Request Example
```json
{
  "name": "My New Playlist",
  "description": "A collection of my favorite videos"
}
```

### Response
#### Success Response (200)
- **playlist** (object) - Contains the details of the newly created playlist, conforming to the `PlaylistDetail` schema.

#### Response Example
```json
{
  "playlist": {
    "id": "pl_abc123",
    "name": "My New Playlist",
    "description": "A collection of my favorite videos",
    "created_at": "2023-10-27T10:00:00Z",
    "updated_at": "2023-10-27T10:00:00Z"
  }
}
```

#### Error Responses
- **400 Bad Request**: The request was malformed or contained invalid parameters.
- **401 Unauthorized**: Authentication is required. Provide a valid API key.
- **403 Forbidden**: You don't have permission to access this resource.
- **404 Not Found**: The requested resource was not found.
- **422 Unprocessable Entity**: The request was well-formed but contained semantic errors.
- **429 Too Many Requests**: You have exceeded the rate limit. Please slow down.
```

--------------------------------

### Get Video Details

Source: https://docs.tella.com/api-reference/videos/update-a-video

Retrieves detailed information about a specific video, including its metadata, chapters, transcript, and export options.

```APIDOC
## GET /websites/tella/videos/{videoId}

### Description
Retrieves detailed information about a specific video.

### Method
GET

### Endpoint
`/websites/tella/videos/{videoId}`

### Parameters
#### Path Parameters
- **videoId** (string) - Required - The unique identifier of the video to retrieve.

### Response
#### Success Response (200)
- **id** (string) - Unique video identifier.
- **name** (string) - Video title.
- **description** (string) - Video description.
- **views** (integer) - Total view count.
- **aspectRatio** (string) - Video aspect ratio (e.g., '16:9').
- **createdAt** (string) - ISO 8601 datetime of creation.
- **updatedAt** (string) - ISO 8601 datetime of last update.
- **durationSeconds** (number) - Duration of the video in seconds.

#### Response Example
```json
{
  "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": 300
}
```

#### Error Response (500)
- **error** (object) - Contains error details.
  - **code** (string) - Error code (e.g., `internal_server_error`).
  - **message** (string) - Description of the error.
  - **doc_url** (string) - URL for documentation about the error.

#### Error Response Example
```json
{
  "error": {
    "code": "internal_server_error",
    "message": "An unexpected error occurred on the server.",
    "doc_url": "https://tella.tv/docs/api-reference/errors#internal-server-error"
  }
}
```
```

--------------------------------

### Website Navigation and Pages

Source: https://docs.tella.com/api-reference/playlists/remove-a-video-from-a-playlist

Fetches navigation and other pages for a given website. This endpoint is typically used to retrieve site structure and content.

```APIDOC
## GET /websites/tella

### Description
Fetches navigation and other pages for the Tella website.

### Method
GET

### Endpoint
/websites/tella

### Parameters
#### Query Parameters
- **llms.txt** (string) - Required - The file containing navigation and page information.

### Request Example
```json
{
  "query": "llms.txt"
}
```

### Response
#### Success Response (200)
- **content** (string) - The content of the llms.txt file, including navigation and page data.

#### Response Example
```json
{
  "content": "(content of llms.txt file)"
}
```
```

--------------------------------

### GET /v1/webhooks/endpoints/{id}/secret

Source: https://docs.tella.com/api-reference/webhooks/get-endpoint-signing-secret

Retrieves the signing secret for a webhook endpoint. This secret is used to verify the authenticity of incoming webhook payloads.

```APIDOC
## GET /v1/webhooks/endpoints/{id}/secret

### Description
Retrieves the signing secret for a webhook endpoint. Use this to verify incoming webhook payloads.

### Method
GET

### Endpoint
/v1/webhooks/endpoints/{id}/secret

### Parameters
#### Path Parameters
- **id** (string) - Required - The webhook endpoint ID

### Request Example
```json
{
  "example": ""
}
```

### Response
#### Success Response (200)
- **secret** (string) - The signing secret for the webhook endpoint.

#### Response Example
```json
{
  "secret": "whsec_example_secret_12345"
}
```

#### Error Responses
- **400**: Bad Request - The request was malformed or contained invalid parameters.
- **401**: Unauthorized - Authentication is required. Provide a valid API key.
- **403**: Forbidden - You don't have permission to access this resource.
- **404**: Not Found - The requested resource was not found.
- **422**: Unprocessable Entity - The request was well-formed but contained semantic errors.
- **429**: Rate Limit Exceeded - You have exceeded the rate limit. Please slow down.
- **500**: Internal Server Error - An unexpected error occurred on the server.
```

--------------------------------

### Website Settings API

Source: https://docs.tella.com/api-reference/videos/duplicate-a-video

This section details the properties for configuring website settings related to videos on Tella. It includes options for playback, downloads, comments, embedding, and search engine indexing.

```APIDOC
## Website Settings Object

### Description
Configuration object for website settings related to video playback and access.

### Properties

#### defaultPlaybackRate (number) - Required
- Default playback speed for the video.

#### captionsDefaultEnabled (boolean) - Required
- Whether captions are enabled by default.

#### transcriptsEnabled (boolean) - Required
- Whether transcripts are available for the video.

#### publishDateEnabled (boolean) - Required
- Whether the publish date is displayed.

#### viewCountEnabled (boolean) - Required
- Whether the view count is displayed.

#### commentsEnabled (boolean) - Required
- Whether comments are enabled for the video.

#### commentEmailsEnabled (boolean) - Required
- Send email notifications for new comments.
  - Example: `false`

#### downloadsEnabled (boolean) - Required
- Allow viewers to download the video.
  - Example: `true`

#### rawDownloadsEnabled (boolean) - Required
- Allow viewers to download raw source files.
  - Example: `false`

#### linkScope (string) - Required
- Access level: `public` (anyone with link), `private` (org members only), `password` (requires password), `embedonly` (only viewable when embedded).
  - Example: `public`
  - Enum: `public`, `private`, `password`, `embedonly`

#### searchEngineIndexingEnabled (boolean) - Required
- Allow search engines to index the video page.
  - Example: `true`

#### allowedEmbedDomains (array[string]) - Required
- Restrict embedding to these domains only (Premium feature). Empty array allows all domains.
  - Example: `["example.com", "mysite.org"]`

#### customThumbnailURL (string) - Nullable, Required
- Custom thumbnail image URL.
  - Example: `https://example.com/custom-thumbnail.jpg`
  - Format: `uri`

### Additional Properties
`false` - No additional properties are allowed.
```
Tokens:
Raw