{ "components": { "headers": { "Deprecation": { "description": "Indicates that an API operation is deprecated, following RFC 9745", "example": "@1767225600", "schema": { "type": "string" } }, "RateLimit": { "description": "Current quota with remaining requests (`r`) and seconds until reset (`t`)", "example": "\"public-api\";r=95;t=42", "schema": { "type": "string" } }, "RateLimitPolicy": { "description": "Named quota policy with the request limit (`q`) and window in seconds (`w`)", "example": "\"public-api\";q=100;w=60", "schema": { "type": "string" } }, "RetryAfter": { "description": "Seconds to wait before retrying a rate-limited request", "example": 45, "schema": { "minimum": 1, "type": "integer" } }, "Sunset": { "description": "Indicates when a deprecated API operation will become unavailable, following RFC 8594", "example": "Tue, 30 Jun 2026 23:59:59 GMT", "schema": { "type": "string" } }, "XRateLimitLimit": { "description": "Maximum requests allowed in the current window", "example": 100, "schema": { "type": "integer" } }, "XRateLimitRemaining": { "description": "Requests remaining in the current window", "example": 95, "schema": { "type": "integer" } }, "XRateLimitReset": { "description": "Unix timestamp in milliseconds when the window resets", "example": 1704067200000, "schema": { "format": "int64", "type": "integer" } } }, "schemas": { "AddClipLayoutRequest": { "additionalProperties": false, "description": "Add a layout to a clip", "properties": { "durationMs": { "description": "Optional. Provide together with startTimeMs for a time-ranged layout. Minimum 200ms.", "maximum": 9007199254740991, "minimum": 200, "type": "integer" }, "layout": { "$ref": "#/components/schemas/ClipLayoutShape" }, "media": { "allOf": [ { "$ref": "#/components/schemas/ClipMedia" } ], "description": "Optional media content to show during this layout. Only valid on time-ranged layouts." }, "startTimeMs": { "description": "Optional. Provide together with durationMs for a time-ranged layout. In ms on the clip's playback timeline (cuts applied).", "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, "transitionStyle": { "allOf": [ { "$ref": "#/components/schemas/LayoutTransitionStyle" } ], "description": "Optional. Only valid on time-ranged layouts. Defaults to the user's saved layout intro transition when omitted. The user's saved layout outro transition is applied when the following layout begins or resumes." } }, "required": [ "layout" ], "type": "object" }, "AddClipMaskRequest": { "additionalProperties": false, "description": "Add a blur or highlight mask. Always targets the subject screen layer. Times are in ms on the clip's playback timeline (cuts applied).", "properties": { "dimensions": { "$ref": "#/components/schemas/MaskDimensions" }, "durationMs": { "example": 2000, "exclusiveMinimum": true, "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, "point": { "$ref": "#/components/schemas/MaskPoint" }, "startTimeMs": { "description": "Start time in ms on the clip's playback timeline (cuts applied)", "example": 1000, "maximum": 9007199254740991, "minimum": 0, "type": "integer" } }, "required": [ "startTimeMs", "durationMs", "point", "dimensions" ], "type": "object" }, "AddClipOverlayRequest": { "additionalProperties": false, "description": "Add an image or video overlay to a clip. Upload the bytes via `POST /v1/sources` (`kind: image` or `kind: video`) and pass the `sourceId`; the overlay type follows the source's kind. When `point`/`dimensions` are omitted, a centered box is computed from the source.", "properties": { "dimensions": { "allOf": [ { "$ref": "#/components/schemas/OverlayDimensions" } ] }, "durationMs": { "example": 5000, "exclusiveMinimum": true, "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, "name": { "example": "Logo", "type": "string" }, "point": { "allOf": [ { "$ref": "#/components/schemas/OverlayPoint" } ] }, "sourceId": { "description": "Source ID from `POST /v1/sources` (`kind: image` or `kind: video`). The overlay type follows the source's kind.", "example": "su_abc123", "type": "string" }, "startTimeMs": { "description": "Start time. Milliseconds on the clip playback timeline (with cuts applied) — the same timeline as the cut transcript.", "example": 1000, "maximum": 9007199254740991, "minimum": 0, "type": "integer" } }, "required": [ "sourceId", "startTimeMs", "durationMs" ], "type": "object" }, "AddClipRequest": { "additionalProperties": false, "description": "Add a new clip from an uploaded source.", "properties": { "name": { "description": "Clip name. Defaults to the next `Clip N`.", "example": "Intro", "maxLength": 255, "minLength": 1, "type": "string" }, "sourceId": { "description": "Source ID from `POST /v1/sources`.", "minLength": 1, "type": "string" } }, "required": [ "sourceId" ], "type": "object" }, "AddClipSoundEffectRequest": { "additionalProperties": false, "description": "Add a sound effect to a clip, from Tella's curated catalog (`presetId`) or from your own audio (`sourceId`).", "properties": { "durationMs": { "example": 3000, "exclusiveMinimum": true, "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, "name": { "example": "Whoosh", "type": "string" }, "presetId": { "description": "Preset ID of a curated Tella sound effect, from a `default` item in `GET /v1/library?scope=default`. Placing one copies the effect into a source owned by your workspace, so nothing needs uploading. Mutually exclusive with `sourceId`; exactly one is required.", "example": "cha-ching", "type": "string" }, "sourceId": { "description": "Source ID for the audio, from `POST /v1/sources` (`kind: audio` with the audio's duration) or from a `private`/`workspace` item in `GET /v1/library?type=sound-effect`. When uploading, send the audio file as-is — MP3, WAV, M4A, … — no need to wrap it in an MP4. Mutually exclusive with `presetId`; exactly one is required.", "example": "su_abc123", "type": "string" }, "startTimeMs": { "description": "Start time. Milliseconds on the clip playback timeline (with cuts applied) — the same timeline as the cut transcript.", "example": 1000, "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, "volume": { "description": "Playback volume (0 = muted, 1 = original). Defaults to 1.", "example": 1, "minimum": 0, "type": "number" } }, "required": [ "startTimeMs", "durationMs" ], "type": "object" }, "AddClipTextOverlayRequest": { "additionalProperties": false, "description": "Add a text overlay to a clip. Nothing needs uploading — pass the copy directly. When `point`/`dimensions` are omitted, a centered box 60% of the artboard wide and 25% tall is used.", "properties": { "background": { "allOf": [ { "$ref": "#/components/schemas/TextOverlayBackground" } ], "description": "Background behind the text. Defaults to transparent." }, "backgroundShape": { "allOf": [ { "$ref": "#/components/schemas/TextOverlayBackgroundShape" } ], "description": "Defaults to none." }, "color": { "description": "Defaults to white.", "example": "#FFFFFFFF", "pattern": "^#(?:[0-9A-Fa-f]{6}|[0-9A-Fa-f]{8})$", "type": "string" }, "dimensions": { "allOf": [ { "$ref": "#/components/schemas/OverlayDimensions" } ] }, "durationMs": { "example": 5000, "exclusiveMinimum": true, "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, "fontFamily": { "allOf": [ { "$ref": "#/components/schemas/TextOverlayFontFamily" } ], "description": "One of Tella's catalog font families. Defaults to Inter. Anything outside the catalog is rejected rather than silently falling back." }, "fontSize": { "description": "Font size in artboard pixels. Defaults to 7.5% of the video's shorter side, which is the editor's default and readable at any canvas size.", "example": 81, "exclusiveMinimum": true, "minimum": 0, "type": "number" }, "fontWeight": { "description": "Variable-font weight axis — 100 (thin) to 900 (black), 500 by default. Values outside the chosen font's own axis range are clamped when rendered.", "example": 500, "maximum": 1000, "minimum": 1, "type": "number" }, "fontWidth": { "description": "Variable-font width axis, as a percentage — 100 is normal, 50 ultra-condensed, 150 extra-expanded, 100 by default. Values outside the chosen font's own axis range are clamped when rendered.", "example": 100, "exclusiveMinimum": true, "minimum": 0, "type": "number" }, "point": { "allOf": [ { "$ref": "#/components/schemas/OverlayPoint" } ] }, "startTimeMs": { "description": "Start time. Milliseconds on the clip playback timeline (with cuts applied) — the same timeline as the cut transcript.", "example": 1000, "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, "text": { "example": "Welcome back", "minLength": 1, "type": "string" }, "textAlign": { "allOf": [ { "$ref": "#/components/schemas/TextOverlayTextAlign" } ], "description": "Defaults to center." } }, "required": [ "text", "startTimeMs", "durationMs" ], "type": "object" }, "AddClipZoomRequest": { "additionalProperties": false, "description": "Add a zoom to the clip's screen layer (does not affect the camera). Use `manualZoom` with a `focusPoint`, or `trackingZoom` to follow the cursor.", "properties": { "durationMs": { "example": 2000, "exclusiveMinimum": true, "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, "focusPoint": { "allOf": [ { "$ref": "#/components/schemas/ZoomFocusPoint" } ] }, "scale": { "description": "Magnification factor (1 = no zoom, 3.5 = max). Required — a zoom without a scale cannot be rendered.", "example": 2, "maximum": 3.5, "minimum": 1, "type": "number" }, "startTimeMs": { "description": "Start time in ms on the clip's playback timeline (cuts applied)", "example": 1000, "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, "type": { "description": "`manualZoom` zooms into a fixed `focusPoint` on the screen. `trackingZoom` automatically follows the cursor in the screen recording.", "enum": [ "manualZoom", "trackingZoom" ], "example": "manualZoom", "type": "string" } }, "required": [ "type", "startTimeMs", "durationMs", "scale" ], "type": "object" }, "AddCollaboratorRequest": { "additionalProperties": false, "description": "Request body for adding a collaborator to a video", "properties": { "email": { "description": "Email address of the user to add. Must be a member of your workspace.", "example": "editor@example.com", "format": "email", "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$", "type": "string" }, "role": { "description": "Role to grant. Allowed values: 'editor' or 'viewer'.", "enum": [ "editor", "viewer" ], "example": "editor", "type": "string" } }, "required": [ "email", "role" ], "type": "object" }, "AddCollaboratorResponse": { "additionalProperties": false, "description": "Response after adding a collaborator to a video", "properties": { "collaborator": { "$ref": "#/components/schemas/Collaborator" } }, "required": [ "collaborator" ], "type": "object" }, "AddVideoRequest": { "additionalProperties": false, "description": "Request body for adding a video to a playlist", "properties": { "videoId": { "description": "ID of the video to add to the playlist", "example": "vid_xyz789ghi012", "type": "string" } }, "required": [ "videoId" ], "type": "object" }, "AddVideoTagRequest": { "additionalProperties": false, "description": "Request body for tagging a video", "properties": { "tagId": { "description": "ID of the tag to add to the video", "example": "tag_abc123def456", "type": "string" } }, "required": [ "tagId" ], "type": "object" }, "ApplyVideoEditsRequest": { "additionalProperties": false, "description": "Add, update, and remove up to 200 sound effects, text overlays, zooms, blurs, highlights, and image/video overlays in one editor revision. Operations run in array order; the complete batch is validated before anything is applied.", "properties": { "operations": { "items": { "$ref": "#/components/schemas/VideoEditOperation" }, "maxItems": 200, "minItems": 1, "type": "array" } }, "required": [ "operations" ], "type": "object" }, "ApplyVideoEditsResponse": { "additionalProperties": false, "description": "One result per operation, in request order: the created resource ID for adds, the affected resource ID for updates and removes.", "properties": { "results": { "items": { "additionalProperties": false, "properties": { "id": { "description": "Created or affected resource ID", "type": "string" }, "operationId": { "type": "string" }, "type": { "enum": [ "sound_effect", "text_overlay", "zoom", "blur", "highlight", "media_overlay" ], "type": "string" } }, "required": [ "operationId", "type", "id" ], "type": "object" }, "type": "array" }, "revision": { "maximum": 9007199254740991, "minimum": 0, "type": "integer" } }, "required": [ "revision", "results" ], "type": "object" }, "AutoCropRequest": { "additionalProperties": false, "description": "Detect and apply a crop to the clip's screen recording at a playback time.", "properties": { "inpointMs": { "description": "Frame time in ms on the clip's playback timeline (cuts applied). Defaults to 0.", "example": 1000, "maximum": 9007199254740991, "minimum": 0, "type": "integer" } }, "type": "object" }, "AutoCropResponse": { "additionalProperties": false, "description": "The crop selected by the detector and applied to the clip", "properties": { "aspectRatio": { "type": "string" }, "confidence": { "minimum": 0, "type": "number" }, "crop": { "$ref": "#/components/schemas/CropBox" }, "inpointMs": { "description": "Requested time on the clip playback timeline", "maximum": 9007199254740991, "minimum": 0, "type": "integer" } }, "required": [ "crop", "confidence", "aspectRatio", "inpointMs" ], "type": "object" }, "BackdropCaptionStyle": { "additionalProperties": false, "properties": { "backgroundColor": { "description": "Hex color in #RRGGBB or #RRGGBBAA form. Responses use uppercase #RRGGBBAA.", "example": "#5E51F8FF", "pattern": "^#(?:[0-9A-Fa-f]{6}|[0-9A-Fa-f]{8})$", "type": "string" }, "name": { "enum": [ "backdrop" ], "type": "string" }, "textColor": { "description": "Hex color in #RRGGBB or #RRGGBBAA form. Responses use uppercase #RRGGBBAA.", "example": "#5E51F8FF", "pattern": "^#(?:[0-9A-Fa-f]{6}|[0-9A-Fa-f]{8})$", "type": "string" }, "wordLevelHighlights": { "type": "boolean" } }, "required": [ "name", "backgroundColor", "textColor", "wordLevelHighlights" ], "title": "Backdrop", "type": "object" }, "BackgroundCategory": { "additionalProperties": false, "description": "A named group of selectable backgrounds", "properties": { "backgrounds": { "items": { "$ref": "#/components/schemas/BackgroundItem" }, "type": "array" }, "id": { "description": "Stable category identifier", "example": "default:tella", "type": "string" }, "name": { "description": "Human-readable category name", "example": "Tella", "type": "string" }, "scope": { "$ref": "#/components/schemas/BackgroundScope" } }, "required": [ "id", "name", "scope", "backgrounds" ], "type": "object" }, "BackgroundItem": { "additionalProperties": false, "description": "A selectable background and its preview metadata", "properties": { "background": { "allOf": [ { "$ref": "#/components/schemas/ClipBackgroundOutput" } ], "description": "Background value that can be passed directly to PATCH /v1/videos/{id}/clips/{clipId}" }, "name": { "description": "Human-readable display name within the category", "example": "Red Horizon", "type": "string" }, "thumbnailUrl": { "description": "Preview image requested at 192x108 when the image host supports resizing", "format": "uri", "type": "string" } }, "required": [ "name", "thumbnailUrl", "background" ], "type": "object" }, "BackgroundMusic": { "additionalProperties": false, "description": "One video-wide track that loops over the whole video and is included in exports", "properties": { "durationMs": { "description": "Audio track duration in milliseconds", "example": 180036, "exclusiveMinimum": true, "minimum": 0, "type": "number" }, "name": { "description": "Optional display name for the track", "example": "Calm Product Tour", "nullable": true, "type": "string" }, "url": { "description": "HTTPS URL of the audio track", "example": "https://ucarecdn.com/example-track/", "format": "uri", "pattern": "^https:\\/\\/.*", "type": "string" }, "volume": { "description": "Track volume from 0 (silent) to 1 (full volume)", "example": 0.2, "maximum": 1, "minimum": 0, "type": "number" } }, "required": [ "url", "durationMs", "volume", "name" ], "type": "object" }, "BackgroundScope": { "description": "Where the background comes from: the authenticated user's uploads, workspace uploads, or Tella's default catalog", "enum": [ "personal", "workspace", "default" ], "type": "string" }, "BatchAddBlurOperation": { "additionalProperties": false, "properties": { "clipId": { "description": "Clip ID", "minLength": 1, "type": "string" }, "dimensions": { "$ref": "#/components/schemas/MaskDimensions" }, "durationMs": { "example": 2000, "exclusiveMinimum": true, "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, "operationId": { "description": "Caller-chosen ID used to match this operation to its result. Must be unique within the batch.", "example": "sound-1", "minLength": 1, "type": "string" }, "point": { "$ref": "#/components/schemas/MaskPoint" }, "startTimeMs": { "description": "Start time in ms on the clip's playback timeline (cuts applied)", "example": 1000, "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, "type": { "enum": [ "add_blur" ], "type": "string" } }, "required": [ "type", "operationId", "clipId", "startTimeMs", "durationMs", "point", "dimensions" ], "type": "object" }, "BatchAddHighlightOperation": { "additionalProperties": false, "properties": { "clipId": { "description": "Clip ID", "minLength": 1, "type": "string" }, "dimensions": { "$ref": "#/components/schemas/MaskDimensions" }, "durationMs": { "example": 2000, "exclusiveMinimum": true, "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, "operationId": { "description": "Caller-chosen ID used to match this operation to its result. Must be unique within the batch.", "example": "sound-1", "minLength": 1, "type": "string" }, "point": { "$ref": "#/components/schemas/MaskPoint" }, "startTimeMs": { "description": "Start time in ms on the clip's playback timeline (cuts applied)", "example": 1000, "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, "type": { "enum": [ "add_highlight" ], "type": "string" } }, "required": [ "type", "operationId", "clipId", "startTimeMs", "durationMs", "point", "dimensions" ], "type": "object" }, "BatchAddMediaOverlayOperation": { "additionalProperties": false, "properties": { "clipId": { "description": "Clip ID", "minLength": 1, "type": "string" }, "dimensions": { "allOf": [ { "$ref": "#/components/schemas/OverlayDimensions" } ] }, "durationMs": { "example": 5000, "exclusiveMinimum": true, "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, "name": { "example": "Logo", "type": "string" }, "operationId": { "description": "Caller-chosen ID used to match this operation to its result. Must be unique within the batch.", "example": "sound-1", "minLength": 1, "type": "string" }, "point": { "allOf": [ { "$ref": "#/components/schemas/OverlayPoint" } ] }, "sourceId": { "description": "Source ID from `POST /v1/sources` (`kind: image` or `kind: video`). The overlay type follows the source's kind.", "example": "su_abc123", "type": "string" }, "startTimeMs": { "description": "Start time. Milliseconds on the clip playback timeline (with cuts applied) — the same timeline as the cut transcript.", "example": 1000, "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, "type": { "enum": [ "add_media_overlay" ], "type": "string" } }, "required": [ "type", "operationId", "clipId", "sourceId", "startTimeMs", "durationMs" ], "type": "object" }, "BatchAddSoundEffectOperation": { "additionalProperties": false, "properties": { "clipId": { "description": "Clip ID", "minLength": 1, "type": "string" }, "durationMs": { "example": 3000, "exclusiveMinimum": true, "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, "name": { "example": "Whoosh", "type": "string" }, "operationId": { "description": "Caller-chosen ID used to match this operation to its result. Must be unique within the batch.", "example": "sound-1", "minLength": 1, "type": "string" }, "presetId": { "description": "Preset ID of a curated Tella sound effect, from a `default` item in `GET /v1/library?scope=default`. Placing one copies the effect into a source owned by your workspace, so nothing needs uploading. Mutually exclusive with `sourceId`; exactly one is required.", "example": "cha-ching", "type": "string" }, "sourceId": { "description": "Source ID for the audio, from `POST /v1/sources` (`kind: audio` with the audio's duration) or from a `private`/`workspace` item in `GET /v1/library?type=sound-effect`. When uploading, send the audio file as-is — MP3, WAV, M4A, … — no need to wrap it in an MP4. Mutually exclusive with `presetId`; exactly one is required.", "example": "su_abc123", "type": "string" }, "startTimeMs": { "description": "Start time. Milliseconds on the clip playback timeline (with cuts applied) — the same timeline as the cut transcript.", "example": 1000, "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, "type": { "enum": [ "add_sound_effect" ], "type": "string" }, "volume": { "description": "Playback volume (0 = muted, 1 = original). Defaults to 1.", "example": 1, "minimum": 0, "type": "number" } }, "required": [ "type", "operationId", "clipId", "startTimeMs", "durationMs" ], "type": "object" }, "BatchAddTextOverlayOperation": { "additionalProperties": false, "properties": { "background": { "allOf": [ { "$ref": "#/components/schemas/TextOverlayBackground" } ], "description": "Background behind the text. Defaults to transparent." }, "backgroundShape": { "allOf": [ { "$ref": "#/components/schemas/TextOverlayBackgroundShape" } ], "description": "Defaults to none." }, "clipId": { "description": "Clip ID", "minLength": 1, "type": "string" }, "color": { "description": "Defaults to white.", "example": "#FFFFFFFF", "pattern": "^#(?:[0-9A-Fa-f]{6}|[0-9A-Fa-f]{8})$", "type": "string" }, "dimensions": { "allOf": [ { "$ref": "#/components/schemas/OverlayDimensions" } ] }, "durationMs": { "example": 5000, "exclusiveMinimum": true, "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, "fontFamily": { "allOf": [ { "$ref": "#/components/schemas/TextOverlayFontFamily" } ], "description": "One of Tella's catalog font families. Defaults to Inter. Anything outside the catalog is rejected rather than silently falling back." }, "fontSize": { "description": "Font size in artboard pixels. Defaults to 7.5% of the video's shorter side, which is the editor's default and readable at any canvas size.", "example": 81, "exclusiveMinimum": true, "minimum": 0, "type": "number" }, "fontWeight": { "description": "Variable-font weight axis — 100 (thin) to 900 (black), 500 by default. Values outside the chosen font's own axis range are clamped when rendered.", "example": 500, "maximum": 1000, "minimum": 1, "type": "number" }, "fontWidth": { "description": "Variable-font width axis, as a percentage — 100 is normal, 50 ultra-condensed, 150 extra-expanded, 100 by default. Values outside the chosen font's own axis range are clamped when rendered.", "example": 100, "exclusiveMinimum": true, "minimum": 0, "type": "number" }, "operationId": { "description": "Caller-chosen ID used to match this operation to its result. Must be unique within the batch.", "example": "sound-1", "minLength": 1, "type": "string" }, "point": { "allOf": [ { "$ref": "#/components/schemas/OverlayPoint" } ] }, "startTimeMs": { "description": "Start time. Milliseconds on the clip playback timeline (with cuts applied) — the same timeline as the cut transcript.", "example": 1000, "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, "text": { "example": "Welcome back", "minLength": 1, "type": "string" }, "textAlign": { "allOf": [ { "$ref": "#/components/schemas/TextOverlayTextAlign" } ], "description": "Defaults to center." }, "type": { "enum": [ "add_text_overlay" ], "type": "string" } }, "required": [ "type", "operationId", "clipId", "text", "startTimeMs", "durationMs" ], "type": "object" }, "BatchAddZoomOperation": { "additionalProperties": false, "properties": { "clipId": { "description": "Clip ID", "minLength": 1, "type": "string" }, "durationMs": { "example": 2000, "exclusiveMinimum": true, "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, "focusPoint": { "allOf": [ { "$ref": "#/components/schemas/ZoomFocusPoint" } ] }, "operationId": { "description": "Caller-chosen ID used to match this operation to its result. Must be unique within the batch.", "example": "sound-1", "minLength": 1, "type": "string" }, "scale": { "description": "Magnification factor (1 = no zoom, 3.5 = max). Required — a zoom without a scale cannot be rendered.", "example": 2, "maximum": 3.5, "minimum": 1, "type": "number" }, "startTimeMs": { "description": "Start time in ms on the clip's playback timeline (cuts applied)", "example": 1000, "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, "type": { "enum": [ "add_zoom" ], "type": "string" }, "zoomType": { "description": "Zoom variant: manualZoom or trackingZoom.", "enum": [ "manualZoom", "trackingZoom" ], "example": "manualZoom", "type": "string" } }, "required": [ "type", "operationId", "clipId", "zoomType", "startTimeMs", "durationMs", "scale" ], "type": "object" }, "BatchRemoveBlurOperation": { "additionalProperties": false, "properties": { "clipId": { "description": "Clip ID", "minLength": 1, "type": "string" }, "maskId": { "description": "Blur ID, or the operationId of an add operation earlier in this batch.", "minLength": 1, "type": "string" }, "operationId": { "description": "Caller-chosen ID used to match this operation to its result. Must be unique within the batch.", "example": "sound-1", "minLength": 1, "type": "string" }, "type": { "enum": [ "remove_blur" ], "type": "string" } }, "required": [ "type", "operationId", "clipId", "maskId" ], "type": "object" }, "BatchRemoveHighlightOperation": { "additionalProperties": false, "properties": { "clipId": { "description": "Clip ID", "minLength": 1, "type": "string" }, "maskId": { "description": "Highlight ID, or the operationId of an add operation earlier in this batch.", "minLength": 1, "type": "string" }, "operationId": { "description": "Caller-chosen ID used to match this operation to its result. Must be unique within the batch.", "example": "sound-1", "minLength": 1, "type": "string" }, "type": { "enum": [ "remove_highlight" ], "type": "string" } }, "required": [ "type", "operationId", "clipId", "maskId" ], "type": "object" }, "BatchRemoveMediaOverlayOperation": { "additionalProperties": false, "properties": { "clipId": { "description": "Clip ID", "minLength": 1, "type": "string" }, "operationId": { "description": "Caller-chosen ID used to match this operation to its result. Must be unique within the batch.", "example": "sound-1", "minLength": 1, "type": "string" }, "overlayId": { "description": "Overlay ID, or the operationId of an add operation earlier in this batch.", "minLength": 1, "type": "string" }, "type": { "enum": [ "remove_media_overlay" ], "type": "string" } }, "required": [ "type", "operationId", "clipId", "overlayId" ], "type": "object" }, "BatchRemoveSoundEffectOperation": { "additionalProperties": false, "properties": { "clipId": { "description": "Clip ID", "minLength": 1, "type": "string" }, "operationId": { "description": "Caller-chosen ID used to match this operation to its result. Must be unique within the batch.", "example": "sound-1", "minLength": 1, "type": "string" }, "soundEffectId": { "description": "Sound effect ID, or the operationId of an add operation earlier in this batch.", "minLength": 1, "type": "string" }, "type": { "enum": [ "remove_sound_effect" ], "type": "string" } }, "required": [ "type", "operationId", "clipId", "soundEffectId" ], "type": "object" }, "BatchRemoveTextOverlayOperation": { "additionalProperties": false, "properties": { "clipId": { "description": "Clip ID", "minLength": 1, "type": "string" }, "operationId": { "description": "Caller-chosen ID used to match this operation to its result. Must be unique within the batch.", "example": "sound-1", "minLength": 1, "type": "string" }, "textOverlayId": { "description": "Text overlay ID, or the operationId of an add operation earlier in this batch.", "minLength": 1, "type": "string" }, "type": { "enum": [ "remove_text_overlay" ], "type": "string" } }, "required": [ "type", "operationId", "clipId", "textOverlayId" ], "type": "object" }, "BatchRemoveZoomOperation": { "additionalProperties": false, "properties": { "clipId": { "description": "Clip ID", "minLength": 1, "type": "string" }, "operationId": { "description": "Caller-chosen ID used to match this operation to its result. Must be unique within the batch.", "example": "sound-1", "minLength": 1, "type": "string" }, "type": { "enum": [ "remove_zoom" ], "type": "string" }, "zoomId": { "description": "Zoom ID, or the operationId of an add operation earlier in this batch.", "minLength": 1, "type": "string" } }, "required": [ "type", "operationId", "clipId", "zoomId" ], "type": "object" }, "BatchUpdateBlurOperation": { "additionalProperties": false, "properties": { "clipId": { "description": "Clip ID", "minLength": 1, "type": "string" }, "dimensions": { "allOf": [ { "$ref": "#/components/schemas/MaskDimensions" } ] }, "durationMs": { "exclusiveMinimum": true, "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, "maskId": { "description": "Blur ID, or the operationId of an add operation earlier in this batch.", "minLength": 1, "type": "string" }, "operationId": { "description": "Caller-chosen ID used to match this operation to its result. Must be unique within the batch.", "example": "sound-1", "minLength": 1, "type": "string" }, "point": { "allOf": [ { "$ref": "#/components/schemas/MaskPoint" } ] }, "startTimeMs": { "description": "Start time in ms on the clip's playback timeline (cuts applied)", "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, "type": { "enum": [ "update_blur" ], "type": "string" } }, "required": [ "type", "operationId", "clipId", "maskId" ], "type": "object" }, "BatchUpdateHighlightOperation": { "additionalProperties": false, "properties": { "clipId": { "description": "Clip ID", "minLength": 1, "type": "string" }, "dimensions": { "allOf": [ { "$ref": "#/components/schemas/MaskDimensions" } ] }, "durationMs": { "exclusiveMinimum": true, "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, "maskId": { "description": "Highlight ID, or the operationId of an add operation earlier in this batch.", "minLength": 1, "type": "string" }, "operationId": { "description": "Caller-chosen ID used to match this operation to its result. Must be unique within the batch.", "example": "sound-1", "minLength": 1, "type": "string" }, "point": { "allOf": [ { "$ref": "#/components/schemas/MaskPoint" } ] }, "startTimeMs": { "description": "Start time in ms on the clip's playback timeline (cuts applied)", "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, "type": { "enum": [ "update_highlight" ], "type": "string" } }, "required": [ "type", "operationId", "clipId", "maskId" ], "type": "object" }, "BatchUpdateMediaOverlayOperation": { "additionalProperties": false, "properties": { "clipId": { "description": "Clip ID", "minLength": 1, "type": "string" }, "dimensions": { "allOf": [ { "$ref": "#/components/schemas/OverlayDimensions" } ] }, "durationMs": { "exclusiveMinimum": true, "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, "operationId": { "description": "Caller-chosen ID used to match this operation to its result. Must be unique within the batch.", "example": "sound-1", "minLength": 1, "type": "string" }, "overlayId": { "description": "Overlay ID, or the operationId of an add operation earlier in this batch.", "minLength": 1, "type": "string" }, "point": { "allOf": [ { "$ref": "#/components/schemas/OverlayPoint" } ] }, "startTimeMs": { "description": "Start time. Milliseconds on the clip playback timeline (with cuts applied) — the same timeline as the cut transcript.", "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, "transition": { "allOf": [ { "$ref": "#/components/schemas/TransitionStyle" } ], "description": "Intro/outro animation: `smooth` fades the overlay in at its start and out at its end, `hard_cut` pops it in and out." }, "type": { "enum": [ "update_media_overlay" ], "type": "string" } }, "required": [ "type", "operationId", "clipId", "overlayId" ], "type": "object" }, "BatchUpdateSoundEffectOperation": { "additionalProperties": false, "properties": { "clipId": { "description": "Clip ID", "minLength": 1, "type": "string" }, "durationMs": { "exclusiveMinimum": true, "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, "operationId": { "description": "Caller-chosen ID used to match this operation to its result. Must be unique within the batch.", "example": "sound-1", "minLength": 1, "type": "string" }, "soundEffectId": { "description": "Sound effect ID, or the operationId of an add operation earlier in this batch.", "minLength": 1, "type": "string" }, "startTimeMs": { "description": "Start time. Milliseconds on the clip playback timeline (with cuts applied) — the same timeline as the cut transcript.", "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, "type": { "enum": [ "update_sound_effect" ], "type": "string" }, "volume": { "description": "Playback volume (0 = muted, 1 = original).", "minimum": 0, "type": "number" } }, "required": [ "type", "operationId", "clipId", "soundEffectId" ], "type": "object" }, "BatchUpdateTextOverlayOperation": { "additionalProperties": false, "properties": { "background": { "allOf": [ { "$ref": "#/components/schemas/TextOverlayBackground" } ] }, "backgroundShape": { "allOf": [ { "$ref": "#/components/schemas/TextOverlayBackgroundShape" } ] }, "clipId": { "description": "Clip ID", "minLength": 1, "type": "string" }, "color": { "description": "Hex color in #RRGGBB or #RRGGBBAA form. Responses use uppercase #RRGGBBAA.", "example": "#FFFFFFFF", "pattern": "^#(?:[0-9A-Fa-f]{6}|[0-9A-Fa-f]{8})$", "type": "string" }, "dimensions": { "allOf": [ { "$ref": "#/components/schemas/OverlayDimensions" } ] }, "durationMs": { "exclusiveMinimum": true, "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, "fontFamily": { "allOf": [ { "$ref": "#/components/schemas/TextOverlayFontFamily" } ] }, "fontSize": { "description": "Font size in artboard pixels.", "exclusiveMinimum": true, "minimum": 0, "type": "number" }, "fontWeight": { "maximum": 1000, "minimum": 1, "type": "number" }, "fontWidth": { "exclusiveMinimum": true, "minimum": 0, "type": "number" }, "operationId": { "description": "Caller-chosen ID used to match this operation to its result. Must be unique within the batch.", "example": "sound-1", "minLength": 1, "type": "string" }, "point": { "allOf": [ { "$ref": "#/components/schemas/OverlayPoint" } ] }, "startTimeMs": { "description": "Start time. Milliseconds on the clip playback timeline (with cuts applied) — the same timeline as the cut transcript.", "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, "text": { "minLength": 1, "type": "string" }, "textAlign": { "allOf": [ { "$ref": "#/components/schemas/TextOverlayTextAlign" } ] }, "textOverlayId": { "description": "Text overlay ID, or the operationId of an add operation earlier in this batch.", "minLength": 1, "type": "string" }, "transition": { "allOf": [ { "$ref": "#/components/schemas/TransitionStyle" } ], "description": "Intro/outro animation: `smooth` fades the text in at its start and out at its end, `hard_cut` pops it in and out." }, "type": { "enum": [ "update_text_overlay" ], "type": "string" } }, "required": [ "type", "operationId", "clipId", "textOverlayId" ], "type": "object" }, "BatchUpdateZoomOperation": { "additionalProperties": false, "properties": { "clipId": { "description": "Clip ID", "minLength": 1, "type": "string" }, "durationMs": { "exclusiveMinimum": true, "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, "focusPoint": { "allOf": [ { "$ref": "#/components/schemas/ZoomFocusPoint" } ] }, "operationId": { "description": "Caller-chosen ID used to match this operation to its result. Must be unique within the batch.", "example": "sound-1", "minLength": 1, "type": "string" }, "scale": { "description": "Magnification factor (1 = no zoom, 3.5 = max).", "example": 2, "maximum": 3.5, "minimum": 1, "type": "number" }, "startTimeMs": { "description": "Start time in ms on the clip's playback timeline (cuts applied)", "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, "type": { "enum": [ "update_zoom" ], "type": "string" }, "zoomId": { "description": "Zoom ID, or the operationId of an add operation earlier in this batch.", "minLength": 1, "type": "string" }, "zoomType": { "description": "Zoom variant: manualZoom or trackingZoom.", "enum": [ "manualZoom", "trackingZoom" ], "example": "manualZoom", "type": "string" } }, "required": [ "type", "operationId", "clipId", "zoomId" ], "type": "object" }, "CameraBubbleLayout": { "additionalProperties": false, "description": "Floating camera bubble over the screen recording. Combi (all ratios). Position is 9-way. Set `style: full` to put the screen fullscreen behind the bubble.", "properties": { "kind": { "enum": [ "camera-bubble" ], "type": "string" }, "position": { "enum": [ "left", "right", "top", "bottom", "top-left", "top-right", "bottom-left", "bottom-right", "middle" ], "type": "string" }, "screenFit": { "description": "Only honoured when `style: \"full\"`. Defaults to cover.", "enum": [ "cover", "letterbox" ], "type": "string" }, "shape": { "enum": [ "circle", "square", "landscape", "portrait" ], "type": "string" }, "size": { "enum": [ "S", "M", "L" ], "type": "string" }, "style": { "description": "`regular` (default) keeps the screen layered behind the bubble; `full` puts the screen fullscreen behind the bubble (and honours `screenFit`).", "enum": [ "regular", "full" ], "type": "string" } }, "required": [ "kind", "position", "shape", "size" ], "title": "Camera Bubble", "type": "object" }, "CameraOnlyLayout": { "additionalProperties": false, "description": "Camera fills the frame or sits centered; the screen is hidden. Combi (all ratios).", "properties": { "kind": { "enum": [ "camera-only" ], "type": "string" }, "punchIn": { "description": "Only honoured when `style: \"fullscreen\"`. Defaults to false.", "type": "boolean" }, "shape": { "description": "Required when `style: \"middle\"`. Allowed shapes vary by ratio (no `portrait` in portrait clips, no `square` in square clips).", "enum": [ "circle", "square", "landscape", "portrait" ], "type": "string" }, "style": { "description": "`fullscreen` fills the frame with the camera (optional `punchIn`); `middle` centers a shaped camera (requires `shape`).", "enum": [ "fullscreen", "middle" ], "type": "string" } }, "required": [ "kind", "style" ], "title": "Camera Only", "type": "object" }, "CannesCaptionStyle": { "additionalProperties": false, "properties": { "name": { "enum": [ "cannes" ], "type": "string" }, "shadowColor": { "description": "Hex color in #RRGGBB or #RRGGBBAA form. Responses use uppercase #RRGGBBAA.", "example": "#5E51F8FF", "pattern": "^#(?:[0-9A-Fa-f]{6}|[0-9A-Fa-f]{8})$", "type": "string" }, "textColor": { "description": "Hex color in #RRGGBB or #RRGGBBAA form. Responses use uppercase #RRGGBBAA.", "example": "#5E51F8FF", "pattern": "^#(?:[0-9A-Fa-f]{6}|[0-9A-Fa-f]{8})$", "type": "string" } }, "required": [ "name", "textColor", "shadowColor" ], "title": "Cannes", "type": "object" }, "CaptionPosition": { "additionalProperties": false, "description": "Normalized subtitle position. Applies if subtitles are enabled on the video. Null uses automatic placement.", "properties": { "x": { "maximum": 1, "minimum": 0, "type": "number" }, "y": { "maximum": 1, "minimum": 0, "type": "number" } }, "required": [ "x", "y" ], "type": "object" }, "CaptionStyle": { "description": "Subtitle style. Applies if subtitles are enabled on the video. Every style-specific field is required and fields from other styles are rejected.", "discriminator": { "mapping": { "backdrop": "#/components/schemas/BackdropCaptionStyle", "cannes": "#/components/schemas/CannesCaptionStyle", "classic": "#/components/schemas/ClassicCaptionStyle", "highlight": "#/components/schemas/HighlightCaptionStyle", "mono": "#/components/schemas/MonoCaptionStyle" }, "propertyName": "name" }, "oneOf": [ { "$ref": "#/components/schemas/BackdropCaptionStyle" }, { "$ref": "#/components/schemas/HighlightCaptionStyle" }, { "$ref": "#/components/schemas/MonoCaptionStyle" }, { "$ref": "#/components/schemas/CannesCaptionStyle" }, { "$ref": "#/components/schemas/ClassicCaptionStyle" } ], "type": "object" }, "Chapter": { "additionalProperties": false, "description": "A chapter/section within a video", "properties": { "description": { "description": "Chapter description", "example": "Overview of what we'll cover", "maxLength": 5000, "type": "string" }, "timestampSeconds": { "description": "Chapter start time in seconds", "example": 0, "minimum": 0, "type": "number" }, "title": { "description": "Chapter title", "example": "Introduction", "maxLength": 255, "minLength": 1, "type": "string" } }, "required": [ "title", "description", "timestampSeconds" ], "type": "object" }, "ChapterInput": { "description": "A chapter accepted when replacing a video's chapters", "properties": { "description": { "description": "Chapter description. Lines formatted like a timestamp followed by a title are not allowed.", "example": "Overview of what we'll cover", "maxLength": 5000, "type": "string" }, "timestampSeconds": { "description": "Chapter start time in whole seconds", "example": 0, "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, "title": { "description": "Single-line chapter title", "example": "Introduction", "maxLength": 255, "minLength": 1, "pattern": "^[^\\r\\n]*$", "type": "string" } }, "required": [ "title", "description", "timestampSeconds" ], "type": "object" }, "ClassicCaptionStyle": { "additionalProperties": false, "properties": { "name": { "enum": [ "classic" ], "type": "string" }, "outlineColor": { "description": "Hex color in #RRGGBB or #RRGGBBAA form. Responses use uppercase #RRGGBBAA.", "example": "#5E51F8FF", "pattern": "^#(?:[0-9A-Fa-f]{6}|[0-9A-Fa-f]{8})$", "type": "string" }, "textColor": { "description": "Hex color in #RRGGBB or #RRGGBBAA form. Responses use uppercase #RRGGBBAA.", "example": "#5E51F8FF", "pattern": "^#(?:[0-9A-Fa-f]{6}|[0-9A-Fa-f]{8})$", "type": "string" } }, "required": [ "name", "textColor", "outlineColor" ], "title": "Classic", "type": "object" }, "Clip": { "additionalProperties": false, "description": "A section of a video", "properties": { "animatedCursor": { "description": "Whether the clip draws an animated cursor from captured mouse data. Absent when the clip has no screen recording.", "example": true, "type": "boolean" }, "background": { "$ref": "#/components/schemas/ClipBackgroundOutput" }, "createdAt": { "description": "ISO 8601 datetime", "example": "2026-01-15T10:30:00.000Z", "format": "date-time", "type": "string" }, "cuts": { "description": "Time ranges cut from the clip's playback", "items": { "$ref": "#/components/schemas/CutOutput" }, "type": "array" }, "durationSeconds": { "description": "Effective playback duration of the clip after cuts, in seconds", "example": 12.5, "minimum": 0, "type": "number" }, "id": { "description": "Unique clip identifier", "example": "cl_xyz789ghi012", "type": "string" }, "layoutSceneType": { "allOf": [ { "$ref": "#/components/schemas/LayoutSceneType" } ], "description": "Determines which layouts can be applied to this clip via `add_layout`. See `BasicSubjectLayoutName`, `CameraSubjectLayoutName`, `CombiLayoutName`." }, "maxDurationSeconds": { "description": "Total length of the underlying source, in seconds", "example": 14.2, "minimum": 0, "type": "number" }, "microphoneVolume": { "description": "This clip's microphone volume override: a number when the clip overrides the video's `microphoneVolume`, null when it follows it, and absent when the clip has no microphone audio to control — either no such track, or a track whose recording carries no audio (a muted mic, or a screen recording made without sharing system audio).", "example": 0.4, "maximum": 2, "minimum": 0, "nullable": true, "type": "number" }, "name": { "description": "Clip display name", "example": "Intro", "type": "string" }, "order": { "description": "Position of the clip within the video", "example": 0, "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, "studioSound": { "description": "Effective Studio Sound (AI audio enhancement) state for this clip: the video-level switch minus this clip's opt-out.", "example": false, "type": "boolean" }, "systemAudioVolume": { "description": "This clip's system audio (screen or uploaded footage) volume override, with the same three states as `microphoneVolume`.", "example": null, "maximum": 2, "minimum": 0, "nullable": true, "type": "number" }, "transition": { "$ref": "#/components/schemas/ClipTransition" }, "updatedAt": { "description": "ISO 8601 datetime", "example": "2026-01-15T14:45:00.000Z", "format": "date-time", "type": "string" }, "videoId": { "description": "Video identifier", "example": "vid_abc123def456", "type": "string" } }, "required": [ "id", "videoId", "name", "order", "durationSeconds", "maxDurationSeconds", "cuts", "layoutSceneType", "background", "transition", "studioSound", "createdAt", "updatedAt" ], "type": "object" }, "ClipBackground": { "description": "Clip background. Use type = 'solid' with `color`, type = 'image' or 'video' with `sourceId` (from `POST /v1/sources`) or an exact catalog URL from `GET /v1/backgrounds`, or type = 'gradient' with `gradientColor1`, `gradientColor2`, `gradientAngle`.", "properties": { "color": { "description": "Hex color string. Required when type = 'solid'.", "example": "#000000ff", "nullable": true, "type": "string" }, "gradientAngle": { "description": "Linear gradient angle in degrees. Required when type = 'gradient'.", "example": 45, "maximum": 9007199254740991, "minimum": -9007199254740991, "nullable": true, "type": "integer" }, "gradientColor1": { "description": "Hex color string. Required when type = 'gradient'.", "example": "#ff0080ff", "nullable": true, "type": "string" }, "gradientColor2": { "description": "Hex color string. Required when type = 'gradient'.", "example": "#7928caff", "nullable": true, "type": "string" }, "imageUrl": { "description": "Hosted image URL. Present in responses and accepted as input only when copied exactly from `GET /v1/backgrounds`; otherwise pass `sourceId`.", "format": "uri", "nullable": true, "type": "string" }, "sourceId": { "description": "Source ID from `POST /v1/sources` (`kind: image` for type = 'image', `kind: video` for type = 'video'). Required for image/video backgrounds unless using an exact URL from `GET /v1/backgrounds`. Input-only.", "example": "su_abc123", "nullable": true, "type": "string" }, "type": { "description": "Background variant", "enum": [ "solid", "gradient", "image", "video" ], "example": "solid", "type": "string" }, "videoDurationSeconds": { "description": "Video background duration in seconds. Read-only: derived from the uploaded source or catalog entry on input.", "example": 12.4, "minimum": 0, "nullable": true, "type": "number" }, "videoUrl": { "description": "Hosted video URL. Present in responses and accepted as input only when copied exactly from `GET /v1/backgrounds`; otherwise pass `sourceId`.", "format": "uri", "nullable": true, "type": "string" } }, "required": [ "type" ], "type": "object" }, "ClipBackgroundOutput": { "additionalProperties": false, "description": "Clip background. Use type = 'solid' with `color`, type = 'image' or 'video' with `sourceId` (from `POST /v1/sources`) or an exact catalog URL from `GET /v1/backgrounds`, or type = 'gradient' with `gradientColor1`, `gradientColor2`, `gradientAngle`.", "properties": { "color": { "description": "Hex color string. Required when type = 'solid'.", "example": "#000000ff", "nullable": true, "type": "string" }, "gradientAngle": { "description": "Linear gradient angle in degrees. Required when type = 'gradient'.", "example": 45, "maximum": 9007199254740991, "minimum": -9007199254740991, "nullable": true, "type": "integer" }, "gradientColor1": { "description": "Hex color string. Required when type = 'gradient'.", "example": "#ff0080ff", "nullable": true, "type": "string" }, "gradientColor2": { "description": "Hex color string. Required when type = 'gradient'.", "example": "#7928caff", "nullable": true, "type": "string" }, "imageUrl": { "description": "Hosted image URL. Present in responses and accepted as input only when copied exactly from `GET /v1/backgrounds`; otherwise pass `sourceId`.", "format": "uri", "nullable": true, "type": "string" }, "sourceId": { "description": "Source ID from `POST /v1/sources` (`kind: image` for type = 'image', `kind: video` for type = 'video'). Required for image/video backgrounds unless using an exact URL from `GET /v1/backgrounds`. Input-only.", "example": "su_abc123", "nullable": true, "type": "string" }, "type": { "description": "Background variant", "enum": [ "solid", "gradient", "image", "video" ], "example": "solid", "type": "string" }, "videoDurationSeconds": { "description": "Video background duration in seconds. Read-only: derived from the uploaded source or catalog entry on input.", "example": 12.4, "minimum": 0, "nullable": true, "type": "number" }, "videoUrl": { "description": "Hosted video URL. Present in responses and accepted as input only when copied exactly from `GET /v1/backgrounds`; otherwise pass `sourceId`.", "format": "uri", "nullable": true, "type": "string" } }, "required": [ "type" ], "type": "object" }, "ClipLayout": { "additionalProperties": false, "description": "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.", "properties": { "durationMs": { "description": "Layout duration in ms. Omitted for clip-spanning layouts.", "example": 5000, "minimum": 0, "nullable": true, "type": "number" }, "id": { "description": "Layout ID", "type": "string" }, "layout": { "allOf": [ { "$ref": "#/components/schemas/ClipLayoutShape" } ], "description": "Structured layout for this section. Null when the underlying layout isn't expressible in the public structured shape (e.g. Custom layouts created in the editor).", "nullable": true }, "media": { "description": "B-roll media on this layout — one entry per filled slot (screen and/or camera). Empty on the base layout and on layouts whose underlying section carries no media. Each entry's `slot` says which slot it fills.", "items": { "$ref": "#/components/schemas/ClipMediaItem" }, "type": "array" }, "startTimeMs": { "description": "Layout start time in ms on the clip's playback timeline (cuts applied). Omitted for clip-spanning layouts.", "example": 0, "minimum": 0, "nullable": true, "type": "number" }, "transitionStyle": { "allOf": [ { "$ref": "#/components/schemas/LayoutTransitionStyle" } ], "description": "Transition into this layout. Omitted on the base layout, or when the section uses an internal style not exposed via the public API.", "nullable": true } }, "required": [ "id", "media" ], "type": "object" }, "ClipLayoutResponse": { "additionalProperties": false, "description": "A layout on a clip", "properties": { "layout": { "$ref": "#/components/schemas/ClipLayout" } }, "required": [ "layout" ], "type": "object" }, "ClipLayoutShape": { "description": "Structured layout description, discriminated by `kind`. Valid kinds depend on the clip's `layoutSceneType` and the video's aspect ratio; the server validates the kind+fields and returns a 400 if they don't fit.", "discriminator": { "mapping": { "camera-bubble": "#/components/schemas/CameraBubbleLayout", "camera-only": "#/components/schemas/CameraOnlyLayout", "fullscreen": "#/components/schemas/FullscreenLayout", "middle": "#/components/schemas/MiddleLayout", "screen-only": "#/components/schemas/ScreenOnlyLayout", "side-by-side": "#/components/schemas/SideBySideLayout", "tv-presenter": "#/components/schemas/TVPresenterLayout" }, "propertyName": "kind" }, "oneOf": [ { "$ref": "#/components/schemas/FullscreenLayout" }, { "$ref": "#/components/schemas/MiddleLayout" }, { "$ref": "#/components/schemas/SideBySideLayout" }, { "$ref": "#/components/schemas/TVPresenterLayout" }, { "$ref": "#/components/schemas/CameraBubbleLayout" }, { "$ref": "#/components/schemas/CameraOnlyLayout" }, { "$ref": "#/components/schemas/ScreenOnlyLayout" } ], "type": "object" }, "ClipMask": { "additionalProperties": false, "description": "A blur or highlight mask on a clip. Times are in ms on the clip's playback timeline (cuts applied). Internally the mask stays anchored to the footage, so it doesn't drift when cuts change later.", "properties": { "dimensions": { "$ref": "#/components/schemas/MaskDimensionsOutput" }, "durationMs": { "example": 2000, "minimum": 0, "type": "number" }, "id": { "description": "Mask ID", "example": "ly_abc123", "type": "string" }, "point": { "$ref": "#/components/schemas/MaskPointOutput" }, "startTimeMs": { "description": "Start time in ms on the clip's playback timeline (cuts applied)", "example": 1000, "minimum": 0, "type": "number" }, "type": { "enum": [ "blur", "highlight" ], "example": "blur", "type": "string" } }, "required": [ "id", "type", "startTimeMs", "durationMs", "point", "dimensions" ], "type": "object" }, "ClipMaskResponse": { "additionalProperties": false, "description": "A mask on a clip", "properties": { "mask": { "$ref": "#/components/schemas/ClipMask" } }, "required": [ "mask" ], "type": "object" }, "ClipMedia": { "description": "Media shown during a layout. `image` or `video`, each referencing a `sourceId` from `POST /v1/sources`.", "discriminator": { "mapping": { "image": "#/components/schemas/ClipMediaImage", "video": "#/components/schemas/ClipMediaVideo" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/components/schemas/ClipMediaImage" }, { "$ref": "#/components/schemas/ClipMediaVideo" } ], "type": "object" }, "ClipMediaImage": { "additionalProperties": false, "description": "Image media. The image fills the section's layer per the chosen layoutName.", "properties": { "slot": { "description": "Which slot the media fills: `screen` (the subject/main frame, the default) or `camera` (the bubble/presentation slot — a media bubble over the recording behind it). A `camera` slot requires a layout that renders the camera (e.g. camera-bubble, side-by-side, tv-presenter).", "enum": [ "screen", "camera" ], "type": "string" }, "sourceId": { "description": "Source ID from `POST /v1/sources` (`kind: image`).", "minLength": 1, "type": "string" }, "type": { "enum": [ "image" ], "type": "string" } }, "required": [ "type", "sourceId" ], "title": "ClipMediaImage", "type": "object" }, "ClipMediaItem": { "additionalProperties": false, "description": "Media on a layout, as returned in responses.", "properties": { "height": { "description": "Image height in pixels (image media only).", "maximum": 9007199254740991, "minimum": -9007199254740991, "nullable": true, "type": "integer" }, "imageUrl": { "description": "Hosted image URL, for image media. Read-only: not accepted as input — pass `sourceId` instead.", "nullable": true, "type": "string" }, "slot": { "description": "Which slot the media fills: `screen` (the subject/main frame, the default) or `camera` (the bubble/presentation slot — a media bubble over the recording behind it). A `camera` slot requires a layout that renders the camera (e.g. camera-bubble, side-by-side, tv-presenter).", "enum": [ "screen", "camera" ], "type": "string" }, "sourceId": { "description": "Source ID the media was created from. Absent for image media added in the editor.", "nullable": true, "type": "string" }, "type": { "enum": [ "image", "video" ], "type": "string" }, "width": { "description": "Image width in pixels (image media only).", "maximum": 9007199254740991, "minimum": -9007199254740991, "nullable": true, "type": "integer" } }, "required": [ "type" ], "type": "object" }, "ClipMediaVideo": { "additionalProperties": false, "description": "Video media.", "properties": { "slot": { "description": "Which slot the media fills: `screen` (the subject/main frame, the default) or `camera` (the bubble/presentation slot — a media bubble over the recording behind it). A `camera` slot requires a layout that renders the camera (e.g. camera-bubble, side-by-side, tv-presenter).", "enum": [ "screen", "camera" ], "type": "string" }, "sourceId": { "description": "Source ID from `POST /v1/sources`.", "minLength": 1, "type": "string" }, "type": { "enum": [ "video" ], "type": "string" } }, "required": [ "type", "sourceId" ], "title": "ClipMediaVideo", "type": "object" }, "ClipMouseEvent": { "additionalProperties": false, "description": "A cursor position or click recorded with the clip's screen recording, mapped onto the clip's playback timeline", "properties": { "clicked": { "description": "True when a mouse button went down at this event. Recordings sample the button state continuously, so a drag reports true only on the initial press — the samples while the button stays held are returned as move events.", "type": "boolean" }, "isLocalEvent": { "description": "True when the event happened inside Tella's own recorder UI (e.g. the recording controls) rather than the recorded content", "type": "boolean" }, "timestampMs": { "description": "Time in ms on the clip's playback timeline (cuts applied)", "example": 1000, "minimum": 0, "type": "number" }, "xPct": { "description": "Horizontal cursor position as a percentage of the screen recording's width (0-100) — the same coordinate space as zoom focus points.", "example": 42.5, "type": "number" }, "yPct": { "description": "Vertical cursor position as a percentage of the screen recording's height (0-100)", "example": 63.1, "type": "number" } }, "required": [ "timestampMs", "xPct", "yPct", "clicked", "isLocalEvent" ], "type": "object" }, "ClipOverlay": { "additionalProperties": false, "description": "An image or video overlay on a clip.", "properties": { "dimensions": { "$ref": "#/components/schemas/OverlayDimensionsOutput" }, "durationMs": { "example": 5000, "minimum": 0, "type": "number" }, "id": { "description": "Overlay ID", "example": "ly_abc123", "type": "string" }, "imageUrl": { "description": "Hosted image URL, for image overlays. Read-only: not accepted as input — pass `sourceId` instead.", "nullable": true, "type": "string" }, "name": { "example": "Logo", "nullable": true, "type": "string" }, "point": { "$ref": "#/components/schemas/OverlayPointOutput" }, "sourceId": { "description": "Source ID the overlay was created from.", "example": "su_abc123", "nullable": true, "type": "string" }, "startTimeMs": { "description": "Start time. Milliseconds on the clip playback timeline (with cuts applied) — the same timeline as the cut transcript.", "example": 1000, "minimum": 0, "type": "number" }, "transition": { "allOf": [ { "$ref": "#/components/schemas/TransitionStyle" } ], "description": "Intro/outro animation: `smooth` fades the overlay in at its start and out at its end, `hard_cut` pops it in and out. New overlays start on `hard_cut`.", "example": "hard_cut" }, "type": { "enum": [ "image", "video" ], "example": "image", "type": "string" } }, "required": [ "id", "type", "startTimeMs", "durationMs", "point", "dimensions", "transition" ], "type": "object" }, "ClipOverlayResponse": { "additionalProperties": false, "description": "An overlay on a clip", "properties": { "overlay": { "$ref": "#/components/schemas/ClipOverlay" } }, "required": [ "overlay" ], "type": "object" }, "ClipSoundEffect": { "additionalProperties": false, "description": "A sound effect on a clip.", "properties": { "durationMs": { "example": 3000, "minimum": 0, "type": "number" }, "id": { "description": "Sound effect ID", "example": "ly_abc123", "type": "string" }, "name": { "example": "Whoosh", "nullable": true, "type": "string" }, "sourceId": { "example": "su_abc123", "nullable": true, "type": "string" }, "startTimeMs": { "description": "Start time. Milliseconds on the clip playback timeline (with cuts applied) — the same timeline as the cut transcript.", "example": 1000, "minimum": 0, "type": "number" }, "volume": { "description": "Playback volume (1 = original).", "example": 1, "type": "number" } }, "required": [ "id", "startTimeMs", "durationMs", "volume" ], "type": "object" }, "ClipSoundEffectResponse": { "additionalProperties": false, "description": "A sound effect on a clip", "properties": { "soundEffect": { "$ref": "#/components/schemas/ClipSoundEffect" } }, "required": [ "soundEffect" ], "type": "object" }, "ClipSource": { "additionalProperties": false, "description": "An underlying source used by a clip", "properties": { "dimensions": { "additionalProperties": false, "description": "Native pixel dimensions of the source.", "example": { "height": 1080, "width": 1920 }, "nullable": true, "properties": { "height": { "exclusiveMinimum": true, "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, "width": { "exclusiveMinimum": true, "maximum": 9007199254740991, "minimum": 0, "type": "integer" } }, "required": [ "width", "height" ], "type": "object" }, "durationMs": { "description": "Source duration in ms", "example": 12450, "nullable": true, "type": "number" }, "effectiveVolume": { "description": "The volume the source actually plays at in this clip: its override when set, otherwise the video-level volume it inherits (`microphoneVolume` for webcam audio, `systemAudioVolume` for everything else).", "example": 1, "maximum": 2, "minimum": 0, "type": "number" }, "id": { "description": "Source ID", "example": "su_abc", "type": "string" }, "medium": { "description": "Recording medium (Mic, CameraMic, Screen, ScreenMic, Video, None)", "example": "ScreenMic", "type": "string" }, "url": { "description": "Direct URL to the source media (when available)", "nullable": true, "type": "string" }, "volume": { "description": "This clip's volume override for the source, or null when it plays at the video's `microphoneVolume`/`systemAudioVolume`.", "example": 0.4, "maximum": 2, "minimum": 0, "nullable": true, "type": "number" } }, "required": [ "id", "medium", "volume", "effectiveVolume" ], "type": "object" }, "ClipTextOverlay": { "additionalProperties": false, "description": "A text overlay on a clip. Unlike image and video overlays it references no source — the copy and its font live on the overlay itself.", "properties": { "background": { "allOf": [ { "$ref": "#/components/schemas/TextOverlayBackgroundOutput" } ], "description": "Background behind the text. Overlays with no visible box report a solid #00000000." }, "backgroundShape": { "$ref": "#/components/schemas/TextOverlayBackgroundShape" }, "color": { "description": "Hex color in #RRGGBB or #RRGGBBAA form. Responses use uppercase #RRGGBBAA.", "example": "#FFFFFFFF", "pattern": "^#(?:[0-9A-Fa-f]{6}|[0-9A-Fa-f]{8})$", "type": "string" }, "dimensions": { "$ref": "#/components/schemas/OverlayDimensionsOutput" }, "durationMs": { "example": 5000, "minimum": 0, "type": "number" }, "fontFamily": { "description": "The overlay's font family. Normally one of the catalog families accepted on write, but overlays created before that catalog can report another bundled family, such as `Graphik`.", "example": "Inter", "type": "string" }, "fontSize": { "description": "Font size in artboard pixels — absolute, like `dimensions`, so text keeps its size relative to the frame. Renderers scale it by their render scale factor.", "example": 81, "exclusiveMinimum": true, "minimum": 0, "type": "number" }, "fontWeight": { "description": "Variable-font weight axis — 100 (thin) to 900 (black).", "example": 500, "type": "number" }, "fontWidth": { "description": "Variable-font width axis, as a percentage — 100 is normal, 50 ultra-condensed, 150 extra-expanded.", "example": 100, "type": "number" }, "id": { "description": "Text overlay ID", "example": "ly_abc123", "type": "string" }, "point": { "$ref": "#/components/schemas/OverlayPointOutput" }, "startTimeMs": { "description": "Start time. Milliseconds on the clip playback timeline (with cuts applied) — the same timeline as the cut transcript.", "example": 1000, "minimum": 0, "type": "number" }, "text": { "example": "Welcome back", "type": "string" }, "textAlign": { "$ref": "#/components/schemas/TextOverlayTextAlign" }, "transition": { "allOf": [ { "$ref": "#/components/schemas/TransitionStyle" } ], "description": "Intro/outro animation: `smooth` fades the text in at its start and out at its end, `hard_cut` pops it in and out. New text overlays start on `hard_cut`.", "example": "hard_cut" } }, "required": [ "id", "text", "fontFamily", "fontSize", "color", "fontWeight", "fontWidth", "textAlign", "background", "backgroundShape", "startTimeMs", "durationMs", "point", "dimensions", "transition" ], "type": "object" }, "ClipTextOverlayResponse": { "additionalProperties": false, "description": "A text overlay on a clip", "properties": { "textOverlay": { "$ref": "#/components/schemas/ClipTextOverlay" } }, "required": [ "textOverlay" ], "type": "object" }, "ClipTranscriptResponse": { "additionalProperties": false, "description": "Clip transcript — what viewers hear.", "properties": { "words": { "description": "Words on the playback timeline (cuts removed, times relative to the clip's playback start). Word indices are stable — they don't shift when cuts change; words inside cuts are simply absent.", "items": { "$ref": "#/components/schemas/TranscriptWord" }, "type": "array" } }, "required": [ "words" ], "type": "object" }, "ClipTransition": { "description": "How a clip enters from the previous one. `default` inherits the video's `defaultClipTransition`; `smooth` and `hard_cut` override it for this clip. The first clip in a video has nothing to transition from.", "enum": [ "default", "smooth", "hard_cut" ], "example": "default", "type": "string" }, "ClipZoom": { "additionalProperties": false, "description": "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.", "properties": { "durationMs": { "description": "Duration in ms of playback. 0 when the zoom's footage is entirely cut out.", "example": 2000, "minimum": 0, "type": "number" }, "focusPoint": { "allOf": [ { "$ref": "#/components/schemas/ZoomFocusPointOutput" } ], "nullable": true }, "id": { "description": "Zoom ID", "example": "ef_abc123", "type": "string" }, "scale": { "description": "Magnification factor (1 = no zoom, 3.5 = max).", "example": 2, "maximum": 3.5, "minimum": 1, "nullable": true, "type": "number" }, "startTimeMs": { "description": "Start time in ms on the clip's playback timeline (cuts applied)", "example": 1000, "minimum": 0, "type": "number" }, "type": { "description": "`manualZoom` zooms into a fixed `focusPoint` on the screen. `trackingZoom` automatically follows the cursor in the screen recording.", "enum": [ "manualZoom", "trackingZoom" ], "example": "manualZoom", "type": "string" } }, "required": [ "id", "type", "startTimeMs", "durationMs" ], "type": "object" }, "ClipZoomResponse": { "additionalProperties": false, "description": "A zoom on a clip", "properties": { "zoom": { "$ref": "#/components/schemas/ClipZoom" } }, "required": [ "zoom" ], "type": "object" }, "Collaborator": { "additionalProperties": false, "description": "A collaborator on a video", "properties": { "email": { "description": "User's email address", "example": "editor@example.com", "format": "email", "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$", "type": "string" }, "name": { "description": "User's display name", "example": "Jane Doe", "type": "string" }, "role": { "description": "Role to grant. Allowed values: 'editor' or 'viewer'.", "enum": [ "editor", "viewer" ], "example": "editor", "type": "string" }, "userId": { "description": "User identifier", "example": "usr_abc123def456", "type": "string" } }, "required": [ "userId", "email", "name", "role" ], "type": "object" }, "CreateEndpointRequest": { "description": "Request body for creating a webhook endpoint", "properties": { "filterTypes": { "description": "Event types to subscribe to (e.g., video.created, export.ready)", "example": [ "video.created", "export.ready" ], "items": { "type": "string" }, "type": "array" }, "url": { "description": "The URL where webhook events will be sent", "example": "https://example.com/webhooks/tella", "format": "uri", "type": "string" } }, "required": [ "url", "filterTypes" ], "type": "object" }, "CreateEndpointResponse": { "additionalProperties": false, "description": "Response when a webhook endpoint is created", "properties": { "id": { "description": "Unique identifier for the webhook endpoint", "example": "ep_abc123def456", "type": "string" }, "secret": { "description": "Signing secret for verifying webhook payloads (shown only once)", "example": "whsec_xyz789...", "type": "string" } }, "required": [ "id", "secret" ], "type": "object" }, "CreateLibraryItemRequest": { "additionalProperties": false, "description": "Save an uploaded source to the library so it can be listed and reused later", "properties": { "name": { "description": "Display name shown in the library. Defaults to the item's type.", "example": "Intro camera take", "maxLength": 255, "minLength": 1, "type": "string" }, "scope": { "allOf": [ { "$ref": "#/components/schemas/LibraryScope" } ], "description": "Where to save the item (default: `private`). `workspace` shares it with everyone in the workspace and requires an owner or member role; viewers get a 403." }, "sourceId": { "description": "Source ID from `POST /v1/sources`, with the bytes already uploaded to its `uploadUrl`", "example": "su_abc123def456", "type": "string" }, "type": { "description": "Expected item type. Optional — the type is taken from the source's own kind; supplying a value that disagrees is an error.", "enum": [ "image", "video", "sound-effect" ], "type": "string" } }, "required": [ "sourceId" ], "type": "object" }, "CreateLibraryItemResponse": { "additionalProperties": false, "description": "The newly created library item", "properties": { "item": { "$ref": "#/components/schemas/LibraryItem" } }, "required": [ "item" ], "type": "object" }, "CreatePlaylistGroupRequest": { "description": "Request to create a playlist group", "properties": { "emoji": { "description": "Unicode emoji character for the group", "example": "📁", "maxLength": 10, "type": "string" }, "name": { "description": "Playlist group name", "example": "Marketing", "maxLength": 255, "minLength": 1, "type": "string" }, "visibility": { "allOf": [ { "$ref": "#/components/schemas/PlaylistGroupVisibility" } ], "description": "Where the group lives. Default: personal" } }, "required": [ "name" ], "type": "object" }, "CreatePlaylistRequest": { "additionalProperties": false, "description": "Request body for creating a new playlist", "properties": { "description": { "description": "Playlist description", "example": "A collection of tutorial videos", "maxLength": 5000, "type": "string" }, "emoji": { "description": "Unicode emoji character for the playlist", "example": "🎬", "maxLength": 10, "type": "string" }, "linkScope": { "allOf": [ { "$ref": "#/components/schemas/PlaylistLinkScope" } ], "description": "Access level (default: public)" }, "name": { "description": "Playlist name (required)", "example": "Product Tutorials", "maxLength": 255, "minLength": 1, "type": "string" }, "password": { "description": "Password for viewing. Required when linkScope is 'password', ignored otherwise.", "example": "secretpassword", "maxLength": 255, "minLength": 1, "type": "string" }, "searchEngineIndexingEnabled": { "description": "Allow search engine indexing (default: false)", "example": false, "type": "boolean" }, "visibility": { "allOf": [ { "$ref": "#/components/schemas/PlaylistVisibility" } ], "description": "Share with org or keep personal (default: personal)" } }, "required": [ "name" ], "type": "object" }, "CreateSourceRequest": { "additionalProperties": false, "description": "Create a new source upload (video, audio, or image). Returns a pre-signed S3 URL to PUT the bytes to, plus a `sourceId` to reference from clips, layouts, overlays, backgrounds, and sound effects.", "properties": { "duration": { "description": "Duration in seconds. Required for `video` and `audio`; ignored for `image`.", "exclusiveMinimum": true, "minimum": 0, "type": "number" }, "height": { "description": "Height in pixels. Required for `video` and `image`; omit for `audio`.", "exclusiveMinimum": true, "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, "kind": { "description": "Source kind: `video` (default), `audio` (e.g. sound effects), or `image`.", "enum": [ "video", "audio", "image" ], "type": "string" }, "width": { "description": "Width in pixels. Required for `video` and `image`; omit for `audio`.", "exclusiveMinimum": true, "maximum": 9007199254740991, "minimum": 0, "type": "integer" } }, "type": "object" }, "CreateSourceResponse": { "additionalProperties": false, "properties": { "expiresAt": { "description": "ISO-8601 timestamp at which `uploadUrl` stops accepting uploads.", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$", "type": "string" }, "sourceId": { "description": "ID of the new source.", "type": "string" }, "uploadUrl": { "description": "Pre-signed S3 URL. PUT the file bytes here (single PUT, max ~5GB). Upload the file as-is: any common container is accepted (MP4, MOV, WebM, MP3, WAV, M4A, …) — the `.mp4` in the URL path is just the storage key, not a container requirement.", "format": "uri", "type": "string" } }, "required": [ "sourceId", "uploadUrl", "expiresAt" ], "type": "object" }, "CreateTagRequest": { "additionalProperties": false, "description": "Request body for creating a tag", "properties": { "color": { "allOf": [ { "$ref": "#/components/schemas/TagColor" } ], "description": "Hex color (default: derived deterministically from the name)" }, "description": { "description": "Optional tag description", "example": "Product demo recordings", "maxLength": 5000, "type": "string" }, "name": { "description": "Tag name", "example": "Demo", "maxLength": 255, "minLength": 1, "type": "string" }, "scope": { "allOf": [ { "$ref": "#/components/schemas/TagScope" } ], "description": "Tag visibility (default: workspace)" } }, "required": [ "name" ], "type": "object" }, "CreateTagResponse": { "additionalProperties": false, "description": "The created tag", "properties": { "tag": { "$ref": "#/components/schemas/Tag" } }, "required": [ "tag" ], "type": "object" }, "CreateVideoRequest": { "additionalProperties": false, "description": "Request body for creating a video from an uploaded source.", "properties": { "allowedEmbedDomains": { "description": "Restrict embedding to these domains only (Premium feature). Empty array allows all domains.", "example": [ "example.com", "mysite.org" ], "items": { "type": "string" }, "type": "array" }, "captionGrouping": { "description": "How subtitle text is grouped: sentence chunks or one word at a time.", "enum": [ "chunked", "singleWord" ], "type": "string" }, "captionPosition": { "allOf": [ { "$ref": "#/components/schemas/CaptionPosition" } ], "description": "Normalized subtitle position; null restores automatic placement. Applies if subtitles are enabled on the video.", "nullable": true }, "captionSize": { "description": "Subtitle text size. Applies if subtitles are enabled on the video.", "enum": [ "small", "medium", "large" ], "type": "string" }, "captionStyle": { "allOf": [ { "$ref": "#/components/schemas/CaptionStyle" } ] }, "captionsDefaultEnabled": { "description": "Show subtitles to viewers by default", "example": true, "type": "boolean" }, "commentEmailsEnabled": { "description": "Send email notifications for new comments", "example": false, "type": "boolean" }, "commentsEnabled": { "description": "Allow viewers to comment", "example": true, "type": "boolean" }, "cursor": { "allOf": [ { "$ref": "#/components/schemas/CursorSettingsUpdate" } ] }, "customThumbnailURL": { "description": "Custom thumbnail image URL", "example": "https://example.com/custom-thumbnail.jpg", "format": "uri", "type": "string" }, "defaultClipTransition": { "allOf": [ { "$ref": "#/components/schemas/TransitionStyle" } ], "description": "How each clip enters from the previous one. A clip can override it with its own `transition`; see `PATCH /v1/videos/{id}/clips/{clipId}`.", "example": "hard_cut" }, "defaultPlaybackRate": { "description": "Default playback speed (0.5-2.0). Viewers can still adjust.", "example": 1, "maximum": 2, "minimum": 0.5, "type": "number" }, "description": { "description": "Video description", "example": "Updated description for the video", "maxLength": 5000, "type": "string" }, "dimensions": { "description": "Canvas size in pixels. Changing it also remaps every clip and section layout to a ratio-appropriate equivalent (clips using a custom layout fall back to a standard one), exactly like switching size in the editor's Setup → Size. No-op when the video already has the requested size. The editor's presets: 1920x1080 (16:9), 1920x1200 (16:10), 1440x1080 (4:3), 1080x1080 (1:1), 1080x1350 (4:5), 1080x1920 (9:16).", "example": { "height": 1920, "width": 1080 }, "properties": { "height": { "description": "Canvas height in pixels", "example": 1920, "maximum": 4096, "minimum": 16, "type": "number" }, "width": { "description": "Canvas width in pixels", "example": 1080, "maximum": 4096, "minimum": 16, "type": "number" } }, "required": [ "width", "height" ], "type": "object" }, "downloadsEnabled": { "description": "Allow viewers to download the video", "example": true, "type": "boolean" }, "linkScope": { "description": "Access level: public (anyone with link), private (org members only), password (requires password), embedonly (only viewable when embedded)", "enum": [ "public", "private", "password", "embedonly" ], "example": "public", "type": "string" }, "microphoneVolume": { "description": "Volume of the microphone (webcam) audio across the whole video. 1 is the recorded level, 0 mutes it, 2 doubles it. Clips that set their own `microphoneVolume` keep it — change or clear those with `PATCH /v1/videos/{id}/clips/{clipId}`.", "example": 1.2, "maximum": 2, "minimum": 0, "type": "number" }, "motionBlur": { "description": "Blur fast zoom, pan, and cursor movement. Defaults on for new videos.", "example": true, "type": "boolean" }, "name": { "description": "Video title", "example": "Updated Video Title", "maxLength": 255, "minLength": 1, "type": "string" }, "password": { "description": "Password for viewing. Required when linkScope is 'password', ignored otherwise.", "example": "secretpassword", "maxLength": 255, "minLength": 1, "type": "string" }, "publishDateEnabled": { "description": "Show publish date on video page", "example": true, "type": "boolean" }, "rawDownloadsEnabled": { "description": "Allow viewers to download raw source files", "example": false, "type": "boolean" }, "searchEngineIndexingEnabled": { "description": "Allow search engines to index the video page", "example": true, "type": "boolean" }, "shrinkCameraDuringZooms": { "description": "Shrink camera bubbles while a zoom is active. Defaults on.", "example": true, "type": "boolean" }, "sourceId": { "description": "Source ID from POST /v1/sources (kind: 'video'). Upload the video bytes to the source's uploadUrl first; the source becomes the new video's first clip.", "example": "su_abc123def456", "minLength": 1, "type": "string" }, "studioSound": { "description": "Studio Sound (AI audio enhancement) master switch. Enabling it also starts generating the enhanced audio tracks in the background; playback and exports use them once ready and fall back to the raw audio until then.", "example": true, "type": "boolean" }, "subtitlesEnabled": { "description": "Allow viewers to enable subtitles", "example": true, "type": "boolean" }, "systemAudioVolume": { "description": "Volume of the system/screen audio across the whole video — everything that is not microphone audio. 1 is the recorded level, 0 mutes it, 2 doubles it. Clips that set their own `systemAudioVolume` keep it — change or clear those with `PATCH /v1/videos/{id}/clips/{clipId}`.", "example": 0.4, "maximum": 2, "minimum": 0, "type": "number" }, "transcriptsEnabled": { "description": "Show transcript panel to viewers", "example": true, "type": "boolean" }, "viewCountEnabled": { "description": "Show view count on video page", "example": true, "type": "boolean" } }, "required": [ "sourceId" ], "type": "object" }, "CropBox": { "additionalProperties": false, "description": "Crop insets in source pixels", "properties": { "bottom": { "minimum": 0, "type": "number" }, "left": { "minimum": 0, "type": "number" }, "right": { "minimum": 0, "type": "number" }, "top": { "minimum": 0, "type": "number" } }, "required": [ "top", "right", "bottom", "left" ], "type": "object" }, "CursorSettings": { "additionalProperties": false, "description": "Animated cursor settings", "properties": { "clickRipple": { "description": "Show a ripple on mouse clicks. Defaults off for new videos.", "example": false, "type": "boolean" }, "hideWhenInactive": { "description": "Fade the animated cursor out while inactive and back in when activity resumes.", "example": false, "type": "boolean" }, "returnToStart": { "description": "Move the cursor back to its opening position at the end for cleaner loops.", "example": false, "type": "boolean" }, "size": { "description": "Animated cursor size multiplier.", "example": 3.05, "maximum": 6, "minimum": 0.5, "type": "number" }, "smoothing": { "description": "Smooth cursor movement. Defaults off for new videos.", "example": false, "type": "boolean" }, "style": { "$ref": "#/components/schemas/CursorStyle" } }, "required": [ "style", "size", "smoothing", "clickRipple", "hideWhenInactive", "returnToStart" ], "type": "object" }, "CursorSettingsUpdate": { "additionalProperties": false, "description": "Animated cursor settings to update. Omitted nested fields keep their current values.", "properties": { "clickRipple": { "description": "Show a ripple on mouse clicks. Defaults off for new videos.", "example": false, "type": "boolean" }, "hideWhenInactive": { "description": "Fade the animated cursor out while inactive and back in when activity resumes.", "example": false, "type": "boolean" }, "returnToStart": { "description": "Move the cursor back to its opening position at the end for cleaner loops.", "example": false, "type": "boolean" }, "size": { "description": "Animated cursor size multiplier.", "example": 3.05, "maximum": 6, "minimum": 0.5, "type": "number" }, "smoothing": { "description": "Smooth cursor movement. Defaults off for new videos.", "example": false, "type": "boolean" }, "style": { "allOf": [ { "$ref": "#/components/schemas/CursorStyle" } ] } }, "type": "object" }, "CursorStyle": { "description": "Animated cursor artwork. mac is the pre-Tahoe style; macTahoe and macGoldenGate match those macOS generations; windows and touch use platform-specific artwork.", "enum": [ "mac", "macTahoe", "macGoldenGate", "windows", "touch" ], "example": "macTahoe", "type": "string" }, "Cut": { "description": "A range of the raw recording removed from playback. Cut definitions are the one place raw-recording coordinates appear: replacing the cut set describes the playback timeline you'd get after clearing all cuts. Cuts are always undoable — replace with `[]` to restore everything.", "properties": { "durationMs": { "description": "Length of the cut, in milliseconds", "example": 750, "exclusiveMinimum": true, "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, "startTimeMs": { "description": "Start of the cut, in ms of the raw recording", "example": 1500, "maximum": 9007199254740991, "minimum": 0, "type": "integer" } }, "required": [ "startTimeMs", "durationMs" ], "type": "object" }, "CutClipByTranscriptRequest": { "additionalProperties": false, "description": "Cut one or more ranges from the clip by referencing word indices in the transcript. Indices are stable across cuts (already-cut words are simply absent). The server resolves each range to exact word times and merges the resulting cuts.", "properties": { "wordRanges": { "description": "Word ranges to cut. Each range's start and end ms are read directly from the transcript — no padding is applied.", "items": { "$ref": "#/components/schemas/TranscriptWordRange" }, "minItems": 1, "type": "array" } }, "required": [ "wordRanges" ], "type": "object" }, "CutClipRequest": { "additionalProperties": false, "description": "Cut one or more time ranges from the clip in a single request. Provide either `cuts: [{fromMs, toMs}, ...]` (preferred) or the legacy single-range `fromMs`/`toMs` pair. Overlapping or adjacent ranges are merged into the clip's existing cuts.", "properties": { "cuts": { "description": "Time ranges to cut from the clip. Merged with the clip's existing cuts; overlapping or adjacent ranges are joined.", "items": { "$ref": "#/components/schemas/CutRange" }, "minItems": 1, "type": "array" }, "fromMs": { "description": "Single-range shortcut for `cuts: [{fromMs, toMs}]`. Use `cuts` for multiple ranges.", "example": 2000, "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, "toMs": { "description": "Single-range shortcut for `cuts: [{fromMs, toMs}]`. Use `cuts` for multiple ranges.", "example": 3500, "exclusiveMinimum": true, "maximum": 9007199254740991, "minimum": 0, "type": "integer" } }, "type": "object" }, "CutOutput": { "additionalProperties": false, "description": "A range of the raw recording removed from playback. Cut definitions are the one place raw-recording coordinates appear: replacing the cut set describes the playback timeline you'd get after clearing all cuts. Cuts are always undoable — replace with `[]` to restore everything.", "properties": { "durationMs": { "description": "Length of the cut, in milliseconds", "example": 750, "exclusiveMinimum": true, "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, "startTimeMs": { "description": "Start of the cut, in ms of the raw recording", "example": 1500, "maximum": 9007199254740991, "minimum": 0, "type": "integer" } }, "required": [ "startTimeMs", "durationMs" ], "type": "object" }, "CutRange": { "description": "A single time range to cut from the clip, in ms on the clip's playback timeline (what you currently see and hear — the same timeline as the transcript and detected silences). All ranges in one request are resolved against the playback timeline as it is when the request starts.", "properties": { "fromMs": { "description": "Start of the range to cut, in ms on the clip's playback timeline.", "example": 2000, "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, "toMs": { "description": "End of the range to cut, in ms on the clip's playback timeline. Clamped to the clip's playable duration.", "example": 3500, "exclusiveMinimum": true, "maximum": 9007199254740991, "minimum": 0, "type": "integer" } }, "required": [ "fromMs", "toMs" ], "type": "object" }, "DeleteEndpointResponse": { "additionalProperties": false, "description": "Response when a webhook endpoint is deleted", "properties": { "id": { "description": "ID of the deleted endpoint", "example": "ep_abc123def456", "type": "string" } }, "required": [ "id" ], "type": "object" }, "DuplicateClipRequest": { "additionalProperties": false, "description": "Request body for duplicating a clip", "properties": { "name": { "description": "Name for the duplicated clip (defaults to the source clip name)", "example": "Intro (copy)", "maxLength": 255, "minLength": 1, "type": "string" }, "order": { "description": "Position to insert the new clip (defaults to right after the source)", "example": 1, "maximum": 9007199254740991, "minimum": 0, "type": "integer" } }, "type": "object" }, "DuplicateVideoRequest": { "additionalProperties": false, "description": "Request body for duplicating a video", "properties": { "name": { "description": "Name for the duplicated video. Defaults to original name with ' (Copy)' suffix.", "example": "My Video (Copy)", "maxLength": 255, "minLength": 1, "type": "string" }, "trim": { "allOf": [ { "$ref": "#/components/schemas/TrimRequest" } ], "description": "Optional trim parameters. Specify startTime+endTime for time range trim (duration must be at least 1 second), or chapterIndex to extract a specific chapter." } }, "type": "object" }, "EndpointSecretResponse": { "additionalProperties": false, "description": "The webhook signing secret", "properties": { "key": { "description": "The signing secret for verifying webhook payloads", "example": "whsec_xyz789...", "type": "string" } }, "required": [ "key" ], "type": "object" }, "ErrorResponse": { "additionalProperties": false, "description": "Standard error response format", "properties": { "docsUrl": { "description": "Link to Tella API documentation", "example": "https://docs.tella.com/", "format": "uri", "type": "string" }, "error": { "description": "Machine-readable error code", "enum": [ "bad_request", "unauthorized", "forbidden", "not_found", "rate_limited", "server_error", "not_implemented" ], "example": "not_found", "type": "string" }, "message": { "description": "Human-readable error message", "example": "Resource not found", "type": "string" } }, "required": [ "error", "message", "docsUrl" ], "type": "object" }, "ExportStatus": { "additionalProperties": false, "description": "Status of a video export job", "properties": { "downloadUrl": { "description": "Download URL when export is completed, null otherwise", "example": "https://cdn.tella.tv/exports/vid_abc123/video.mp4", "format": "uri", "nullable": true, "type": "string" }, "exportId": { "description": "Unique identifier for the export job", "example": "Export-Story-vid_abc123def456/2026-01-15T10:00:00Z/Story/1920x1080/30FPS", "type": "string" }, "progress": { "description": "Export progress percentage (0-100), null if not started", "example": 100, "maximum": 100, "minimum": 0, "nullable": true, "type": "number" }, "status": { "description": "Current export status", "enum": [ "queued", "running", "completed", "failed" ], "example": "completed", "type": "string" }, "updatedAt": { "description": "ISO 8601 datetime of last status update", "example": "2024-01-15T15:00:00.000Z", "format": "date-time", "type": "string" } }, "required": [ "exportId", "status", "progress", "downloadUrl", "updatedAt" ], "type": "object" }, "ExportVideoRequest": { "additionalProperties": false, "description": "Request body for exporting a video", "properties": { "fps": { "description": "Frames per second. 60fps may require paid plan.", "enum": [ "30", "60" ], "example": "30", "type": "string" }, "granularity": { "description": "Export granularity: video (full video), clips (one composed file per clip), tracks (camera and screen files per clip with timeline cuts applied), raw (original recordings without cuts)", "enum": [ "video", "clips", "tracks", "raw" ], "example": "video", "type": "string" }, "resolution": { "description": "Export resolution. Default is 1080p.", "enum": [ "1080p", "4k" ], "example": "1080p", "type": "string" }, "speed": { "description": "Playback speed multiplier", "enum": [ "1", "2", "0.5", "0.75", "1.25", "1.5", "1.75" ], "example": "1", "type": "string" }, "subtitles": { "description": "Burn subtitles into the video", "example": false, "type": "boolean" } }, "type": "object" }, "ExportVideoResponse": { "additionalProperties": false, "description": "Response containing export status", "properties": { "export": { "$ref": "#/components/schemas/ExportStatus" } }, "required": [ "export" ], "type": "object" }, "FullscreenLayout": { "additionalProperties": false, "description": "Single-layer fullscreen. Camera-subject clips take an optional `style` (regular/stretch); basic-subject clips take an optional `screenFit`.", "properties": { "kind": { "enum": [ "fullscreen" ], "type": "string" }, "screenFit": { "description": "Only honoured for basic-subject clips (Tella renders the screen fullscreen). Defaults to cover.", "enum": [ "cover", "letterbox" ], "type": "string" }, "style": { "description": "Only honoured for camera-subject clips: `regular` (default) is plain fullscreen, `stretch` stretches the subject. Ignored on basic-subject clips.", "enum": [ "regular", "stretch" ], "type": "string" } }, "required": [ "kind" ], "title": "Fullscreen", "type": "object" }, "GenerateAutoLayoutsRequest": { "additionalProperties": false, "description": "Let AI watch the clip and lay it out — the API twin of the editor's \"Auto layouts\". Replaces the clip's existing layouts with the generated ones.", "properties": { "instructions": { "description": "Free-form guidance for the AI, e.g. \"keep the camera visible the whole time\" or \"punch in whenever a menu is opened\".", "example": "Keep the camera visible the whole time", "maxLength": 2000, "type": "string" }, "style": { "description": "Editing style guiding the AI's layout choices. Omit to let the AI pick one based on the clip's content.", "enum": [ "product-demo-portrait", "product-demo-round", "product-demo-square", "product-demo-wide", "presentation-tv-show", "presentation-portrait", "tutorial-round", "tutorial-square", "intro", "outro", "intro-and-outro" ], "example": "product-demo-round", "type": "string" } }, "type": "object" }, "GenerateAutoLayoutsResponse": { "additionalProperties": false, "description": "Layouts generated by AI for the clip", "properties": { "editingStyle": { "description": "The editing style the AI chose (or was told to use).", "enum": [ "product-demo-portrait", "product-demo-round", "product-demo-square", "product-demo-wide", "presentation-tv-show", "presentation-portrait", "tutorial-round", "tutorial-square", "intro", "outro", "intro-and-outro" ], "example": "product-demo-round", "nullable": true, "type": "string" }, "layouts": { "description": "The generated time-ranged layouts. The clip's base layout is also updated; fetch it via the layouts list endpoint.", "items": { "$ref": "#/components/schemas/ClipLayout" }, "type": "array" } }, "required": [ "layouts" ], "type": "object" }, "GenerateAutoZoomsRequest": { "additionalProperties": false, "description": "Automatically generate tracking zooms from the mouse clicks in the clip's screen recording — the API twin of the editor's \"Generate zooms\". Warning: by default this replaces the clip's existing tracking zooms (see `replaceExisting`).", "properties": { "intensity": { "description": "How aggressively to zoom. `slow` opens fewer, longer windows; `fast` opens shorter, tighter ones at a higher scale. Defaults to `medium`.", "enum": [ "slow", "medium", "fast" ], "example": "medium", "type": "string" }, "replaceExisting": { "description": "Defaults to true: the clip's existing tracking zooms are REMOVED before the generated ones are added, so repeated calls regenerate instead of stacking. Pass false to keep existing tracking zooms. Manual zooms are never touched.", "example": true, "type": "boolean" }, "scale": { "description": "Override the magnification factor (1 = no zoom, 3.5 = max). Defaults to the intensity preset's scale (1.5 for slow/medium, 2 for fast).", "example": 1.5, "maximum": 3.5, "minimum": 1, "type": "number" } }, "type": "object" }, "GenerateAutoZoomsResponse": { "additionalProperties": false, "description": "Zooms generated from the clip's mouse activity", "properties": { "zooms": { "description": "The generated tracking zooms, in ms on the clip's playback timeline (cuts applied). Empty when the screen recording has no usable mouse clicks.", "items": { "$ref": "#/components/schemas/ClipZoom" }, "type": "array" } }, "required": [ "zooms" ], "type": "object" }, "GetClipResponse": { "additionalProperties": false, "description": "Response shape for a single clip", "properties": { "clip": { "$ref": "#/components/schemas/Clip" } }, "required": [ "clip" ], "type": "object" }, "GetExportResponse": { "additionalProperties": false, "description": "Current status of a video export", "properties": { "export": { "$ref": "#/components/schemas/ExportStatus" } }, "required": [ "export" ], "type": "object" }, "GetTimelineResponse": { "additionalProperties": false, "description": "A compact video timeline with optional video-level and clip-level details", "properties": { "clips": { "description": "Complete clip outline in playback order", "items": { "$ref": "#/components/schemas/TimelineClip" }, "type": "array" }, "details": { "allOf": [ { "$ref": "#/components/schemas/TimelineDetails" } ], "description": "Present only when at least one detail category is requested" }, "included": { "description": "Detail categories included in this response", "items": { "enum": [ "settings", "chapters", "backgroundMusic", "clipSettings", "cuts", "layouts", "zooms", "blurs", "highlights", "overlays", "textOverlays", "soundEffects", "transcript", "words" ], "type": "string" }, "type": "array" }, "video": { "$ref": "#/components/schemas/TimelineVideo" } }, "required": [ "video", "clips", "included" ], "type": "object" }, "HighlightCaptionStyle": { "additionalProperties": false, "properties": { "highlightColor": { "description": "Hex color in #RRGGBB or #RRGGBBAA form. Responses use uppercase #RRGGBBAA.", "example": "#5E51F8FF", "pattern": "^#(?:[0-9A-Fa-f]{6}|[0-9A-Fa-f]{8})$", "type": "string" }, "name": { "enum": [ "highlight" ], "type": "string" }, "primaryTextColor": { "description": "Hex color in #RRGGBB or #RRGGBBAA form. Responses use uppercase #RRGGBBAA.", "example": "#5E51F8FF", "pattern": "^#(?:[0-9A-Fa-f]{6}|[0-9A-Fa-f]{8})$", "type": "string" }, "secondaryTextColor": { "description": "Hex color in #RRGGBB or #RRGGBBAA form. Responses use uppercase #RRGGBBAA.", "example": "#5E51F8FF", "pattern": "^#(?:[0-9A-Fa-f]{6}|[0-9A-Fa-f]{8})$", "type": "string" } }, "required": [ "name", "primaryTextColor", "secondaryTextColor", "highlightColor" ], "title": "Highlight", "type": "object" }, "LayoutSceneType": { "description": "How a clip composes its layers, which determines the set of layouts it accepts: `basicSubject` (screen-only), `cameraSubject` (camera-only), or `combi` (camera + presentation).", "enum": [ "basicSubject", "cameraSubject", "combi" ], "example": "combi", "type": "string" }, "LayoutTransitionStyle": { "description": "How the editor transitions into this layout from the previous one. `spring` is the default smooth motion; `hardCut` is an instant cut.", "enum": [ "spring", "hardCut" ], "title": "LayoutTransitionStyle", "type": "string" }, "LibraryItem": { "additionalProperties": false, "description": "A placeable piece of media — either saved to a workspace's library, or an entry in Tella's curated catalog", "properties": { "category": { "description": "Catalog grouping, for `default` items only — the same grouping the editor's sound effects panel shows", "example": "Everyday", "type": "string" }, "createdAt": { "description": "ISO-8601 creation timestamp. Absent for `default` catalog items, which are served from Tella's catalog rather than stored as rows.", "type": "string" }, "dimensions": { "additionalProperties": false, "description": "Pixel dimensions, for visual media", "properties": { "height": { "maximum": 9007199254740991, "minimum": -9007199254740991, "type": "integer" }, "width": { "maximum": 9007199254740991, "minimum": -9007199254740991, "type": "integer" } }, "required": [ "width", "height" ], "type": "object" }, "durationMs": { "description": "Duration in milliseconds, for time-based media", "example": 4200, "type": "number" }, "id": { "description": "Unique library item identifier", "example": "media_abc123def456", "type": "string" }, "name": { "description": "Display name shown in the library", "example": "Intro camera take", "type": "string" }, "presetId": { "description": "Preset ID, for `default` catalog items only. A preset has no source until it is placed, so pass this to `POST /v1/videos/{id}/clips/{clipId}/sound-effects` instead of `sourceId`; placing it copies the effect into a source owned by your workspace.", "example": "cha-ching", "type": "string" }, "scope": { "$ref": "#/components/schemas/LibraryReadScope" }, "sourceId": { "description": "Source ID. Pass it anywhere a `sourceId` is accepted — clips, layouts, overlays, sound effects. Present for every item added through this API, including images. Absent for items added in the editor, which have no source, for music and LUT items, and for `default` catalog items, which use `presetId` instead.", "example": "su_abc123def456", "type": "string" }, "type": { "$ref": "#/components/schemas/LibraryItemType" }, "updatedAt": { "description": "ISO-8601 update timestamp. Absent for `default` catalog items.", "type": "string" }, "url": { "description": "Hosted media URL, for `image`, `music` and `lut` items, and for `default` catalog items, where it is a publicly fetchable preview of the audio. Images expose this alongside `sourceId`; use `sourceId` to place the image on a clip, since overlays and layout media do not accept URLs.", "type": "string" } }, "required": [ "id", "type", "name", "scope" ], "type": "object" }, "LibraryItemType": { "description": "The kind of media the item holds", "enum": [ "image", "video", "sound-effect", "music", "lut" ], "example": "video", "type": "string" }, "LibraryReadScope": { "description": "Which set of media to read: `private` (only visible to their creator), `workspace` (shared with everyone in the workspace), or `default` (Tella's curated sound effect catalog, which holds no other media type)", "enum": [ "private", "workspace", "default" ], "example": "private", "type": "string" }, "LibraryScope": { "description": "Which library the item belongs to: `workspace` items are shared with everyone in the workspace, `private` items are only visible to their creator", "enum": [ "private", "workspace" ], "example": "private", "type": "string" }, "ListBackgroundsResponse": { "additionalProperties": false, "description": "Background categories visible to the authenticated user", "properties": { "categories": { "items": { "$ref": "#/components/schemas/BackgroundCategory" }, "type": "array" } }, "required": [ "categories" ], "type": "object" }, "ListClipLayoutsResponse": { "additionalProperties": false, "description": "Layouts on a clip", "properties": { "layouts": { "items": { "$ref": "#/components/schemas/ClipLayout" }, "type": "array" } }, "required": [ "layouts" ], "type": "object" }, "ListClipMasksResponse": { "additionalProperties": false, "description": "Masks on a clip", "properties": { "masks": { "items": { "$ref": "#/components/schemas/ClipMask" }, "type": "array" } }, "required": [ "masks" ], "type": "object" }, "ListClipMouseEventsResponse": { "additionalProperties": false, "description": "Mouse events from the clip's screen recording. Empty when the recording has no mouse data (camera-only clips, uploads, older recorder versions).", "properties": { "events": { "items": { "$ref": "#/components/schemas/ClipMouseEvent" }, "type": "array" } }, "required": [ "events" ], "type": "object" }, "ListClipOverlaysResponse": { "additionalProperties": false, "description": "Overlays on a clip", "properties": { "overlays": { "items": { "$ref": "#/components/schemas/ClipOverlay" }, "type": "array" } }, "required": [ "overlays" ], "type": "object" }, "ListClipSilencesResponse": { "additionalProperties": false, "description": "Silent ranges in a clip", "properties": { "silences": { "items": { "$ref": "#/components/schemas/SilenceRange" }, "type": "array" } }, "required": [ "silences" ], "type": "object" }, "ListClipSoundEffectsResponse": { "additionalProperties": false, "description": "Sound effects on a clip", "properties": { "soundEffects": { "items": { "$ref": "#/components/schemas/ClipSoundEffect" }, "type": "array" } }, "required": [ "soundEffects" ], "type": "object" }, "ListClipSourcesResponse": { "additionalProperties": false, "description": "Sources of a clip", "properties": { "sources": { "items": { "$ref": "#/components/schemas/ClipSource" }, "type": "array" } }, "required": [ "sources" ], "type": "object" }, "ListClipTextOverlaysResponse": { "additionalProperties": false, "description": "Text overlays on a clip", "properties": { "textOverlays": { "items": { "$ref": "#/components/schemas/ClipTextOverlay" }, "type": "array" } }, "required": [ "textOverlays" ], "type": "object" }, "ListClipZoomsResponse": { "additionalProperties": false, "description": "Zooms on a clip", "properties": { "zooms": { "items": { "$ref": "#/components/schemas/ClipZoom" }, "type": "array" } }, "required": [ "zooms" ], "type": "object" }, "ListClipsResponse": { "additionalProperties": false, "description": "Response shape for listing clips of a video", "properties": { "clips": { "description": "Clips in the video, ordered by `order`", "items": { "$ref": "#/components/schemas/Clip" }, "type": "array" } }, "required": [ "clips" ], "type": "object" }, "ListExportsResponse": { "additionalProperties": false, "description": "All exports for a video", "properties": { "exports": { "items": { "$ref": "#/components/schemas/ExportStatus" }, "type": "array" } }, "required": [ "exports" ], "type": "object" }, "ListLibraryResponse": { "additionalProperties": false, "description": "A page of library items", "properties": { "cursor": { "description": "Cursor for the next page. Absent when there are no more items.", "type": "string" }, "items": { "items": { "$ref": "#/components/schemas/LibraryItem" }, "type": "array" } }, "required": [ "items" ], "type": "object" }, "ListMessagesResponse": { "additionalProperties": false, "description": "Response containing a list of webhook messages", "properties": { "messages": { "description": "Array of webhook messages", "items": { "$ref": "#/components/schemas/WebhookMessage" }, "type": "array" } }, "required": [ "messages" ], "type": "object" }, "ListPlaylistGroupsResponse": { "additionalProperties": false, "description": "List of playlist groups", "properties": { "groups": { "description": "Playlist groups in sidebar order", "items": { "$ref": "#/components/schemas/PlaylistGroup" }, "type": "array" } }, "required": [ "groups" ], "type": "object" }, "ListTagsResponse": { "additionalProperties": false, "description": "List of tags visible to the authenticated user", "properties": { "tags": { "items": { "$ref": "#/components/schemas/Tag" }, "type": "array" } }, "required": [ "tags" ], "type": "object" }, "ListVideoTagsResponse": { "additionalProperties": false, "description": "Tags on a video that are visible to the authenticated user", "properties": { "tags": { "items": { "$ref": "#/components/schemas/Tag" }, "type": "array" } }, "required": [ "tags" ], "type": "object" }, "ListWebhookEndpointsResponse": { "additionalProperties": false, "description": "A page of webhook subscription endpoints", "properties": { "endpoints": { "items": { "$ref": "#/components/schemas/WebhookEndpoint" }, "type": "array" }, "nextCursor": { "description": "Cursor for the next page, or null on the final page", "nullable": true, "type": "string" } }, "required": [ "endpoints", "nextCursor" ], "type": "object" }, "MaskDimensions": { "description": "Size of the masked rectangle (percentages)", "properties": { "heightPct": { "example": 50, "maximum": 100, "minimum": 0, "type": "number" }, "widthPct": { "example": 50, "maximum": 100, "minimum": 0, "type": "number" } }, "required": [ "widthPct", "heightPct" ], "type": "object" }, "MaskDimensionsOutput": { "additionalProperties": false, "description": "Size of the masked rectangle (percentages)", "properties": { "heightPct": { "example": 50, "maximum": 100, "minimum": 0, "type": "number" }, "widthPct": { "example": 50, "maximum": 100, "minimum": 0, "type": "number" } }, "required": [ "widthPct", "heightPct" ], "type": "object" }, "MaskPoint": { "description": "Top-left corner of the masked rectangle (percentages)", "properties": { "xPct": { "example": 25, "maximum": 100, "minimum": 0, "type": "number" }, "yPct": { "example": 25, "maximum": 100, "minimum": 0, "type": "number" } }, "required": [ "xPct", "yPct" ], "type": "object" }, "MaskPointOutput": { "additionalProperties": false, "description": "Top-left corner of the masked rectangle (percentages)", "properties": { "xPct": { "example": 25, "maximum": 100, "minimum": 0, "type": "number" }, "yPct": { "example": 25, "maximum": 100, "minimum": 0, "type": "number" } }, "required": [ "xPct", "yPct" ], "type": "object" }, "MiddleLayout": { "additionalProperties": false, "description": "Centered subject. Camera-subject clips take a `shape`; basic-subject clips take no fields.", "properties": { "kind": { "enum": [ "middle" ], "type": "string" }, "shape": { "description": "Required for camera-subject clips. Ignored for basic-subject clips.", "enum": [ "circle", "square", "landscape", "portrait" ], "type": "string" } }, "required": [ "kind" ], "title": "Middle", "type": "object" }, "MonoCaptionStyle": { "additionalProperties": false, "properties": { "highlightColor": { "description": "Hex color in #RRGGBB or #RRGGBBAA form. Responses use uppercase #RRGGBBAA.", "example": "#5E51F8FF", "pattern": "^#(?:[0-9A-Fa-f]{6}|[0-9A-Fa-f]{8})$", "type": "string" }, "name": { "enum": [ "mono" ], "type": "string" }, "textColor": { "description": "Hex color in #RRGGBB or #RRGGBBAA form. Responses use uppercase #RRGGBBAA.", "example": "#5E51F8FF", "pattern": "^#(?:[0-9A-Fa-f]{6}|[0-9A-Fa-f]{8})$", "type": "string" } }, "required": [ "name", "textColor", "highlightColor" ], "title": "Mono", "type": "object" }, "OverlayDimensions": { "description": "Overlay size in artboard pixels. Absolute (not a percentage) so the overlay shape never distorts when the artboard dimensions change. Both sides must be greater than 0 — the renderer lays the overlay out into this box, so a zero or negative side has no valid meaning.", "properties": { "height": { "example": 540, "exclusiveMinimum": true, "minimum": 0, "type": "number" }, "width": { "example": 960, "exclusiveMinimum": true, "minimum": 0, "type": "number" } }, "required": [ "width", "height" ], "type": "object" }, "OverlayDimensionsOutput": { "additionalProperties": false, "description": "Overlay size in artboard pixels. Absolute (not a percentage) so the overlay shape never distorts when the artboard dimensions change. Both sides must be greater than 0 — the renderer lays the overlay out into this box, so a zero or negative side has no valid meaning.", "properties": { "height": { "example": 540, "exclusiveMinimum": true, "minimum": 0, "type": "number" }, "width": { "example": 960, "exclusiveMinimum": true, "minimum": 0, "type": "number" } }, "required": [ "width", "height" ], "type": "object" }, "OverlayPoint": { "description": "Top-left corner of the overlay, as a percentage of the video canvas (0-100). Relative so the anchor survives video aspect ratio changes.", "properties": { "xPct": { "example": 30, "type": "number" }, "yPct": { "example": 30, "type": "number" } }, "required": [ "xPct", "yPct" ], "type": "object" }, "OverlayPointOutput": { "additionalProperties": false, "description": "Top-left corner of the overlay, as a percentage of the video canvas (0-100). Relative so the anchor survives video aspect ratio changes.", "properties": { "xPct": { "example": 30, "type": "number" }, "yPct": { "example": 30, "type": "number" } }, "required": [ "xPct", "yPct" ], "type": "object" }, "Pagination": { "additionalProperties": false, "description": "Pagination metadata for list responses. Results are sorted by updatedAt descending.", "properties": { "hasMore": { "description": "Whether there are more items to fetch", "example": true, "type": "boolean" }, "nextCursor": { "description": "Cursor for next page. Pass this value as the 'cursor' query parameter to fetch the next page. Null if no more pages. This is an opaque value - do not decode or modify it.", "example": "eyJpZCI6IjEyMyJ9", "nullable": true, "type": "string" } }, "required": [ "nextCursor", "hasMore" ], "type": "object" }, "PlaylistDetail": { "additionalProperties": false, "description": "Detailed information about a playlist", "properties": { "createdAt": { "description": "ISO 8601 datetime", "example": "2024-01-15T10:30:00.000Z", "format": "date-time", "type": "string" }, "description": { "description": "Playlist description", "example": "A collection of tutorial videos for our product", "maxLength": 5000, "type": "string" }, "emoji": { "description": "Unicode emoji character for the playlist", "example": "🎬", "maxLength": 10, "type": "string" }, "groupId": { "description": "Playlist group this playlist belongs to in the sidebar, or null if ungrouped", "example": "pg_abc123def456", "nullable": true, "type": "string" }, "id": { "description": "Unique playlist identifier", "example": "pl_abc123def456", "type": "string" }, "linkScope": { "allOf": [ { "$ref": "#/components/schemas/PlaylistLinkScope" } ], "description": "Access level for the playlist" }, "links": { "allOf": [ { "$ref": "#/components/schemas/PlaylistLinks" } ], "description": "Related URLs for the playlist" }, "name": { "description": "Playlist name", "example": "Product Tutorials", "maxLength": 255, "minLength": 1, "type": "string" }, "searchEngineIndexingEnabled": { "description": "Whether search engines can index this playlist", "example": true, "type": "boolean" }, "updatedAt": { "description": "ISO 8601 datetime", "example": "2024-01-15T14:45:00.000Z", "format": "date-time", "type": "string" }, "videos": { "description": "Number of videos in the playlist", "example": 12, "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, "visibility": { "allOf": [ { "$ref": "#/components/schemas/PlaylistVisibility" } ], "description": "Whether playlist is shared with org or personal to creator" } }, "required": [ "id", "name", "description", "emoji", "videos", "linkScope", "searchEngineIndexingEnabled", "visibility", "groupId", "createdAt", "updatedAt", "links" ], "type": "object" }, "PlaylistGroup": { "additionalProperties": false, "description": "A sidebar group that playlists can be organized into. Personal groups are only visible to you; org groups are shared with the whole workspace.", "properties": { "emoji": { "description": "Unicode emoji character for the group, empty if unset", "example": "📁", "type": "string" }, "id": { "description": "Unique playlist group identifier", "example": "pg_abc123def456", "type": "string" }, "name": { "description": "Playlist group name", "example": "Marketing", "maxLength": 255, "minLength": 1, "type": "string" }, "visibility": { "allOf": [ { "$ref": "#/components/schemas/PlaylistGroupVisibility" } ], "description": "Whether the group lives in the personal or workspace section of the sidebar" } }, "required": [ "id", "name", "emoji", "visibility" ], "type": "object" }, "PlaylistGroupResponse": { "additionalProperties": false, "description": "A single playlist group", "properties": { "group": { "$ref": "#/components/schemas/PlaylistGroup" } }, "required": [ "group" ], "type": "object" }, "PlaylistGroupVisibility": { "description": "Visibility: org (shared sidebar group for the entire organization) or personal (only visible to you)", "enum": [ "org", "personal" ], "example": "personal", "type": "string" }, "PlaylistLinkScope": { "description": "Access level: public (anyone with link), private (org members only), password (requires password), embedonly (only viewable when embedded)", "enum": [ "public", "private", "password", "embedonly" ], "example": "public", "type": "string" }, "PlaylistLinks": { "additionalProperties": false, "description": "URLs related to a playlist", "properties": { "viewPage": { "description": "URL to view the playlist on Tella", "example": "https://www.tella.tv/playlist/pl_abc123def456/view", "format": "uri", "type": "string" } }, "required": [ "viewPage" ], "type": "object" }, "PlaylistListItem": { "additionalProperties": false, "description": "Playlist item in a list response", "properties": { "createdAt": { "description": "ISO 8601 datetime", "example": "2024-01-15T10:30:00.000Z", "format": "date-time", "type": "string" }, "description": { "description": "Playlist description", "example": "A collection of tutorial videos for our product", "maxLength": 5000, "type": "string" }, "emoji": { "description": "Unicode emoji character for the playlist", "example": "🎬", "maxLength": 10, "type": "string" }, "groupId": { "description": "Playlist group this playlist belongs to in the sidebar, or null if ungrouped", "example": "pg_abc123def456", "nullable": true, "type": "string" }, "id": { "description": "Unique playlist identifier", "example": "pl_abc123def456", "type": "string" }, "linkScope": { "allOf": [ { "$ref": "#/components/schemas/PlaylistLinkScope" } ], "description": "Access level for the playlist" }, "links": { "allOf": [ { "$ref": "#/components/schemas/PlaylistLinks" } ], "description": "Related URLs for the playlist" }, "name": { "description": "Playlist name", "example": "Product Tutorials", "maxLength": 255, "minLength": 1, "type": "string" }, "searchEngineIndexingEnabled": { "description": "Whether search engines can index this playlist", "example": true, "type": "boolean" }, "updatedAt": { "description": "ISO 8601 datetime", "example": "2024-01-15T14:45:00.000Z", "format": "date-time", "type": "string" }, "videos": { "description": "Number of videos in the playlist", "example": 12, "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, "visibility": { "allOf": [ { "$ref": "#/components/schemas/PlaylistVisibility" } ], "description": "Whether playlist is shared with org or personal to creator" } }, "required": [ "id", "name", "description", "emoji", "videos", "linkScope", "searchEngineIndexingEnabled", "visibility", "groupId", "createdAt", "updatedAt", "links" ], "type": "object" }, "PlaylistVisibility": { "description": "Visibility: org (shared with entire organization) or personal (only creator)", "enum": [ "org", "personal" ], "example": "org", "type": "string" }, "RemoveSilencesRequest": { "description": "Options for removing silences from a clip", "properties": { "mode": { "description": "How aggressively to remove silences: natural cuts pauses longer than 800ms, fast longer than 500ms, faster longer than 300ms. Defaults to natural.", "enum": [ "natural", "fast", "faster" ], "example": "natural", "type": "string" } }, "type": "object" }, "ReorderClipRequest": { "additionalProperties": false, "description": "Move a clip to a new position. Other clips are renumbered to keep ordering contiguous.", "properties": { "order": { "description": "New position for the clip (0 = first)", "example": 2, "maximum": 9007199254740991, "minimum": 0, "type": "integer" } }, "required": [ "order" ], "type": "object" }, "ScreenOnlyLayout": { "additionalProperties": false, "description": "Screen fills the frame or sits centered; the camera is hidden. Combi (all ratios).", "properties": { "kind": { "enum": [ "screen-only" ], "type": "string" }, "screenFit": { "description": "Only honoured when `style: \"fullscreen\"`. Defaults to cover.", "enum": [ "cover", "letterbox" ], "type": "string" }, "style": { "description": "`fullscreen` fills the frame with the screen (optional `screenFit`); `middle` centers the screen.", "enum": [ "fullscreen", "middle" ], "type": "string" } }, "required": [ "kind", "style" ], "title": "Screen Only", "type": "object" }, "SearchMatch": { "additionalProperties": false, "properties": { "endSeconds": { "description": "End of the matching transcript sentence, in seconds. Null for title matches.", "nullable": true, "type": "number" }, "field": { "enum": [ "title", "transcript" ], "type": "string" }, "matchedTokens": { "items": { "type": "string" }, "type": "array" }, "snippet": { "description": "Plain-text matching excerpt", "type": "string" }, "startSeconds": { "description": "Start of the matching transcript sentence, in seconds. Null for title matches.", "nullable": true, "type": "number" } }, "required": [ "field", "snippet", "matchedTokens", "startSeconds", "endSeconds" ], "type": "object" }, "SearchVideoResult": { "additionalProperties": false, "properties": { "matches": { "items": { "$ref": "#/components/schemas/SearchMatch" }, "type": "array" }, "video": { "$ref": "#/components/schemas/VideoListItem" } }, "required": [ "video", "matches" ], "type": "object" }, "SearchVideosResponse": { "additionalProperties": false, "properties": { "pagination": { "$ref": "#/components/schemas/Pagination" }, "results": { "items": { "$ref": "#/components/schemas/SearchVideoResult" }, "type": "array" } }, "required": [ "results", "pagination" ], "type": "object" }, "Sentence": { "additionalProperties": false, "description": "A sentence from the transcript with timestamps", "properties": { "endSeconds": { "description": "Sentence end time in seconds", "example": 2.3, "minimum": 0, "type": "number" }, "startSeconds": { "description": "Sentence start time in seconds", "example": 0.5, "minimum": 0, "type": "number" }, "text": { "description": "Sentence text", "example": "Hello and welcome to this tutorial.", "type": "string" } }, "required": [ "text", "startSeconds", "endSeconds" ], "type": "object" }, "SetVideoThumbnailRequest": { "additionalProperties": false, "description": "Request body for setting a video's thumbnail. Provide exactly one of sourceId (uploaded image) or inpointMs (frame from the video).", "properties": { "inpointMs": { "description": "Pick a video frame as the thumbnail: time in ms on the video's playback timeline (cuts applied, cumulative across clips). Clears any previously uploaded thumbnail image. Mutually exclusive with sourceId.", "example": 4500, "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, "sourceId": { "description": "Use an uploaded image as the thumbnail. Source ID from POST /v1/sources (kind: 'image'); upload the image bytes to the source's uploadUrl first. Mutually exclusive with inpointMs.", "example": "su_abc123def456", "minLength": 1, "type": "string" } }, "type": "object" }, "SetVideoThumbnailResponse": { "additionalProperties": false, "description": "The thumbnail that was set", "properties": { "customThumbnailURL": { "description": "CDN URL of the uploaded thumbnail image. Only present when the thumbnail was set from a sourceId.", "example": "https://ucarecdn.com/12345678-abcd-4ef0-9012-3456789abcde/", "type": "string" }, "inpointMs": { "description": "The thumbnail frame time in ms. Only present when the thumbnail was set from an inpointMs.", "example": 4500, "maximum": 9007199254740991, "minimum": -9007199254740991, "type": "integer" } }, "type": "object" }, "SideBySideLayout": { "additionalProperties": false, "description": "Camera and screen side by side. Combi (all ratios). Landscape splits horizontally (`position: left/right`, style regular/even/overlap); portrait and square split vertically 50/50 (`position: top/bottom` for the camera half, `style: even` only).", "properties": { "kind": { "enum": [ "side-by-side" ], "type": "string" }, "position": { "description": "Where the camera sits. `left`/`right` on landscape clips; `top`/`bottom` on portrait and square clips.", "enum": [ "left", "right", "top", "bottom" ], "type": "string" }, "size": { "description": "Camera size. Required when `style: \"overlap\"`; ignored otherwise.", "enum": [ "S", "M", "L" ], "type": "string" }, "style": { "description": "`regular` weights camera and screen unevenly, `even` splits 50/50, `overlap` lets the camera bleed over the screen edge (and requires `size`). Portrait and square clips support `even` only.", "enum": [ "regular", "even", "overlap" ], "type": "string" } }, "required": [ "kind", "position", "style" ], "title": "Side by Side", "type": "object" }, "SilenceRange": { "additionalProperties": false, "description": "A contiguous range of silent audio, in ms on the clip's playback timeline (cuts applied) — pass ranges directly to the cut endpoint. Silences already removed by cuts are not reported.", "properties": { "durationMs": { "example": 800, "exclusiveMinimum": true, "minimum": 0, "type": "number" }, "startTimeMs": { "description": "Start of the silence, in ms on the clip's playback timeline (cuts applied)", "example": 4500, "minimum": 0, "type": "number" } }, "required": [ "startTimeMs", "durationMs" ], "type": "object" }, "SourceWaveformResponse": { "additionalProperties": false, "description": "Audio waveform data for a source, in BBC audiowaveform JSON format. Use the `data` array to render a custom waveform visualization.", "properties": { "bits": { "example": 8, "maximum": 9007199254740991, "minimum": -9007199254740991, "type": "integer" }, "channels": { "example": 1, "maximum": 9007199254740991, "minimum": -9007199254740991, "type": "integer" }, "data": { "description": "Raw audio level data (BBC audiowaveform format)", "items": { "type": "number" }, "type": "array" }, "length": { "example": 12345, "maximum": 9007199254740991, "minimum": -9007199254740991, "type": "integer" }, "sampleRate": { "example": 48000, "maximum": 9007199254740991, "minimum": -9007199254740991, "type": "integer" }, "samplesPerPixel": { "example": 256, "maximum": 9007199254740991, "minimum": -9007199254740991, "type": "integer" }, "version": { "example": 2, "maximum": 9007199254740991, "minimum": -9007199254740991, "type": "integer" } }, "required": [ "version", "channels", "sampleRate", "samplesPerPixel", "bits", "length", "data" ], "type": "object" }, "StoryboardResponse": { "additionalProperties": false, "description": "Signed CDN URL plus the grid layout of the requested 4x4 WebP storyboard. Returned only when `?response=json` is set; otherwise the endpoint redirects to the URL with a 302.", "properties": { "columns": { "description": "Tiles per row", "example": 4, "maximum": 9007199254740991, "minimum": -9007199254740991, "type": "integer" }, "intervalMs": { "description": "Spacing between tiles in ms. Tile i (row-major) shows the frame at `startTimeMs + i * intervalMs`.", "example": 5000, "maximum": 9007199254740991, "minimum": -9007199254740991, "type": "integer" }, "rows": { "description": "Tile rows", "example": 4, "maximum": 9007199254740991, "minimum": -9007199254740991, "type": "integer" }, "url": { "description": "Signed CDN URL of the WebP sheet", "format": "uri", "type": "string" } }, "required": [ "url", "columns", "rows", "intervalMs" ], "type": "object" }, "SuccessResponse": { "additionalProperties": false, "description": "Standard success response for operations that don't return data", "properties": { "status": { "description": "Operation status", "enum": [ "ok" ], "example": "ok", "type": "string" } }, "required": [ "status" ], "type": "object" }, "TVPresenterLayout": { "additionalProperties": false, "description": "Today-show layout: presenter on one side, screen on the other. Combi (landscape) only.", "properties": { "kind": { "enum": [ "tv-presenter" ], "type": "string" }, "position": { "enum": [ "left", "right" ], "type": "string" }, "style": { "description": "`regular` is the standard today-show framing, `full` puts the screen fullscreen behind the presenter, `overlap` tightens the camera-screen overlap.", "enum": [ "regular", "full", "overlap" ], "type": "string" } }, "required": [ "kind", "position", "style" ], "title": "TV Presenter", "type": "object" }, "Tag": { "additionalProperties": false, "description": "A tag used to categorize videos", "properties": { "color": { "$ref": "#/components/schemas/TagColor" }, "description": { "description": "Optional tag description", "example": "Product demo recordings", "type": "string" }, "id": { "description": "Unique tag identifier", "example": "tag_abc123def456", "type": "string" }, "name": { "description": "Tag name", "example": "Demo", "maxLength": 255, "minLength": 1, "type": "string" }, "scope": { "$ref": "#/components/schemas/TagScope" } }, "required": [ "id", "name", "scope", "color", "description" ], "type": "object" }, "TagColor": { "description": "Tag color as a hex value", "example": "#6366f1", "pattern": "^#(?:[0-9a-fA-F]{3,4}|[0-9a-fA-F]{6}|[0-9a-fA-F]{8})$", "type": "string" }, "TagScope": { "description": "Tag visibility: workspace tags are shared with everyone in the workspace, private tags are only visible to their creator", "enum": [ "workspace", "private" ], "example": "workspace", "type": "string" }, "TextOverlayBackground": { "description": "Background behind a text overlay, in the same object shape as a clip background.", "properties": { "color": { "description": "Hex color string. Required when type = 'solid'. Transparent backgrounds use #00000000.", "example": "#5E51F8FF", "pattern": "^#(?:[0-9A-Fa-f]{6}|[0-9A-Fa-f]{8})$", "type": "string" }, "type": { "description": "Background variant. Text overlays take a solid background; the other `ClipBackground` variants are not supported behind text.", "enum": [ "solid" ], "example": "solid", "type": "string" } }, "required": [ "type", "color" ], "type": "object" }, "TextOverlayBackgroundOutput": { "additionalProperties": false, "description": "Background behind a text overlay, in the same object shape as a clip background.", "properties": { "color": { "description": "Hex color string. Required when type = 'solid'. Transparent backgrounds use #00000000.", "example": "#5E51F8FF", "pattern": "^#(?:[0-9A-Fa-f]{6}|[0-9A-Fa-f]{8})$", "type": "string" }, "type": { "description": "Background variant. Text overlays take a solid background; the other `ClipBackground` variants are not supported behind text.", "enum": [ "solid" ], "example": "solid", "type": "string" } }, "required": [ "type", "color" ], "type": "object" }, "TextOverlayBackgroundShape": { "description": "Shape of the solid background behind the text.", "enum": [ "none", "regular", "squircle" ], "example": "squircle", "type": "string" }, "TextOverlayFontFamily": { "description": "One of Tella's catalog font families — the same list the editor's font picker offers.", "enum": [ "Inter", "Roboto Mono", "Archivo", "Barlow", "Caveat", "DM Sans", "Figtree", "Lora", "Merriweather", "Montserrat", "Nunito Sans", "Open Sans", "Oswald", "Playfair Display", "Poppins", "Raleway", "Roboto", "Roboto Flex", "Source Sans 3", "Space Grotesk" ], "example": "Inter", "type": "string" }, "TextOverlayTextAlign": { "description": "Horizontal alignment of the text inside its overlay box.", "enum": [ "left", "center", "right" ], "example": "center", "type": "string" }, "ThumbnailFormats": { "additionalProperties": false, "description": "Thumbnail URLs in various formats for a specific size", "properties": { "gif": { "description": "Animated GIF thumbnail URL (medium and small sizes only)", "example": "https://cdn.tella.tv/thumbnails/vid_abc123/640x360.gif", "format": "uri", "type": "string" }, "jpg": { "description": "JPEG thumbnail URL", "example": "https://cdn.tella.tv/thumbnails/vid_abc123/1920x1080.jpg", "format": "uri", "type": "string" }, "mp4": { "description": "Animated MP4 thumbnail URL (medium and small sizes only)", "example": "https://cdn.tella.tv/thumbnails/vid_abc123/640x360.mp4", "format": "uri", "type": "string" }, "webp": { "description": "WebP thumbnail URL", "example": "https://cdn.tella.tv/thumbnails/vid_abc123/1920x1080.webp", "format": "uri", "type": "string" } }, "type": "object" }, "ThumbnailResponse": { "additionalProperties": false, "description": "Signed CDN URL for the requested thumbnail. Returned only when `?response=json` is set; otherwise the endpoint redirects to the URL with a 302.", "properties": { "url": { "format": "uri", "type": "string" } }, "required": [ "url" ], "type": "object" }, "Thumbnails": { "additionalProperties": false, "description": "Video thumbnails organized by size, with format options for each", "properties": { "large": { "allOf": [ { "$ref": "#/components/schemas/ThumbnailFormats" } ], "description": "Large thumbnails (1280x720 landscape, 720x1280 portrait, 1080x1080 square)" }, "medium": { "allOf": [ { "$ref": "#/components/schemas/ThumbnailFormats" } ], "description": "Medium thumbnails with animated formats (640x360 landscape, 360x640 portrait, 640x640 square)" }, "small": { "allOf": [ { "$ref": "#/components/schemas/ThumbnailFormats" } ], "description": "Small thumbnails with animated formats (320x180 landscape, 180x320 portrait, 320x320 square)" }, "xl": { "allOf": [ { "$ref": "#/components/schemas/ThumbnailFormats" } ], "description": "Extra large thumbnails (1920x1080 landscape, 1080x1920 portrait, 1080x1080 square)" } }, "type": "object" }, "TimelineClip": { "additionalProperties": false, "description": "A compact clip entry in the video's ordered timeline", "properties": { "contents": { "$ref": "#/components/schemas/TimelineContentCounts" }, "durationMs": { "description": "Clip playback duration in ms, with cuts removed", "minimum": 0, "type": "number" }, "id": { "type": "string" }, "name": { "type": "string" }, "order": { "maximum": 9007199254740991, "minimum": -9007199254740991, "type": "integer" }, "timelineStartMs": { "description": "Clip start time in ms on the complete video timeline", "minimum": 0, "type": "number" } }, "required": [ "id", "name", "order", "timelineStartMs", "durationMs", "contents" ], "type": "object" }, "TimelineClipDetails": { "additionalProperties": false, "description": "Only the explicitly requested detail fields are present", "properties": { "background": { "allOf": [ { "$ref": "#/components/schemas/ClipBackgroundOutput" } ] }, "blurs": { "items": { "$ref": "#/components/schemas/ClipMask" }, "type": "array" }, "clipId": { "type": "string" }, "cuts": { "description": "Raw cut definitions in ms of the source recording, matching get_clip", "items": { "$ref": "#/components/schemas/CutOutput" }, "type": "array" }, "highlights": { "items": { "$ref": "#/components/schemas/ClipMask" }, "type": "array" }, "layoutSceneType": { "allOf": [ { "$ref": "#/components/schemas/LayoutSceneType" } ] }, "layouts": { "items": { "$ref": "#/components/schemas/ClipLayout" }, "type": "array" }, "microphoneVolume": { "description": "Clip microphone volume override: a number when overridden, null when following the video, absent when there is no microphone audio", "maximum": 2, "minimum": 0, "nullable": true, "type": "number" }, "overlays": { "items": { "$ref": "#/components/schemas/ClipOverlay" }, "type": "array" }, "soundEffects": { "items": { "$ref": "#/components/schemas/ClipSoundEffect" }, "type": "array" }, "studioSound": { "description": "Effective Studio Sound state: the video-level switch minus this clip's opt-out", "type": "boolean" }, "systemAudioVolume": { "description": "Clip system audio override: a number when overridden, null when following the video, absent when there is no system audio", "maximum": 2, "minimum": 0, "nullable": true, "type": "number" }, "textOverlays": { "items": { "$ref": "#/components/schemas/ClipTextOverlay" }, "type": "array" }, "transcript": { "allOf": [ { "$ref": "#/components/schemas/TimelineTranscript" } ] }, "words": { "description": "Words in ms on the clip playback timeline. Includes hidden words so indices remain usable with transcript editing endpoints. Null when transcript data could not be read.", "items": { "$ref": "#/components/schemas/TranscriptWord" }, "nullable": true, "type": "array" }, "zooms": { "items": { "$ref": "#/components/schemas/ClipZoom" }, "type": "array" } }, "required": [ "clipId" ], "type": "object" }, "TimelineContentCounts": { "additionalProperties": false, "properties": { "blurs": { "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, "cuts": { "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, "highlights": { "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, "layouts": { "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, "overlays": { "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, "soundEffects": { "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, "textOverlays": { "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, "transcriptWords": { "description": "Number of transcript words on the clip playback timeline, including hidden words. Null when transcript data could not be read.", "maximum": 9007199254740991, "minimum": 0, "nullable": true, "type": "integer" }, "zooms": { "maximum": 9007199254740991, "minimum": 0, "type": "integer" } }, "required": [ "cuts", "layouts", "zooms", "blurs", "highlights", "overlays", "textOverlays", "soundEffects", "transcriptWords" ], "type": "object" }, "TimelineDetails": { "additionalProperties": false, "properties": { "clips": { "items": { "$ref": "#/components/schemas/TimelineClipDetails" }, "type": "array" }, "video": { "allOf": [ { "$ref": "#/components/schemas/TimelineVideoDetails" } ] } }, "type": "object" }, "TimelineTranscript": { "additionalProperties": false, "description": "Null when the clip has no speech or its transcript is unavailable", "nullable": true, "properties": { "text": { "description": "Visible transcript text", "type": "string" }, "wordCount": { "maximum": 9007199254740991, "minimum": 0, "type": "integer" } }, "required": [ "text", "wordCount" ], "type": "object" }, "TimelineVideo": { "additionalProperties": false, "description": "Minimal video timeline summary", "properties": { "aspectRatio": { "example": "16:9", "type": "string" }, "description": { "maxLength": 5000, "type": "string" }, "dimensions": { "additionalProperties": false, "properties": { "height": { "description": "Canvas height in pixels", "type": "number" }, "width": { "description": "Canvas width in pixels", "type": "number" } }, "required": [ "width", "height" ], "type": "object" }, "durationMs": { "description": "Total playback duration in ms", "minimum": 0, "type": "number" }, "id": { "type": "string" }, "name": { "type": "string" }, "updatedAt": { "description": "ISO-8601 timestamp of the video version represented", "type": "string" } }, "required": [ "id", "name", "description", "updatedAt", "aspectRatio", "dimensions", "durationMs" ], "type": "object" }, "TimelineVideoDetails": { "additionalProperties": false, "properties": { "backgroundMusic": { "allOf": [ { "$ref": "#/components/schemas/BackgroundMusic" } ], "nullable": true }, "chapters": { "items": { "$ref": "#/components/schemas/Chapter" }, "type": "array" }, "settings": { "allOf": [ { "$ref": "#/components/schemas/VideoSettings" } ] } }, "type": "object" }, "Transcript": { "additionalProperties": false, "description": "Video transcript data", "properties": { "language": { "description": "Detected language code (e.g., 'en', 'es')", "example": "en", "nullable": true, "type": "string" }, "sentences": { "description": "Sentences with timestamps", "items": { "$ref": "#/components/schemas/Sentence" }, "nullable": true, "type": "array" }, "status": { "description": "Transcript generation status", "enum": [ "ready", "processing", "failed" ], "example": "ready", "type": "string" }, "text": { "description": "Full transcript text", "example": "Hello and welcome to this tutorial...", "nullable": true, "type": "string" } }, "required": [ "status", "language", "text", "sentences" ], "type": "object" }, "TranscriptWord": { "additionalProperties": false, "description": "A single transcribed word", "properties": { "endTimeMs": { "description": "Word end time, in ms on the clip's playback timeline", "example": 1800, "minimum": 0, "type": "number" }, "hidden": { "description": "Whether the word is hidden by an edit", "example": false, "type": "boolean" }, "index": { "description": "Stable index of the word in the source recording", "example": 12, "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, "startTimeMs": { "description": "Word start time, in ms on the clip's playback timeline", "example": 1500, "minimum": 0, "type": "number" }, "text": { "description": "Word text", "example": "Hello", "type": "string" } }, "required": [ "index", "startTimeMs", "endTimeMs", "text", "hidden" ], "type": "object" }, "TranscriptWordEdit": { "additionalProperties": false, "description": "A correction to a single transcript word, addressed by its transcript index. Set exactly one of `text` or `hidden`.", "maxProperties": 2, "minProperties": 2, "properties": { "hidden": { "description": "`true` hides the word from captions and subtitles without touching the audio; `false` shows it again. A correction already made to the word is preserved.", "example": true, "type": "boolean" }, "index": { "description": "Index of the word to edit, as reported by the clip's transcript.", "example": 12, "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, "text": { "description": "Corrected text for the word. Replaces what the transcript, captions and subtitles say, and unhides the word. Must not be empty — hide a word with `hidden` instead.", "example": "Tella", "minLength": 1, "type": "string" } }, "required": [ "index" ], "type": "object" }, "TranscriptWordRange": { "description": "A range of words to cut, identified by word indices from the clip's transcript.", "properties": { "fromWordIndex": { "description": "Index of the first word to cut (inclusive), as reported by the transcript.", "example": 12, "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, "toWordIndex": { "description": "Index of the last word to cut (inclusive), as reported by the transcript.", "example": 17, "maximum": 9007199254740991, "minimum": 0, "type": "integer" } }, "required": [ "fromWordIndex", "toWordIndex" ], "type": "object" }, "TransitionStyle": { "description": "How one thing gives way to the next: `smooth` eases across the change, `hard_cut` swaps instantly.", "enum": [ "smooth", "hard_cut" ], "example": "smooth", "type": "string" }, "TrimRequest": { "additionalProperties": false, "description": "Trim parameters. Use either startTime+endTime for time range or chapterIndex for chapter extraction.", "properties": { "chapterIndex": { "description": "Index of the chapter to extract (0-based). Cannot be combined with startTime/endTime. Get chapter count from the video's chapters array.", "example": 0, "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, "endTime": { "description": "End time in seconds for the trimmed video. Required when using time range trim.", "example": 60, "minimum": 0, "type": "number" }, "startTime": { "description": "Start time in seconds for the trimmed video. Required when using time range trim.", "example": 10.5, "minimum": 0, "type": "number" } }, "type": "object" }, "UpdateClipLayoutRequest": { "additionalProperties": false, "description": "Update an existing layout on a clip", "properties": { "durationMs": { "maximum": 9007199254740991, "minimum": 200, "type": "integer" }, "layout": { "allOf": [ { "$ref": "#/components/schemas/ClipLayoutShape" } ] }, "media": { "allOf": [ { "$ref": "#/components/schemas/ClipMedia" } ], "description": "Replace the layout's media content. Only valid on time-ranged layouts; rejected on the base (clip-spanning) layout." }, "startTimeMs": { "description": "Start time in ms on the clip's playback timeline (cuts applied)", "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, "transitionStyle": { "allOf": [ { "$ref": "#/components/schemas/LayoutTransitionStyle" } ], "description": "Only valid on time-ranged layouts; rejected on the base (clip-spanning) layout." } }, "type": "object" }, "UpdateClipMaskRequest": { "additionalProperties": false, "description": "Update an existing mask. Times are in ms on the clip's playback timeline (cuts applied).", "properties": { "dimensions": { "allOf": [ { "$ref": "#/components/schemas/MaskDimensions" } ] }, "durationMs": { "exclusiveMinimum": true, "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, "point": { "allOf": [ { "$ref": "#/components/schemas/MaskPoint" } ] }, "startTimeMs": { "description": "Start time in ms on the clip's playback timeline (cuts applied)", "maximum": 9007199254740991, "minimum": 0, "type": "integer" } }, "type": "object" }, "UpdateClipOverlayRequest": { "additionalProperties": false, "description": "Update an existing overlay", "properties": { "dimensions": { "allOf": [ { "$ref": "#/components/schemas/OverlayDimensions" } ] }, "durationMs": { "exclusiveMinimum": true, "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, "name": { "type": "string" }, "point": { "allOf": [ { "$ref": "#/components/schemas/OverlayPoint" } ] }, "startTimeMs": { "description": "Start time. Milliseconds on the clip playback timeline (with cuts applied) — the same timeline as the cut transcript.", "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, "transition": { "allOf": [ { "$ref": "#/components/schemas/TransitionStyle" } ], "description": "Intro/outro animation: `smooth` fades the overlay in at its start and out at its end, `hard_cut` pops it in and out." } }, "type": "object" }, "UpdateClipRequest": { "additionalProperties": false, "description": "Request body for updating a clip. At least one field must be provided.", "minProperties": 1, "properties": { "animatedCursor": { "description": "Draw an animated cursor from captured mouse data on this clip's screen recording. Returns 400 when the clip has no screen recording.", "example": true, "type": "boolean" }, "background": { "allOf": [ { "$ref": "#/components/schemas/ClipBackground" } ] }, "cuts": { "description": "Replaces the clip's cuts. Total cut duration must be less than `maxDurationSeconds`.", "items": { "$ref": "#/components/schemas/Cut" }, "type": "array" }, "microphoneVolume": { "description": "Microphone volume for this clip only, overriding the video's `microphoneVolume`. 1 is the recorded level, 0 mutes it, 2 doubles it. Pass null to clear the override so the clip follows the video again. Returns 400 when the clip has no microphone audio to control, i.e. whenever a read reports the field as absent.", "example": 0.4, "maximum": 2, "minimum": 0, "nullable": true, "type": "number" }, "name": { "description": "New clip name", "example": "Updated intro", "maxLength": 255, "minLength": 1, "type": "string" }, "order": { "description": "New position of the clip within the video", "example": 2, "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, "studioSound": { "description": "Per-clip Studio Sound opt-out. `false` disables enhanced audio for this clip while the video-level switch (see `PATCH /v1/videos/{id}` `studioSound`) stays on; `true` re-enables it.", "example": false, "type": "boolean" }, "systemAudioVolume": { "description": "System audio (screen or uploaded footage) volume for this clip only, overriding the video's `systemAudioVolume`. Same range and null-to-clear behaviour as `microphoneVolume`. Returns 400 when the clip has no such audio to control, i.e. whenever a read reports the field as absent.", "example": 1.5, "maximum": 2, "minimum": 0, "nullable": true, "type": "number" }, "transition": { "allOf": [ { "$ref": "#/components/schemas/ClipTransition" } ], "description": "How this clip enters from the previous one. `default` drops the override and follows the video's `defaultClipTransition`." } }, "type": "object" }, "UpdateClipSoundEffectRequest": { "additionalProperties": false, "description": "Update an existing sound effect", "properties": { "durationMs": { "exclusiveMinimum": true, "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, "name": { "type": "string" }, "startTimeMs": { "description": "Start time. Milliseconds on the clip playback timeline (with cuts applied) — the same timeline as the cut transcript.", "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, "volume": { "description": "Playback volume (0 = muted, 1 = original).", "minimum": 0, "type": "number" } }, "type": "object" }, "UpdateClipTextOverlayRequest": { "additionalProperties": false, "description": "Update an existing text overlay", "minProperties": 1, "properties": { "background": { "allOf": [ { "$ref": "#/components/schemas/TextOverlayBackground" } ] }, "backgroundShape": { "allOf": [ { "$ref": "#/components/schemas/TextOverlayBackgroundShape" } ] }, "color": { "description": "Hex color in #RRGGBB or #RRGGBBAA form. Responses use uppercase #RRGGBBAA.", "example": "#FFFFFFFF", "pattern": "^#(?:[0-9A-Fa-f]{6}|[0-9A-Fa-f]{8})$", "type": "string" }, "dimensions": { "allOf": [ { "$ref": "#/components/schemas/OverlayDimensions" } ] }, "durationMs": { "exclusiveMinimum": true, "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, "fontFamily": { "allOf": [ { "$ref": "#/components/schemas/TextOverlayFontFamily" } ] }, "fontSize": { "description": "Font size in artboard pixels.", "exclusiveMinimum": true, "minimum": 0, "type": "number" }, "fontWeight": { "maximum": 1000, "minimum": 1, "type": "number" }, "fontWidth": { "exclusiveMinimum": true, "minimum": 0, "type": "number" }, "point": { "allOf": [ { "$ref": "#/components/schemas/OverlayPoint" } ] }, "startTimeMs": { "description": "Start time. Milliseconds on the clip playback timeline (with cuts applied) — the same timeline as the cut transcript.", "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, "text": { "minLength": 1, "type": "string" }, "textAlign": { "allOf": [ { "$ref": "#/components/schemas/TextOverlayTextAlign" } ] }, "transition": { "allOf": [ { "$ref": "#/components/schemas/TransitionStyle" } ], "description": "Intro/outro animation: `smooth` fades the text in at its start and out at its end, `hard_cut` pops it in and out." } }, "type": "object" }, "UpdateClipTranscriptWordsRequest": { "additionalProperties": false, "description": "Correct what the transcript says. Word edits change the transcript, captions and subtitles only — they never change the audio or the clip's timing. Use cut-by-transcript to remove spoken words from the video. The whole batch is applied atomically, so a request never changes only some of its words. A `500` does not by itself mean nothing changed — the words can land and a later step of the commit still fail — so treat the outcome as either fully applied or not applied at all, and re-send the identical request to settle it; every edit assigns a word outright, so re-sending is safe.", "properties": { "words": { "description": "Word edits to apply, at most one per word index and at most 100 per request. Indices are stable across cuts, but a word that is currently cut out of the clip cannot be edited.", "items": { "$ref": "#/components/schemas/TranscriptWordEdit" }, "maxItems": 100, "minItems": 1, "type": "array" } }, "required": [ "words" ], "type": "object" }, "UpdateClipTranscriptWordsResponse": { "additionalProperties": false, "description": "The words that were edited, after the edit.", "properties": { "words": { "description": "The edited words in their new state, in the order they were sent.", "items": { "$ref": "#/components/schemas/TranscriptWord" }, "type": "array" } }, "required": [ "words" ], "type": "object" }, "UpdateClipZoomRequest": { "additionalProperties": false, "description": "Update an existing zoom", "properties": { "durationMs": { "exclusiveMinimum": true, "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, "focusPoint": { "allOf": [ { "$ref": "#/components/schemas/ZoomFocusPoint" } ] }, "scale": { "description": "Magnification factor (1 = no zoom, 3.5 = max).", "example": 2, "maximum": 3.5, "minimum": 1, "type": "number" }, "startTimeMs": { "description": "Start time in ms on the clip's playback timeline (cuts applied)", "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, "type": { "description": "`manualZoom` zooms into a fixed `focusPoint` on the screen. `trackingZoom` automatically follows the cursor in the screen recording.", "enum": [ "manualZoom", "trackingZoom" ], "example": "manualZoom", "type": "string" } }, "type": "object" }, "UpdatePlaylistGroupRequest": { "description": "Request to rename and/or reorder a playlist group", "properties": { "emoji": { "description": "Unicode emoji character for the group", "example": "📁", "maxLength": 10, "type": "string" }, "name": { "description": "New playlist group name", "example": "Growth", "maxLength": 255, "minLength": 1, "type": "string" }, "position": { "description": "0-based position in the sidebar section (0 = top), counted across groups and ungrouped playlists", "example": 0, "maximum": 9007199254740991, "minimum": 0, "type": "integer" } }, "type": "object" }, "UpdatePlaylistRequest": { "additionalProperties": false, "description": "Request body for updating a playlist. At least one field must be provided.", "minProperties": 1, "properties": { "description": { "description": "Playlist description", "example": "Updated description for the playlist", "maxLength": 5000, "type": "string" }, "groupId": { "description": "Move the playlist into a playlist group (pg_...), or null to remove it from its group. The group's visibility must match the playlist's.", "example": "pg_abc123def456", "nullable": true, "type": "string" }, "linkScope": { "allOf": [ { "$ref": "#/components/schemas/PlaylistLinkScope" } ], "description": "Access level" }, "name": { "description": "Playlist name", "example": "Updated Playlist Name", "maxLength": 255, "minLength": 1, "type": "string" }, "password": { "description": "Password for viewing. Required when linkScope is 'password', ignored otherwise.", "example": "newpassword", "maxLength": 255, "minLength": 1, "type": "string" }, "position": { "description": "0-based position within the playlist's container (0 = top): its group when grouped, otherwise the sidebar section across groups and ungrouped playlists. Combine with groupId to move into a group at a specific position.", "example": 0, "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, "searchEngineIndexingEnabled": { "description": "Allow search engine indexing", "example": true, "type": "boolean" } }, "type": "object" }, "UpdateTagRequest": { "additionalProperties": false, "description": "Request body for updating a tag. At least one field is required.", "properties": { "color": { "allOf": [ { "$ref": "#/components/schemas/TagColor" } ] }, "description": { "description": "New tag description", "maxLength": 5000, "type": "string" }, "name": { "description": "New tag name", "example": "API", "maxLength": 255, "minLength": 1, "type": "string" } }, "type": "object" }, "UpdateTagResponse": { "additionalProperties": false, "description": "The updated tag", "properties": { "tag": { "$ref": "#/components/schemas/Tag" } }, "required": [ "tag" ], "type": "object" }, "UpdateVideoRequest": { "additionalProperties": false, "description": "Request body for updating a video. At least one field must be provided.", "minProperties": 1, "properties": { "allowedEmbedDomains": { "description": "Restrict embedding to these domains only (Premium feature). Empty array allows all domains.", "example": [ "example.com", "mysite.org" ], "items": { "type": "string" }, "type": "array" }, "captionGrouping": { "description": "How subtitle text is grouped: sentence chunks or one word at a time.", "enum": [ "chunked", "singleWord" ], "type": "string" }, "captionPosition": { "allOf": [ { "$ref": "#/components/schemas/CaptionPosition" } ], "description": "Normalized subtitle position; null restores automatic placement. Applies if subtitles are enabled on the video.", "nullable": true }, "captionSize": { "description": "Subtitle text size. Applies if subtitles are enabled on the video.", "enum": [ "small", "medium", "large" ], "type": "string" }, "captionStyle": { "allOf": [ { "$ref": "#/components/schemas/CaptionStyle" } ] }, "captionsDefaultEnabled": { "description": "Show subtitles to viewers by default", "example": true, "type": "boolean" }, "commentEmailsEnabled": { "description": "Send email notifications for new comments", "example": false, "type": "boolean" }, "commentsEnabled": { "description": "Allow viewers to comment", "example": true, "type": "boolean" }, "cursor": { "allOf": [ { "$ref": "#/components/schemas/CursorSettingsUpdate" } ] }, "customThumbnailURL": { "description": "Custom thumbnail image URL", "example": "https://example.com/custom-thumbnail.jpg", "format": "uri", "type": "string" }, "defaultClipTransition": { "allOf": [ { "$ref": "#/components/schemas/TransitionStyle" } ], "description": "How each clip enters from the previous one. A clip can override it with its own `transition`; see `PATCH /v1/videos/{id}/clips/{clipId}`.", "example": "hard_cut" }, "defaultPlaybackRate": { "description": "Default playback speed (0.5-2.0). Viewers can still adjust.", "example": 1, "maximum": 2, "minimum": 0.5, "type": "number" }, "description": { "description": "Video description", "example": "Updated description for the video", "maxLength": 5000, "type": "string" }, "dimensions": { "description": "Canvas size in pixels. Changing it also remaps every clip and section layout to a ratio-appropriate equivalent (clips using a custom layout fall back to a standard one), exactly like switching size in the editor's Setup → Size. No-op when the video already has the requested size. The editor's presets: 1920x1080 (16:9), 1920x1200 (16:10), 1440x1080 (4:3), 1080x1080 (1:1), 1080x1350 (4:5), 1080x1920 (9:16).", "example": { "height": 1920, "width": 1080 }, "properties": { "height": { "description": "Canvas height in pixels", "example": 1920, "maximum": 4096, "minimum": 16, "type": "number" }, "width": { "description": "Canvas width in pixels", "example": 1080, "maximum": 4096, "minimum": 16, "type": "number" } }, "required": [ "width", "height" ], "type": "object" }, "downloadsEnabled": { "description": "Allow viewers to download the video", "example": true, "type": "boolean" }, "linkScope": { "description": "Access level: public (anyone with link), private (org members only), password (requires password), embedonly (only viewable when embedded)", "enum": [ "public", "private", "password", "embedonly" ], "example": "public", "type": "string" }, "microphoneVolume": { "description": "Volume of the microphone (webcam) audio across the whole video. 1 is the recorded level, 0 mutes it, 2 doubles it. Clips that set their own `microphoneVolume` keep it — change or clear those with `PATCH /v1/videos/{id}/clips/{clipId}`.", "example": 1.2, "maximum": 2, "minimum": 0, "type": "number" }, "motionBlur": { "description": "Blur fast zoom, pan, and cursor movement. Defaults on for new videos.", "example": true, "type": "boolean" }, "name": { "description": "Video title", "example": "Updated Video Title", "maxLength": 255, "minLength": 1, "type": "string" }, "password": { "description": "Password for viewing. Required when linkScope is 'password', ignored otherwise.", "example": "secretpassword", "maxLength": 255, "minLength": 1, "type": "string" }, "publishDateEnabled": { "description": "Show publish date on video page", "example": true, "type": "boolean" }, "rawDownloadsEnabled": { "description": "Allow viewers to download raw source files", "example": false, "type": "boolean" }, "searchEngineIndexingEnabled": { "description": "Allow search engines to index the video page", "example": true, "type": "boolean" }, "shrinkCameraDuringZooms": { "description": "Shrink camera bubbles while a zoom is active. Defaults on.", "example": true, "type": "boolean" }, "studioSound": { "description": "Studio Sound (AI audio enhancement) master switch. Enabling it also starts generating the enhanced audio tracks in the background; playback and exports use them once ready and fall back to the raw audio until then.", "example": true, "type": "boolean" }, "subtitlesEnabled": { "description": "Allow viewers to enable subtitles", "example": true, "type": "boolean" }, "systemAudioVolume": { "description": "Volume of the system/screen audio across the whole video — everything that is not microphone audio. 1 is the recorded level, 0 mutes it, 2 doubles it. Clips that set their own `systemAudioVolume` keep it — change or clear those with `PATCH /v1/videos/{id}/clips/{clipId}`.", "example": 0.4, "maximum": 2, "minimum": 0, "type": "number" }, "transcriptsEnabled": { "description": "Show transcript panel to viewers", "example": true, "type": "boolean" }, "viewCountEnabled": { "description": "Show view count on video page", "example": true, "type": "boolean" } }, "type": "object" }, "UpdateWebhookEndpointRequest": { "additionalProperties": false, "description": "Fields to update on a webhook endpoint", "minProperties": 1, "properties": { "disabled": { "description": "Pause or resume delivery to the endpoint", "type": "boolean" }, "filterTypes": { "description": "New event types to deliver. Pass a non-empty array to replace the filter, or null to clear it so every event type is delivered. Omit to leave it unchanged.", "example": [ "video.created", "export.ready" ], "items": { "type": "string" }, "minItems": 1, "nullable": true, "type": "array" }, "url": { "description": "New delivery URL", "example": "https://example.com/webhooks/tella", "format": "uri", "type": "string" } }, "type": "object" }, "UpdateWebhookEndpointResponse": { "additionalProperties": false, "description": "The updated webhook endpoint", "properties": { "endpoint": { "$ref": "#/components/schemas/WebhookEndpoint" } }, "required": [ "endpoint" ], "type": "object" }, "VideoDetail": { "additionalProperties": false, "description": "Detailed information about a video including chapters, transcript, and exports", "properties": { "aspectRatio": { "description": "Video aspect ratio (e.g., '16:9', '9:16')", "example": "16:9", "type": "string" }, "backgroundMusic": { "allOf": [ { "$ref": "#/components/schemas/BackgroundMusic" } ], "description": "Video-wide track that loops over the whole video and is included in exports", "nullable": true }, "chapters": { "description": "Video chapters/sections", "items": { "$ref": "#/components/schemas/Chapter" }, "type": "array" }, "clipIds": { "description": "Ordered IDs of the clips in the video. Use `/v1/videos/{id}/clips/{clipId}` to fetch each one.", "example": [ "cl_abc123", "cl_def456" ], "items": { "type": "string" }, "type": "array" }, "createdAt": { "description": "ISO 8601 datetime", "example": "2024-01-15T10:30:00.000Z", "format": "date-time", "type": "string" }, "description": { "description": "Video description", "example": "Learn how to create and share your first video", "maxLength": 5000, "type": "string" }, "dimensions": { "additionalProperties": false, "description": "Canvas size in pixels", "example": { "height": 1080, "width": 1920 }, "properties": { "height": { "type": "number" }, "width": { "type": "number" } }, "required": [ "width", "height" ], "type": "object" }, "durationSeconds": { "description": "Video duration in seconds", "example": 125.5, "minimum": 0, "type": "number" }, "exports": { "description": "Available exports and their status", "items": { "$ref": "#/components/schemas/ExportStatus" }, "type": "array" }, "id": { "description": "Unique video identifier", "example": "vid_abc123def456", "type": "string" }, "links": { "allOf": [ { "$ref": "#/components/schemas/VideoLinks" } ], "description": "Related URLs for the video" }, "name": { "description": "Video title", "example": "Getting Started with Tella", "maxLength": 255, "minLength": 1, "type": "string" }, "playlistIds": { "description": "IDs of playlists containing this video", "example": [ "pl_abc123", "pl_def456" ], "items": { "type": "string" }, "type": "array" }, "settings": { "allOf": [ { "$ref": "#/components/schemas/VideoSettings" } ] }, "thumbnails": { "allOf": [ { "$ref": "#/components/schemas/Thumbnails" } ], "description": "Available thumbnail URLs by format and resolution" }, "transcript": { "allOf": [ { "$ref": "#/components/schemas/Transcript" } ] }, "updatedAt": { "description": "ISO 8601 datetime", "example": "2024-01-15T14:45:00.000Z", "format": "date-time", "type": "string" }, "views": { "description": "Total view count", "example": 1234, "maximum": 9007199254740991, "minimum": 0, "type": "integer" } }, "required": [ "id", "name", "description", "views", "aspectRatio", "dimensions", "createdAt", "updatedAt", "durationSeconds", "chapters", "transcript", "thumbnails", "exports", "settings", "links", "playlistIds", "clipIds", "backgroundMusic" ], "type": "object" }, "VideoEditOperation": { "description": "One timeline edit — an add, update, or remove. Operations may target different clips in the same video, and update/remove operations may reference a resource added earlier in the batch by that operation's operationId.", "discriminator": { "mapping": { "add_blur": "#/components/schemas/BatchAddBlurOperation", "add_highlight": "#/components/schemas/BatchAddHighlightOperation", "add_media_overlay": "#/components/schemas/BatchAddMediaOverlayOperation", "add_sound_effect": "#/components/schemas/BatchAddSoundEffectOperation", "add_text_overlay": "#/components/schemas/BatchAddTextOverlayOperation", "add_zoom": "#/components/schemas/BatchAddZoomOperation", "remove_blur": "#/components/schemas/BatchRemoveBlurOperation", "remove_highlight": "#/components/schemas/BatchRemoveHighlightOperation", "remove_media_overlay": "#/components/schemas/BatchRemoveMediaOverlayOperation", "remove_sound_effect": "#/components/schemas/BatchRemoveSoundEffectOperation", "remove_text_overlay": "#/components/schemas/BatchRemoveTextOverlayOperation", "remove_zoom": "#/components/schemas/BatchRemoveZoomOperation", "update_blur": "#/components/schemas/BatchUpdateBlurOperation", "update_highlight": "#/components/schemas/BatchUpdateHighlightOperation", "update_media_overlay": "#/components/schemas/BatchUpdateMediaOverlayOperation", "update_sound_effect": "#/components/schemas/BatchUpdateSoundEffectOperation", "update_text_overlay": "#/components/schemas/BatchUpdateTextOverlayOperation", "update_zoom": "#/components/schemas/BatchUpdateZoomOperation" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/components/schemas/BatchAddSoundEffectOperation" }, { "$ref": "#/components/schemas/BatchAddTextOverlayOperation" }, { "$ref": "#/components/schemas/BatchAddZoomOperation" }, { "$ref": "#/components/schemas/BatchAddBlurOperation" }, { "$ref": "#/components/schemas/BatchAddHighlightOperation" }, { "$ref": "#/components/schemas/BatchAddMediaOverlayOperation" }, { "$ref": "#/components/schemas/BatchUpdateZoomOperation" }, { "$ref": "#/components/schemas/BatchRemoveZoomOperation" }, { "$ref": "#/components/schemas/BatchUpdateBlurOperation" }, { "$ref": "#/components/schemas/BatchRemoveBlurOperation" }, { "$ref": "#/components/schemas/BatchUpdateHighlightOperation" }, { "$ref": "#/components/schemas/BatchRemoveHighlightOperation" }, { "$ref": "#/components/schemas/BatchUpdateMediaOverlayOperation" }, { "$ref": "#/components/schemas/BatchRemoveMediaOverlayOperation" }, { "$ref": "#/components/schemas/BatchUpdateTextOverlayOperation" }, { "$ref": "#/components/schemas/BatchRemoveTextOverlayOperation" }, { "$ref": "#/components/schemas/BatchUpdateSoundEffectOperation" }, { "$ref": "#/components/schemas/BatchRemoveSoundEffectOperation" } ], "type": "object" }, "VideoLinks": { "additionalProperties": false, "description": "URLs related to a video", "properties": { "embedPage": { "description": "URL for embedding the video", "example": "https://www.tella.tv/video/vid_abc123def456/embed", "format": "uri", "type": "string" }, "viewPage": { "description": "URL to view the video on Tella", "example": "https://www.tella.tv/video/vid_abc123def456/view", "format": "uri", "type": "string" } }, "required": [ "viewPage", "embedPage" ], "type": "object" }, "VideoListItem": { "additionalProperties": false, "description": "Video item in a list response", "properties": { "aspectRatio": { "description": "Video aspect ratio (e.g., '16:9', '9:16')", "example": "16:9", "type": "string" }, "createdAt": { "description": "ISO 8601 datetime", "example": "2024-01-15T10:30:00.000Z", "format": "date-time", "type": "string" }, "description": { "description": "Video description", "example": "Learn how to create and share your first video", "maxLength": 5000, "type": "string" }, "dimensions": { "additionalProperties": false, "description": "Canvas size in pixels", "example": { "height": 1080, "width": 1920 }, "properties": { "height": { "type": "number" }, "width": { "type": "number" } }, "required": [ "width", "height" ], "type": "object" }, "id": { "description": "Unique video identifier", "example": "vid_abc123def456", "type": "string" }, "links": { "allOf": [ { "$ref": "#/components/schemas/VideoLinks" } ], "description": "Related URLs for the video" }, "name": { "description": "Video title", "example": "Getting Started with Tella", "maxLength": 255, "minLength": 1, "type": "string" }, "updatedAt": { "description": "ISO 8601 datetime", "example": "2024-01-15T14:45:00.000Z", "format": "date-time", "type": "string" }, "views": { "description": "Total view count", "example": 1234, "maximum": 9007199254740991, "minimum": 0, "type": "integer" } }, "required": [ "id", "name", "description", "views", "aspectRatio", "dimensions", "createdAt", "updatedAt", "links" ], "type": "object" }, "VideoSettings": { "additionalProperties": false, "description": "Video playback and access settings", "properties": { "allowedEmbedDomains": { "description": "Restrict embedding to these domains only (Premium feature). Empty array allows all domains.", "example": [ "example.com", "mysite.org" ], "items": { "type": "string" }, "type": "array" }, "captionGrouping": { "description": "How subtitle text is grouped: sentence chunks or one word at a time.", "enum": [ "chunked", "singleWord" ], "example": "chunked", "type": "string" }, "captionPosition": { "allOf": [ { "$ref": "#/components/schemas/CaptionPosition" } ], "description": "Normalized subtitle position, or null for automatic placement. Applies if subtitles are enabled on the video.", "nullable": true }, "captionSize": { "description": "Subtitle text size. Applies if subtitles are enabled on the video.", "enum": [ "small", "medium", "large" ], "example": "medium", "type": "string" }, "captionStyle": { "$ref": "#/components/schemas/CaptionStyle" }, "captionsDefaultEnabled": { "description": "Show subtitles to viewers by default", "example": true, "type": "boolean" }, "commentEmailsEnabled": { "description": "Send email notifications for new comments", "example": false, "type": "boolean" }, "commentsEnabled": { "description": "Allow viewers to comment", "example": true, "type": "boolean" }, "cursor": { "$ref": "#/components/schemas/CursorSettings" }, "customThumbnailURL": { "description": "Custom thumbnail image URL", "example": "https://example.com/custom-thumbnail.jpg", "format": "uri", "nullable": true, "type": "string" }, "defaultClipTransition": { "allOf": [ { "$ref": "#/components/schemas/TransitionStyle" } ], "description": "How each clip enters from the previous one, unless the clip overrides it via its own `transition`.", "example": "hard_cut" }, "defaultPlaybackRate": { "description": "Default playback speed (0.5-2.0). Viewers can still adjust.", "example": 1, "maximum": 2, "minimum": 0.5, "type": "number" }, "downloadsEnabled": { "description": "Allow viewers to download the video", "example": true, "type": "boolean" }, "linkScope": { "allOf": [ { "$ref": "#/components/schemas/VideoSettingsLinkScope" } ], "description": "Current access level, including `org` for workspace-visible videos" }, "microphoneVolume": { "description": "Volume of the microphone (webcam) audio across the video. 1 is the recorded level, 0 mutes it, 2 doubles it. A clip can override it for one of its sources.", "example": 1, "maximum": 2, "minimum": 0, "type": "number" }, "motionBlur": { "description": "Blur fast zoom, pan, and cursor movement. Defaults on for new videos.", "example": true, "type": "boolean" }, "publishDateEnabled": { "description": "Show publish date on video page", "example": true, "type": "boolean" }, "rawDownloadsEnabled": { "description": "Allow viewers to download raw source files", "example": false, "type": "boolean" }, "searchEngineIndexingEnabled": { "description": "Allow search engines to index the video page", "example": true, "type": "boolean" }, "shrinkCameraDuringZooms": { "description": "Shrink camera bubbles while a zoom is active. Defaults on.", "example": true, "type": "boolean" }, "studioSound": { "description": "Studio Sound (AI audio enhancement) master switch for the video. Individual clips can opt out via the clip's `studioSound` field.", "example": false, "type": "boolean" }, "subtitlesEnabled": { "description": "Allow viewers to enable subtitles", "example": true, "type": "boolean" }, "systemAudioVolume": { "description": "Volume of the system/screen audio across the video — everything that is not microphone audio. 1 is the recorded level, 0 mutes it, 2 doubles it. A clip can override it for one of its sources.", "example": 1, "maximum": 2, "minimum": 0, "type": "number" }, "transcriptsEnabled": { "description": "Show transcript panel to viewers", "example": true, "type": "boolean" }, "viewCountEnabled": { "description": "Show view count on video page", "example": true, "type": "boolean" } }, "required": [ "defaultPlaybackRate", "captionsDefaultEnabled", "subtitlesEnabled", "captionStyle", "captionSize", "captionGrouping", "captionPosition", "transcriptsEnabled", "publishDateEnabled", "viewCountEnabled", "commentsEnabled", "commentEmailsEnabled", "downloadsEnabled", "rawDownloadsEnabled", "linkScope", "searchEngineIndexingEnabled", "allowedEmbedDomains", "customThumbnailURL", "studioSound", "defaultClipTransition", "microphoneVolume", "systemAudioVolume", "motionBlur", "shrinkCameraDuringZooms", "cursor" ], "type": "object" }, "VideoSettingsLinkScope": { "description": "Current video access level. The read-only `org` value means the video is visible across its workspace; public updates intentionally do not accept that value.", "enum": [ "public", "private", "org", "password", "embedonly" ], "example": "org", "type": "string" }, "WebhookEndpoint": { "additionalProperties": false, "description": "A webhook subscription endpoint", "properties": { "createdAt": { "description": "When the endpoint was created", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$", "type": "string" }, "disabled": { "description": "Whether delivery to this endpoint is disabled", "example": false, "type": "boolean" }, "filterTypes": { "description": "Event types delivered to this endpoint, or null when no filter is set and every event type is delivered", "example": [ "video.created", "export.ready" ], "items": { "type": "string" }, "nullable": true, "type": "array" }, "id": { "description": "Unique identifier for the webhook endpoint", "example": "ep_abc123def456", "type": "string" }, "updatedAt": { "description": "When the endpoint was last updated", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$", "type": "string" }, "url": { "description": "The URL where webhook events are sent", "example": "https://example.com/webhooks/tella", "format": "uri", "type": "string" } }, "required": [ "id", "url", "filterTypes", "disabled", "createdAt", "updatedAt" ], "type": "object" }, "WebhookMessage": { "additionalProperties": false, "description": "A webhook message/event", "properties": { "eventType": { "description": "The type of event", "example": "video.created", "type": "string" }, "id": { "description": "Unique identifier for the message", "example": "msg_abc123", "type": "string" }, "payload": { "description": "The event payload data" }, "timestamp": { "description": "ISO 8601 timestamp when the event occurred", "example": "2024-01-15T10:30:00Z", "format": "date-time", "type": "string" } }, "required": [ "id", "eventType", "payload", "timestamp" ], "type": "object" }, "ZoomFocusPoint": { "description": "Point on the screen recording to zoom into, expressed as percentages of the screen dimensions. Required for `manualZoom`; ignored for `trackingZoom`.", "properties": { "xPct": { "description": "Horizontal position on the screen frame (0-100). 0 = left edge.", "example": 50, "maximum": 100, "minimum": 0, "type": "number" }, "yPct": { "description": "Vertical position on the screen frame (0-100). 0 = top edge.", "example": 50, "maximum": 100, "minimum": 0, "type": "number" } }, "required": [ "xPct", "yPct" ], "type": "object" }, "ZoomFocusPointOutput": { "additionalProperties": false, "description": "Point on the screen recording to zoom into, expressed as percentages of the screen dimensions. Required for `manualZoom`; ignored for `trackingZoom`.", "properties": { "xPct": { "description": "Horizontal position on the screen frame (0-100). 0 = left edge.", "example": 50, "maximum": 100, "minimum": 0, "type": "number" }, "yPct": { "description": "Vertical position on the screen frame (0-100). 0 = top edge.", "example": 50, "maximum": 100, "minimum": 0, "type": "number" } }, "required": [ "xPct", "yPct" ], "type": "object" } }, "securitySchemes": { "BearerAuth": { "description": "API key obtained from your Tella account settings", "scheme": "bearer", "type": "http" } } }, "externalDocs": { "description": "API versioning and deprecation policy", "url": "https://www.tella.com/docs/versioning" }, "info": { "description": "The Tella Public API allows you to programmatically access your videos and playlists, including transcripts, chapters, and thumbnails.\n\n## Authentication\n\nAll requests require a Bearer token in the Authorization header:\n```\nAuthorization: Bearer tella_pk_xxxxx...\n```\n\nAPI keys can be generated in your Tella workspace settings.\n\n## Rate Limiting\n\nThe API is rate-limited to 100 requests per minute per user within a workspace.\nRate limit information is returned in response headers:\n- `RateLimit-Policy`: Named quota, request limit, and window in seconds\n- `RateLimit`: Remaining quota and seconds until reset\n- `X-RateLimit-Limit`: Maximum requests per window\n- `X-RateLimit-Remaining`: Remaining requests in current window\n- `X-RateLimit-Reset`: Unix timestamp in milliseconds when the window resets\n\nA `429 Too Many Requests` response also includes `Retry-After` in seconds.", "title": "Tella Public API", "version": "1.0.0" }, "openapi": "3.0.3", "paths": { "/v1/backgrounds": { "get": { "description": "Returns personal uploads, workspace uploads, and Tella's default image and animated backgrounds in named categories. Each item includes a preview URL and a background value that can be passed directly to the clip update endpoint.", "operationId": "listBackgrounds", "parameters": [ { "description": "Filter by scope", "in": "query", "name": "scope", "schema": { "allOf": [ { "$ref": "#/components/schemas/BackgroundScope" } ], "description": "Filter by scope" } }, { "description": "Filter by category ID, such as personal, workspace, default:tella, default:macos, or default:animated", "in": "query", "name": "categoryId", "schema": { "description": "Filter by category ID, such as personal, workspace, default:tella, default:macos, or default:animated", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListBackgroundsResponse" } } }, "description": "OK", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "400": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "bad_request", "message": "The request was malformed or contained invalid parameters." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request was malformed or contained invalid parameters.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "401": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "unauthorized", "message": "Authentication is required. Provide a valid API key." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required. Provide a valid API key.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "403": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "forbidden", "message": "You don't have permission to access this resource." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "You don't have permission to access this resource.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "404": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "not_found", "message": "The requested resource was not found." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested resource was not found.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "429": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "rate_limited", "message": "You have exceeded the rate limit. Please slow down." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "You have exceeded the rate limit. Please slow down.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Retry-After": { "$ref": "#/components/headers/RetryAfter" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "500": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "server_error", "message": "An unexpected error occurred" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "501": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "not_implemented", "message": "The requested operation is not implemented." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested operation is not implemented.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } } }, "security": [ { "BearerAuth": [] } ], "summary": "List available backgrounds", "tags": [ "Backgrounds" ] } }, "/v1/library": { "get": { "description": "Returns a page of reusable media saved to the library — images, videos, sound effects, music and LUTs — for one scope. Items added through the API include a `sourceId` you can pass anywhere a source is accepted, including images. Editor-added images, music and LUTs expose a hosted `url` instead. Media still being generated in the editor is omitted. `scope=default` returns Tella's curated sound effect catalog instead of stored media: those items carry a `presetId` to place them with, a `category`, and a publicly fetchable `url` for previewing, and arrive as a single page. Tella's default backgrounds are not part of this catalog — they are placed as a background rather than as a source, and are listed by `GET /v1/backgrounds`.", "operationId": "listLibraryItems", "parameters": [ { "description": "Which set of media to read: `private` (only visible to their creator), `workspace` (shared with everyone in the workspace), or `default` (Tella's curated sound effect catalog, which holds no other media type)", "in": "query", "name": "scope", "required": true, "schema": { "$ref": "#/components/schemas/LibraryReadScope" } }, { "description": "Only return items of this type. With `scope=default` only `sound-effect` is valid, since the curated catalog holds no other media type.", "in": "query", "name": "type", "schema": { "allOf": [ { "$ref": "#/components/schemas/LibraryItemType" } ], "description": "Only return items of this type. With `scope=default` only `sound-effect` is valid, since the curated catalog holds no other media type." } }, { "description": "Pagination cursor from a previous response. Keep paging while `cursor` is present. `scope=default` is a fixed catalog returned as a single page, so it never sets one.", "in": "query", "name": "cursor", "schema": { "description": "Pagination cursor from a previous response. Keep paging while `cursor` is present. `scope=default` is a fixed catalog returned as a single page, so it never sets one.", "type": "string" } }, { "description": "Items per page (1-60, default 24). Treat it as a target rather than an exact count: pages are read from storage before unlistable items are filtered out, and cursors address whole storage pages, so a response may contain somewhat more than `limit`. Returning the extra items is deliberate — trimming them would drop them, because the cursor has already moved past.", "in": "query", "name": "limit", "schema": { "description": "Items per page (1-60, default 24). Treat it as a target rather than an exact count: pages are read from storage before unlistable items are filtered out, and cursors address whole storage pages, so a response may contain somewhat more than `limit`. Returning the extra items is deliberate — trimming them would drop them, because the cursor has already moved past.", "example": 24, "maximum": 60, "minimum": 1, "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListLibraryResponse" } } }, "description": "OK", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "400": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "bad_request", "message": "The request was malformed or contained invalid parameters." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request was malformed or contained invalid parameters.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "401": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "unauthorized", "message": "Authentication is required. Provide a valid API key." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required. Provide a valid API key.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "403": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "forbidden", "message": "You don't have permission to access this resource." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "You don't have permission to access this resource.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "404": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "not_found", "message": "The requested resource was not found." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested resource was not found.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "429": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "rate_limited", "message": "You have exceeded the rate limit. Please slow down." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "You have exceeded the rate limit. Please slow down.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Retry-After": { "$ref": "#/components/headers/RetryAfter" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "500": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "server_error", "message": "An unexpected error occurred" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "501": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "not_implemented", "message": "The requested operation is not implemented." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested operation is not implemented.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } } }, "security": [ { "BearerAuth": [] } ], "summary": "List library items", "tags": [ "Library" ] }, "post": { "description": "Saves an uploaded source to the library so it can be listed and reused later, both here and in the editor's media panels. Create the source via `POST /v1/sources` and upload the bytes first, then pass its `sourceId`. Without this a source is only reachable through the clips that already reference it.", "operationId": "createLibraryItem", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateLibraryItemRequest" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateLibraryItemResponse" } } }, "description": "Created", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "400": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "bad_request", "message": "The request was malformed or contained invalid parameters." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request was malformed or contained invalid parameters.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "401": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "unauthorized", "message": "Authentication is required. Provide a valid API key." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required. Provide a valid API key.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "403": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "forbidden", "message": "You don't have permission to access this resource." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "You don't have permission to access this resource.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "404": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "not_found", "message": "The requested resource was not found." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested resource was not found.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "429": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "rate_limited", "message": "You have exceeded the rate limit. Please slow down." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "You have exceeded the rate limit. Please slow down.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Retry-After": { "$ref": "#/components/headers/RetryAfter" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "500": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "server_error", "message": "An unexpected error occurred" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "501": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "not_implemented", "message": "The requested operation is not implemented." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested operation is not implemented.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } } }, "security": [ { "BearerAuth": [] } ], "summary": "Add a source to the library", "tags": [ "Library" ] } }, "/v1/library/{id}": { "delete": { "description": "Removes an item from the library. This removes the library entry only — clips already using the underlying source keep working.", "operationId": "deleteLibraryItem", "parameters": [ { "description": "Library item ID", "in": "path", "name": "id", "required": true, "schema": { "description": "Library item ID", "example": "media_abc123def456", "type": "string" } }, { "description": "Which library the item belongs to: `workspace` items are shared with everyone in the workspace, `private` items are only visible to their creator", "in": "query", "name": "scope", "required": true, "schema": { "$ref": "#/components/schemas/LibraryScope" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } }, "description": "OK", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "400": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "bad_request", "message": "The request was malformed or contained invalid parameters." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request was malformed or contained invalid parameters.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "401": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "unauthorized", "message": "Authentication is required. Provide a valid API key." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required. Provide a valid API key.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "403": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "forbidden", "message": "You don't have permission to access this resource." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "You don't have permission to access this resource.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "404": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "not_found", "message": "The requested resource was not found." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested resource was not found.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "429": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "rate_limited", "message": "You have exceeded the rate limit. Please slow down." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "You have exceeded the rate limit. Please slow down.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Retry-After": { "$ref": "#/components/headers/RetryAfter" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "500": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "server_error", "message": "An unexpected error occurred" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "501": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "not_implemented", "message": "The requested operation is not implemented." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested operation is not implemented.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } } }, "security": [ { "BearerAuth": [] } ], "summary": "Remove a library item", "tags": [ "Library" ] } }, "/v1/playlist-groups": { "get": { "description": "Returns the sidebar playlist groups for the authenticated user, in sidebar order. Personal groups are only visible to you; org groups are shared with the whole workspace.", "operationId": "listPlaylistGroups", "parameters": [ { "description": "Filter by visibility: personal or org. Omit to list all groups.", "in": "query", "name": "visibility", "schema": { "allOf": [ { "$ref": "#/components/schemas/PlaylistGroupVisibility" } ], "description": "Filter by visibility: personal or org. Omit to list all groups." } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListPlaylistGroupsResponse" } } }, "description": "OK", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "400": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "bad_request", "message": "The request was malformed or contained invalid parameters." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request was malformed or contained invalid parameters.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "401": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "unauthorized", "message": "Authentication is required. Provide a valid API key." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required. Provide a valid API key.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "403": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "forbidden", "message": "You don't have permission to access this resource." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "You don't have permission to access this resource.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "404": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "not_found", "message": "The requested resource was not found." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested resource was not found.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "429": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "rate_limited", "message": "You have exceeded the rate limit. Please slow down." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "You have exceeded the rate limit. Please slow down.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Retry-After": { "$ref": "#/components/headers/RetryAfter" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "500": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "server_error", "message": "An unexpected error occurred" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "501": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "not_implemented", "message": "The requested operation is not implemented." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested operation is not implemented.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } } }, "security": [ { "BearerAuth": [] } ], "summary": "List playlist groups", "tags": [ "Playlist Groups" ] }, "post": { "description": "Create a sidebar group to organize playlists into. Use the groupId field on PATCH /v1/playlists/{id} to move playlists into it.", "operationId": "createPlaylistGroup", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreatePlaylistGroupRequest" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlaylistGroupResponse" } } }, "description": "Created", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "400": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "bad_request", "message": "The request was malformed or contained invalid parameters." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request was malformed or contained invalid parameters.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "401": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "unauthorized", "message": "Authentication is required. Provide a valid API key." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required. Provide a valid API key.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "403": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "forbidden", "message": "You don't have permission to access this resource." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "You don't have permission to access this resource.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "404": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "not_found", "message": "The requested resource was not found." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested resource was not found.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "429": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "rate_limited", "message": "You have exceeded the rate limit. Please slow down." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "You have exceeded the rate limit. Please slow down.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Retry-After": { "$ref": "#/components/headers/RetryAfter" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "500": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "server_error", "message": "An unexpected error occurred" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "501": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "not_implemented", "message": "The requested operation is not implemented." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested operation is not implemented.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } } }, "security": [ { "BearerAuth": [] } ], "summary": "Create a playlist group", "tags": [ "Playlist Groups" ] } }, "/v1/playlist-groups/{id}": { "delete": { "description": "Delete a playlist group. Playlists in the group are not deleted, they just become ungrouped.", "operationId": "deletePlaylistGroup", "parameters": [ { "description": "Unique playlist group identifier", "in": "path", "name": "id", "required": true, "schema": { "description": "Unique playlist group identifier", "example": "pg_abc123def456", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } }, "description": "Playlist group successfully deleted", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "400": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "bad_request", "message": "The request was malformed or contained invalid parameters." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request was malformed or contained invalid parameters.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "401": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "unauthorized", "message": "Authentication is required. Provide a valid API key." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required. Provide a valid API key.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "403": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "forbidden", "message": "You don't have permission to access this resource." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "You don't have permission to access this resource.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "404": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "not_found", "message": "The requested resource was not found." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested resource was not found.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "429": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "rate_limited", "message": "You have exceeded the rate limit. Please slow down." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "You have exceeded the rate limit. Please slow down.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Retry-After": { "$ref": "#/components/headers/RetryAfter" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "500": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "server_error", "message": "An unexpected error occurred" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "501": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "not_implemented", "message": "The requested operation is not implemented." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested operation is not implemented.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } } }, "security": [ { "BearerAuth": [] } ], "summary": "Delete a playlist group", "tags": [ "Playlist Groups" ] }, "patch": { "description": "Rename a playlist group and/or move it to a position in its sidebar section (0 = top)", "operationId": "updatePlaylistGroup", "parameters": [ { "description": "Unique playlist group identifier", "in": "path", "name": "id", "required": true, "schema": { "description": "Unique playlist group identifier", "example": "pg_abc123def456", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdatePlaylistGroupRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlaylistGroupResponse" } } }, "description": "OK", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "400": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "bad_request", "message": "The request was malformed or contained invalid parameters." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request was malformed or contained invalid parameters.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "401": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "unauthorized", "message": "Authentication is required. Provide a valid API key." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required. Provide a valid API key.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "403": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "forbidden", "message": "You don't have permission to access this resource." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "You don't have permission to access this resource.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "404": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "not_found", "message": "The requested resource was not found." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested resource was not found.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "429": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "rate_limited", "message": "You have exceeded the rate limit. Please slow down." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "You have exceeded the rate limit. Please slow down.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Retry-After": { "$ref": "#/components/headers/RetryAfter" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "500": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "server_error", "message": "An unexpected error occurred" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "501": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "not_implemented", "message": "The requested operation is not implemented." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested operation is not implemented.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } } }, "security": [ { "BearerAuth": [] } ], "summary": "Rename or reorder a playlist group", "tags": [ "Playlist Groups" ] } }, "/v1/playlists": { "get": { "description": "Returns a list of all playlists for the authenticated user", "operationId": "listPlaylists", "parameters": [ { "description": "Filter by visibility: personal (only your playlists) or org (shared with organization). Default: personal", "in": "query", "name": "visibility", "schema": { "allOf": [ { "$ref": "#/components/schemas/PlaylistVisibility" } ], "default": "personal", "description": "Filter by visibility: personal (only your playlists) or org (shared with organization). Default: personal" } }, { "description": "Pagination cursor from previous response", "in": "query", "name": "cursor", "schema": { "description": "Pagination cursor from previous response", "example": "eyJpZCI6InBsX3h5eiJ9", "type": "string" } }, { "description": "Items per page (default: 20, max: 100)", "in": "query", "name": "limit", "schema": { "description": "Items per page (default: 20, max: 100)", "example": 20, "maximum": 100, "minimum": 1, "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "pagination": { "$ref": "#/components/schemas/Pagination" }, "playlists": { "description": "List of playlists", "items": { "$ref": "#/components/schemas/PlaylistListItem" }, "type": "array" } }, "required": [ "playlists", "pagination" ], "type": "object" } } }, "description": "OK", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "400": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "bad_request", "message": "The request was malformed or contained invalid parameters." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request was malformed or contained invalid parameters.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "401": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "unauthorized", "message": "Authentication is required. Provide a valid API key." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required. Provide a valid API key.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "403": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "forbidden", "message": "You don't have permission to access this resource." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "You don't have permission to access this resource.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "404": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "not_found", "message": "The requested resource was not found." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested resource was not found.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "429": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "rate_limited", "message": "You have exceeded the rate limit. Please slow down." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "You have exceeded the rate limit. Please slow down.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Retry-After": { "$ref": "#/components/headers/RetryAfter" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "500": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "server_error", "message": "An unexpected error occurred" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "501": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "not_implemented", "message": "The requested operation is not implemented." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested operation is not implemented.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } } }, "security": [ { "BearerAuth": [] } ], "summary": "List all playlists", "tags": [ "Playlists" ] }, "post": { "description": "Create a new playlist for the authenticated user", "operationId": "createPlaylist", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreatePlaylistRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "playlist": { "$ref": "#/components/schemas/PlaylistDetail" } }, "required": [ "playlist" ], "type": "object" } } }, "description": "OK", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "400": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "bad_request", "message": "The request was malformed or contained invalid parameters." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request was malformed or contained invalid parameters.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "401": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "unauthorized", "message": "Authentication is required. Provide a valid API key." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required. Provide a valid API key.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "403": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "forbidden", "message": "You don't have permission to access this resource." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "You don't have permission to access this resource.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "404": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "not_found", "message": "The requested resource was not found." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested resource was not found.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "429": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "rate_limited", "message": "You have exceeded the rate limit. Please slow down." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "You have exceeded the rate limit. Please slow down.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Retry-After": { "$ref": "#/components/headers/RetryAfter" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "500": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "server_error", "message": "An unexpected error occurred" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "501": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "not_implemented", "message": "The requested operation is not implemented." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested operation is not implemented.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } } }, "security": [ { "BearerAuth": [] } ], "summary": "Create a new playlist", "tags": [ "Playlists" ] } }, "/v1/playlists/{id}": { "delete": { "description": "Permanently delete a playlist. Videos in the playlist are not deleted.", "operationId": "deletePlaylist", "parameters": [ { "description": "Unique playlist identifier", "in": "path", "name": "id", "required": true, "schema": { "description": "Unique playlist identifier", "example": "pl_abc123def456", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } }, "description": "Playlist successfully deleted", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "400": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "bad_request", "message": "The request was malformed or contained invalid parameters." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request was malformed or contained invalid parameters.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "401": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "unauthorized", "message": "Authentication is required. Provide a valid API key." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required. Provide a valid API key.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "403": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "forbidden", "message": "You don't have permission to access this resource." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "You don't have permission to access this resource.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "404": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "not_found", "message": "The requested resource was not found." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested resource was not found.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "429": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "rate_limited", "message": "You have exceeded the rate limit. Please slow down." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "You have exceeded the rate limit. Please slow down.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Retry-After": { "$ref": "#/components/headers/RetryAfter" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "500": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "server_error", "message": "An unexpected error occurred" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "501": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "not_implemented", "message": "The requested operation is not implemented." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested operation is not implemented.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } } }, "security": [ { "BearerAuth": [] } ], "summary": "Delete a playlist", "tags": [ "Playlists" ] }, "get": { "description": "Returns detailed information about a playlist including its videos", "operationId": "getPlaylist", "parameters": [ { "description": "Unique playlist identifier", "in": "path", "name": "id", "required": true, "schema": { "description": "Unique playlist identifier", "example": "pl_abc123def456", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "playlist": { "$ref": "#/components/schemas/PlaylistDetail" } }, "required": [ "playlist" ], "type": "object" } } }, "description": "OK", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "400": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "bad_request", "message": "The request was malformed or contained invalid parameters." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request was malformed or contained invalid parameters.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "401": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "unauthorized", "message": "Authentication is required. Provide a valid API key." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required. Provide a valid API key.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "403": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "forbidden", "message": "You don't have permission to access this resource." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "You don't have permission to access this resource.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "404": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "not_found", "message": "The requested resource was not found." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested resource was not found.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "429": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "rate_limited", "message": "You have exceeded the rate limit. Please slow down." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "You have exceeded the rate limit. Please slow down.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Retry-After": { "$ref": "#/components/headers/RetryAfter" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "500": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "server_error", "message": "An unexpected error occurred" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "501": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "not_implemented", "message": "The requested operation is not implemented." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested operation is not implemented.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } } }, "security": [ { "BearerAuth": [] } ], "summary": "Get playlist details", "tags": [ "Playlists" ] }, "patch": { "description": "Update a playlist's name and/or description", "operationId": "updatePlaylist", "parameters": [ { "description": "Unique playlist identifier", "in": "path", "name": "id", "required": true, "schema": { "description": "Unique playlist identifier", "example": "pl_abc123def456", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdatePlaylistRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "playlist": { "$ref": "#/components/schemas/PlaylistDetail" } }, "required": [ "playlist" ], "type": "object" } } }, "description": "OK", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "400": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "bad_request", "message": "The request was malformed or contained invalid parameters." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request was malformed or contained invalid parameters.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "401": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "unauthorized", "message": "Authentication is required. Provide a valid API key." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required. Provide a valid API key.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "403": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "forbidden", "message": "You don't have permission to access this resource." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "You don't have permission to access this resource.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "404": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "not_found", "message": "The requested resource was not found." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested resource was not found.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "429": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "rate_limited", "message": "You have exceeded the rate limit. Please slow down." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "You have exceeded the rate limit. Please slow down.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Retry-After": { "$ref": "#/components/headers/RetryAfter" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "500": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "server_error", "message": "An unexpected error occurred" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "501": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "not_implemented", "message": "The requested operation is not implemented." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested operation is not implemented.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } } }, "security": [ { "BearerAuth": [] } ], "summary": "Update a playlist", "tags": [ "Playlists" ] } }, "/v1/playlists/{id}/videos": { "post": { "description": "Adds an existing video to the specified playlist", "operationId": "addVideoToPlaylist", "parameters": [ { "description": "Unique playlist identifier", "in": "path", "name": "id", "required": true, "schema": { "description": "Unique playlist identifier", "example": "pl_abc123def456", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddVideoRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } }, "description": "Video successfully added to playlist", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "400": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "bad_request", "message": "The request was malformed or contained invalid parameters." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request was malformed or contained invalid parameters.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "401": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "unauthorized", "message": "Authentication is required. Provide a valid API key." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required. Provide a valid API key.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "403": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "forbidden", "message": "You don't have permission to access this resource." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "You don't have permission to access this resource.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "404": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "not_found", "message": "The requested resource was not found." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested resource was not found.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "429": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "rate_limited", "message": "You have exceeded the rate limit. Please slow down." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "You have exceeded the rate limit. Please slow down.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Retry-After": { "$ref": "#/components/headers/RetryAfter" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "500": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "server_error", "message": "An unexpected error occurred" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "501": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "not_implemented", "message": "The requested operation is not implemented." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested operation is not implemented.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } } }, "security": [ { "BearerAuth": [] } ], "summary": "Add a video to a playlist", "tags": [ "Playlists" ] } }, "/v1/playlists/{id}/videos/{videoId}": { "delete": { "description": "Removes a video from the specified playlist. The video itself is not deleted.", "operationId": "removeVideoFromPlaylist", "parameters": [ { "description": "Unique playlist identifier", "in": "path", "name": "id", "required": true, "schema": { "description": "Unique playlist identifier", "example": "pl_abc123def456", "type": "string" } }, { "description": "Unique video identifier", "in": "path", "name": "videoId", "required": true, "schema": { "description": "Unique video identifier", "example": "vid_xyz789ghi012", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } }, "description": "Video successfully removed from playlist", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "400": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "bad_request", "message": "The request was malformed or contained invalid parameters." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request was malformed or contained invalid parameters.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "401": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "unauthorized", "message": "Authentication is required. Provide a valid API key." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required. Provide a valid API key.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "403": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "forbidden", "message": "You don't have permission to access this resource." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "You don't have permission to access this resource.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "404": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "not_found", "message": "The requested resource was not found." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested resource was not found.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "429": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "rate_limited", "message": "You have exceeded the rate limit. Please slow down." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "You have exceeded the rate limit. Please slow down.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Retry-After": { "$ref": "#/components/headers/RetryAfter" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "500": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "server_error", "message": "An unexpected error occurred" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "501": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "not_implemented", "message": "The requested operation is not implemented." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested operation is not implemented.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } } }, "security": [ { "BearerAuth": [] } ], "summary": "Remove a video from a playlist", "tags": [ "Playlists" ] } }, "/v1/sources": { "post": { "description": "Returns a `sourceId` and a pre-signed S3 URL. PUT the file bytes to `uploadUrl`, then reference `sourceId` from clips, layouts (b-roll media), overlays, or backgrounds. Use `kind: \"image\"` for images (no `duration`); Tella hosts the bytes for rendering, so you never deal with raw image URLs.", "operationId": "createSource", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateSourceRequest" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateSourceResponse" } } }, "description": "OK", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "400": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "bad_request", "message": "The request was malformed or contained invalid parameters." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request was malformed or contained invalid parameters.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "401": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "unauthorized", "message": "Authentication is required. Provide a valid API key." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required. Provide a valid API key.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "403": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "forbidden", "message": "You don't have permission to access this resource." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "You don't have permission to access this resource.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "404": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "not_found", "message": "The requested resource was not found." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested resource was not found.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "429": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "rate_limited", "message": "You have exceeded the rate limit. Please slow down." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "You have exceeded the rate limit. Please slow down.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Retry-After": { "$ref": "#/components/headers/RetryAfter" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "500": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "server_error", "message": "An unexpected error occurred" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "501": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "not_implemented", "message": "The requested operation is not implemented." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested operation is not implemented.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } } }, "security": [ { "BearerAuth": [] } ], "summary": "Create a new source upload (video or image)", "tags": [ "Sources" ] } }, "/v1/sources/{sourceId}/storyboard": { "get": { "description": "Returns a signed 4x4 WebP storyboard whose 16 tiles are sampled evenly across the requested window (`durationMs`/16 apart; every 5 seconds for the default 80s window) from a streaming upload source owned by the caller or their workspace. `startTimeMs` is relative to the source. Only `startTimeMs` and `durationMs` control the storyboard; tile count, dimensions, and format are fixed. By default returns a 302 redirect — set `?response=json` to get `{url}` JSON instead.", "operationId": "getSourceStoryboard", "parameters": [ { "description": "Streaming upload source identifier", "in": "path", "name": "sourceId", "required": true, "schema": { "description": "Streaming upload source identifier", "example": "su_abc123def456", "type": "string" } }, { "description": "Start time in ms on the selected target's playback timeline. Defaults to 0.", "in": "query", "name": "startTimeMs", "schema": { "description": "Start time in ms on the selected target's playback timeline. Defaults to 0.", "example": 1000, "maximum": 2147483647, "minimum": 0, "type": "integer" } }, { "description": "Storyboard window duration in ms. Defaults to 80000; the selected target's remaining duration may shorten it. Pass the target's full duration to sample it end to end.", "in": "query", "name": "durationMs", "schema": { "description": "Storyboard window duration in ms. Defaults to 80000; the selected target's remaining duration may shorten it. Pass the target's full duration to sample it end to end.", "example": 30000, "maximum": 2147483647, "minimum": 1, "type": "integer" } }, { "description": "Set to 'json' to receive `{url}` instead of the default 302 redirect.", "in": "query", "name": "response", "schema": { "description": "Set to 'json' to receive `{url}` instead of the default 302 redirect.", "enum": [ "json" ], "example": "json", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StoryboardResponse" } } }, "description": "Returned when `?response=json` is set", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "302": { "description": "Redirect to the signed storyboard URL", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "400": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "bad_request", "message": "The request was malformed or contained invalid parameters." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request was malformed or contained invalid parameters.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "401": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "unauthorized", "message": "Authentication is required. Provide a valid API key." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required. Provide a valid API key.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "403": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "forbidden", "message": "You don't have permission to access this resource." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "You don't have permission to access this resource.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "404": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "not_found", "message": "The requested resource was not found." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested resource was not found.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "429": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "rate_limited", "message": "You have exceeded the rate limit. Please slow down." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "You have exceeded the rate limit. Please slow down.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Retry-After": { "$ref": "#/components/headers/RetryAfter" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "500": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "server_error", "message": "An unexpected error occurred" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "501": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "not_implemented", "message": "The requested operation is not implemented." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested operation is not implemented.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } } }, "security": [ { "BearerAuth": [] } ], "summary": "Get a streaming upload storyboard", "tags": [ "Sources" ] } }, "/v1/tags": { "get": { "description": "Returns all tags visible to the authenticated user: the workspace's shared tags plus the user's private tags", "operationId": "listTags", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListTagsResponse" } } }, "description": "OK", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "400": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "bad_request", "message": "The request was malformed or contained invalid parameters." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request was malformed or contained invalid parameters.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "401": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "unauthorized", "message": "Authentication is required. Provide a valid API key." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required. Provide a valid API key.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "403": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "forbidden", "message": "You don't have permission to access this resource." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "You don't have permission to access this resource.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "404": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "not_found", "message": "The requested resource was not found." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested resource was not found.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "429": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "rate_limited", "message": "You have exceeded the rate limit. Please slow down." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "You have exceeded the rate limit. Please slow down.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Retry-After": { "$ref": "#/components/headers/RetryAfter" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "500": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "server_error", "message": "An unexpected error occurred" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "501": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "not_implemented", "message": "The requested operation is not implemented." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested operation is not implemented.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } } }, "security": [ { "BearerAuth": [] } ], "summary": "List all tags", "tags": [ "Tags" ] }, "post": { "description": "Create a workspace or private tag. When no color is given, one is derived deterministically from the name.", "operationId": "createTag", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateTagRequest" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateTagResponse" } } }, "description": "Created", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "400": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "bad_request", "message": "The request was malformed or contained invalid parameters." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request was malformed or contained invalid parameters.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "401": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "unauthorized", "message": "Authentication is required. Provide a valid API key." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required. Provide a valid API key.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "403": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "forbidden", "message": "You don't have permission to access this resource." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "You don't have permission to access this resource.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "404": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "not_found", "message": "The requested resource was not found." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested resource was not found.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "429": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "rate_limited", "message": "You have exceeded the rate limit. Please slow down." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "You have exceeded the rate limit. Please slow down.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Retry-After": { "$ref": "#/components/headers/RetryAfter" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "500": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "server_error", "message": "An unexpected error occurred" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "501": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "not_implemented", "message": "The requested operation is not implemented." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested operation is not implemented.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } } }, "security": [ { "BearerAuth": [] } ], "summary": "Create a new tag", "tags": [ "Tags" ] } }, "/v1/tags/{id}": { "delete": { "description": "Permanently delete a tag and remove it from all videos. Private tags can only be deleted by their creator.", "operationId": "deleteTag", "parameters": [ { "description": "Tag ID", "in": "path", "name": "id", "required": true, "schema": { "description": "Tag ID", "example": "tag_abc123def456", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } }, "description": "Tag successfully deleted", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "400": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "bad_request", "message": "The request was malformed or contained invalid parameters." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request was malformed or contained invalid parameters.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "401": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "unauthorized", "message": "Authentication is required. Provide a valid API key." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required. Provide a valid API key.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "403": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "forbidden", "message": "You don't have permission to access this resource." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "You don't have permission to access this resource.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "404": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "not_found", "message": "The requested resource was not found." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested resource was not found.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "429": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "rate_limited", "message": "You have exceeded the rate limit. Please slow down." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "You have exceeded the rate limit. Please slow down.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Retry-After": { "$ref": "#/components/headers/RetryAfter" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "500": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "server_error", "message": "An unexpected error occurred" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "501": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "not_implemented", "message": "The requested operation is not implemented." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested operation is not implemented.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } } }, "security": [ { "BearerAuth": [] } ], "summary": "Delete a tag", "tags": [ "Tags" ] }, "patch": { "description": "Update a tag's name, color and/or description. Private tags can only be updated by their creator.", "operationId": "updateTag", "parameters": [ { "description": "Tag ID", "in": "path", "name": "id", "required": true, "schema": { "description": "Tag ID", "example": "tag_abc123def456", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateTagRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateTagResponse" } } }, "description": "OK", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "400": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "bad_request", "message": "The request was malformed or contained invalid parameters." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request was malformed or contained invalid parameters.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "401": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "unauthorized", "message": "Authentication is required. Provide a valid API key." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required. Provide a valid API key.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "403": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "forbidden", "message": "You don't have permission to access this resource." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "You don't have permission to access this resource.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "404": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "not_found", "message": "The requested resource was not found." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested resource was not found.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "429": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "rate_limited", "message": "You have exceeded the rate limit. Please slow down." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "You have exceeded the rate limit. Please slow down.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Retry-After": { "$ref": "#/components/headers/RetryAfter" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "500": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "server_error", "message": "An unexpected error occurred" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "501": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "not_implemented", "message": "The requested operation is not implemented." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested operation is not implemented.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } } }, "security": [ { "BearerAuth": [] } ], "summary": "Update a tag", "tags": [ "Tags" ] } }, "/v1/videos": { "get": { "description": "Returns a paginated list of all videos for the authenticated user. Use playlistId query parameter to filter videos by playlist.", "operationId": "listVideos", "parameters": [ { "description": "Pagination cursor from previous response", "in": "query", "name": "cursor", "schema": { "description": "Pagination cursor from previous response", "example": "eyJpZCI6InZpZF94eXoifQ", "type": "string" } }, { "description": "Items per page (default: 20, max: 100)", "in": "query", "name": "limit", "schema": { "description": "Items per page (default: 20, max: 100)", "example": 20, "maximum": 100, "minimum": 1, "type": "integer" } }, { "description": "Filter videos by playlist ID", "in": "query", "name": "playlistId", "schema": { "description": "Filter videos by playlist ID", "example": "pl_xyz789ghi012", "type": "string" } }, { "description": "Filter videos by tag IDs, comma-separated. Multiple tags are combined with AND. Ignored when playlistId is set.", "in": "query", "name": "tagIds", "schema": { "description": "Filter videos by tag IDs, comma-separated. Multiple tags are combined with AND. Ignored when playlistId is set.", "example": "tag_abc123def456,tag_ghi789jkl012", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "pagination": { "$ref": "#/components/schemas/Pagination" }, "videos": { "description": "List of videos", "items": { "$ref": "#/components/schemas/VideoListItem" }, "type": "array" } }, "required": [ "videos", "pagination" ], "type": "object" } } }, "description": "OK", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "400": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "bad_request", "message": "The request was malformed or contained invalid parameters." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request was malformed or contained invalid parameters.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "401": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "unauthorized", "message": "Authentication is required. Provide a valid API key." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required. Provide a valid API key.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "403": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "forbidden", "message": "You don't have permission to access this resource." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "You don't have permission to access this resource.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "404": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "not_found", "message": "The requested resource was not found." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested resource was not found.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "429": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "rate_limited", "message": "You have exceeded the rate limit. Please slow down." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "You have exceeded the rate limit. Please slow down.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Retry-After": { "$ref": "#/components/headers/RetryAfter" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "500": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "server_error", "message": "An unexpected error occurred" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "501": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "not_implemented", "message": "The requested operation is not implemented." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested operation is not implemented.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } } }, "security": [ { "BearerAuth": [] } ], "summary": "List all videos", "tags": [ "Videos" ] }, "post": { "description": "Create a new video from an uploaded source. First create a source (POST /v1/sources), PUT the video bytes to its uploadUrl, then call this endpoint with the sourceId — it becomes the new video's first clip.", "operationId": "createVideo", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateVideoRequest" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "video": { "$ref": "#/components/schemas/VideoDetail" } }, "required": [ "video" ], "type": "object" } } }, "description": "Video created", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "400": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "bad_request", "message": "The request was malformed or contained invalid parameters." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request was malformed or contained invalid parameters.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "401": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "unauthorized", "message": "Authentication is required. Provide a valid API key." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required. Provide a valid API key.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "403": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "forbidden", "message": "You don't have permission to access this resource." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "You don't have permission to access this resource.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "404": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "not_found", "message": "The requested resource was not found." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested resource was not found.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "429": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "rate_limited", "message": "You have exceeded the rate limit. Please slow down." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "You have exceeded the rate limit. Please slow down.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Retry-After": { "$ref": "#/components/headers/RetryAfter" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "500": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "server_error", "message": "An unexpected error occurred" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "501": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "not_implemented", "message": "The requested operation is not implemented." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested operation is not implemented.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } } }, "security": [ { "BearerAuth": [] } ], "summary": "Create a video", "tags": [ "Videos" ] } }, "/v1/videos/search": { "get": { "description": "Search the authenticated user's direct video library by title or indexed transcript sentences.", "operationId": "searchVideos", "parameters": [ { "description": "Words to find in video titles or indexed transcript sentences", "in": "query", "name": "query", "required": true, "schema": { "description": "Words to find in video titles or indexed transcript sentences", "maxLength": 200, "minLength": 1, "type": "string" } }, { "description": "Fields to search (default: all)", "in": "query", "name": "searchIn", "schema": { "description": "Fields to search (default: all)", "enum": [ "all", "title", "transcript" ], "type": "string" } }, { "description": "Upper bound on results per page (default: 20, max: 100). A page can be shorter once results the caller cannot see are removed, so keep paging while hasMore is true.", "in": "query", "name": "limit", "schema": { "description": "Upper bound on results per page (default: 20, max: 100). A page can be shorter once results the caller cannot see are removed, so keep paging while hasMore is true.", "maximum": 100, "minimum": 1, "type": "integer" } }, { "description": "Opaque pagination cursor from the previous response", "in": "query", "name": "cursor", "schema": { "description": "Opaque pagination cursor from the previous response", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchVideosResponse" } } }, "description": "Matching videos", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "400": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "bad_request", "message": "The request was malformed or contained invalid parameters." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request was malformed or contained invalid parameters.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "401": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "unauthorized", "message": "Authentication is required. Provide a valid API key." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required. Provide a valid API key.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "403": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "forbidden", "message": "You don't have permission to access this resource." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "You don't have permission to access this resource.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "404": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "not_found", "message": "The requested resource was not found." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested resource was not found.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "429": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "rate_limited", "message": "You have exceeded the rate limit. Please slow down." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "You have exceeded the rate limit. Please slow down.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Retry-After": { "$ref": "#/components/headers/RetryAfter" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "500": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "server_error", "message": "An unexpected error occurred" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "501": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "not_implemented", "message": "The requested operation is not implemented." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested operation is not implemented.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } } }, "security": [ { "BearerAuth": [] } ], "summary": "Search videos", "tags": [ "Videos" ] } }, "/v1/videos/{id}": { "delete": { "description": "Permanently delete a video", "operationId": "deleteVideo", "parameters": [ { "description": "Unique video identifier", "in": "path", "name": "id", "required": true, "schema": { "description": "Unique video identifier", "example": "vid_abc123def456", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } }, "description": "Video successfully deleted", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "400": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "bad_request", "message": "The request was malformed or contained invalid parameters." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request was malformed or contained invalid parameters.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "401": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "unauthorized", "message": "Authentication is required. Provide a valid API key." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required. Provide a valid API key.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "403": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "forbidden", "message": "You don't have permission to access this resource." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "You don't have permission to access this resource.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "404": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "not_found", "message": "The requested resource was not found." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested resource was not found.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "429": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "rate_limited", "message": "You have exceeded the rate limit. Please slow down." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "You have exceeded the rate limit. Please slow down.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Retry-After": { "$ref": "#/components/headers/RetryAfter" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "500": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "server_error", "message": "An unexpected error occurred" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "501": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "not_implemented", "message": "The requested operation is not implemented." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested operation is not implemented.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } } }, "security": [ { "BearerAuth": [] } ], "summary": "Delete a video", "tags": [ "Videos" ] }, "get": { "description": "Returns detailed information about a video including chapters, transcript, and thumbnails", "operationId": "getVideo", "parameters": [ { "description": "Unique video identifier", "in": "path", "name": "id", "required": true, "schema": { "description": "Unique video identifier", "example": "vid_abc123def456", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "video": { "$ref": "#/components/schemas/VideoDetail" } }, "required": [ "video" ], "type": "object" } } }, "description": "OK", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "400": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "bad_request", "message": "The request was malformed or contained invalid parameters." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request was malformed or contained invalid parameters.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "401": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "unauthorized", "message": "Authentication is required. Provide a valid API key." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required. Provide a valid API key.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "403": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "forbidden", "message": "You don't have permission to access this resource." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "You don't have permission to access this resource.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "404": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "not_found", "message": "The requested resource was not found." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested resource was not found.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "429": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "rate_limited", "message": "You have exceeded the rate limit. Please slow down." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "You have exceeded the rate limit. Please slow down.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Retry-After": { "$ref": "#/components/headers/RetryAfter" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "500": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "server_error", "message": "An unexpected error occurred" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "501": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "not_implemented", "message": "The requested operation is not implemented." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested operation is not implemented.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } } }, "security": [ { "BearerAuth": [] } ], "summary": "Get video information", "tags": [ "Videos" ] }, "patch": { "description": "Update a video's settings including viewer options, download permissions, access controls, and metadata. Some features require Premium plan.", "operationId": "updateVideo", "parameters": [ { "description": "Unique video identifier", "in": "path", "name": "id", "required": true, "schema": { "description": "Unique video identifier", "example": "vid_abc123def456", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateVideoRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "video": { "$ref": "#/components/schemas/VideoDetail" } }, "required": [ "video" ], "type": "object" } } }, "description": "OK", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "400": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "bad_request", "message": "The request was malformed or contained invalid parameters." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request was malformed or contained invalid parameters.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "401": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "unauthorized", "message": "Authentication is required. Provide a valid API key." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required. Provide a valid API key.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "403": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "forbidden", "message": "You don't have permission to access this resource." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "You don't have permission to access this resource.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "404": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "not_found", "message": "The requested resource was not found." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested resource was not found.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "429": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "rate_limited", "message": "You have exceeded the rate limit. Please slow down." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "You have exceeded the rate limit. Please slow down.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Retry-After": { "$ref": "#/components/headers/RetryAfter" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "500": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "server_error", "message": "An unexpected error occurred" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "501": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "not_implemented", "message": "The requested operation is not implemented." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested operation is not implemented.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } } }, "security": [ { "BearerAuth": [] } ], "summary": "Update a video", "tags": [ "Videos" ] } }, "/v1/videos/{id}/background-music": { "delete": { "description": "Removes the video's background music track.", "operationId": "removeBackgroundMusic", "parameters": [ { "description": "Unique video identifier", "in": "path", "name": "id", "required": true, "schema": { "description": "Unique video identifier", "example": "vid_abc123def456", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } }, "description": "Background music removed", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "400": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "bad_request", "message": "The request was malformed or contained invalid parameters." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request was malformed or contained invalid parameters.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "401": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "unauthorized", "message": "Authentication is required. Provide a valid API key." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required. Provide a valid API key.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "403": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "forbidden", "message": "You don't have permission to access this resource." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "You don't have permission to access this resource.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "404": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "not_found", "message": "The requested resource was not found." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested resource was not found.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "429": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "rate_limited", "message": "You have exceeded the rate limit. Please slow down." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "You have exceeded the rate limit. Please slow down.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Retry-After": { "$ref": "#/components/headers/RetryAfter" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "500": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "server_error", "message": "An unexpected error occurred" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "501": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "not_implemented", "message": "The requested operation is not implemented." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested operation is not implemented.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } } }, "security": [ { "BearerAuth": [] } ], "summary": "Remove background music", "tags": [ "Videos" ] }, "put": { "description": "Sets the video's background music track. It loops over the whole video and is included in exports. Volume is 0-1 and defaults to 0.2.", "operationId": "setBackgroundMusic", "parameters": [ { "description": "Unique video identifier", "in": "path", "name": "id", "required": true, "schema": { "description": "Unique video identifier", "example": "vid_abc123def456", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "name": { "description": "Optional display name for the track", "example": "Calm Product Tour", "type": "string" }, "sourceId": { "description": "Audio source ID from `POST /v1/sources` (`kind: \"audio\"`)", "example": "su_abc123def456", "type": "string" }, "volume": { "default": 0.2, "description": "Track volume from 0 (silent) to 1 (full volume)", "example": 0.2, "maximum": 1, "minimum": 0, "type": "number" } }, "required": [ "sourceId" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "backgroundMusic": { "$ref": "#/components/schemas/BackgroundMusic" } }, "required": [ "backgroundMusic" ], "type": "object" } } }, "description": "Background music set", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "400": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "bad_request", "message": "The request was malformed or contained invalid parameters." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request was malformed or contained invalid parameters.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "401": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "unauthorized", "message": "Authentication is required. Provide a valid API key." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required. Provide a valid API key.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "403": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "forbidden", "message": "You don't have permission to access this resource." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "You don't have permission to access this resource.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "404": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "not_found", "message": "The requested resource was not found." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested resource was not found.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "429": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "rate_limited", "message": "You have exceeded the rate limit. Please slow down." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "You have exceeded the rate limit. Please slow down.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Retry-After": { "$ref": "#/components/headers/RetryAfter" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "500": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "server_error", "message": "An unexpected error occurred" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "501": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "not_implemented", "message": "The requested operation is not implemented." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested operation is not implemented.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } } }, "security": [ { "BearerAuth": [] } ], "summary": "Set background music", "tags": [ "Videos" ] } }, "/v1/videos/{id}/captions": { "get": { "description": "Returns ready, non-empty captions as a SubRip or WebVTT attachment.", "operationId": "getVideoCaptions", "parameters": [ { "description": "Unique video identifier", "in": "path", "name": "id", "required": true, "schema": { "description": "Unique video identifier", "example": "vid_abc123def456", "type": "string" } }, { "description": "Caption file format. Defaults to srt.", "in": "query", "name": "format", "schema": { "default": "srt", "description": "Caption file format. Defaults to srt.", "enum": [ "srt", "vtt" ], "example": "vtt", "type": "string" } } ], "responses": { "200": { "content": { "application/x-subrip": { "schema": { "type": "string" } }, "text/vtt": { "schema": { "type": "string" } } }, "description": "Caption file", "headers": { "Content-Disposition": { "description": "Quoted, sanitized attachment filename", "schema": { "type": "string" } }, "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "400": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "bad_request", "message": "The request was malformed or contained invalid parameters." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request was malformed or contained invalid parameters.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "401": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "unauthorized", "message": "Authentication is required. Provide a valid API key." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required. Provide a valid API key.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "403": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "forbidden", "message": "You don't have permission to access this resource." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "You don't have permission to access this resource.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "404": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "not_found", "message": "The requested resource was not found." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested resource was not found.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "429": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "rate_limited", "message": "You have exceeded the rate limit. Please slow down." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "You have exceeded the rate limit. Please slow down.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Retry-After": { "$ref": "#/components/headers/RetryAfter" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "500": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "server_error", "message": "An unexpected error occurred" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "501": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "not_implemented", "message": "The requested operation is not implemented." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested operation is not implemented.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } } }, "security": [ { "BearerAuth": [] } ], "summary": "Download video captions", "tags": [ "Videos" ] } }, "/v1/videos/{id}/chapters": { "get": { "description": "Returns chapters ordered by timestamp in seconds on the final video timeline. Chapter IDs are intentionally omitted because they are not stable across reads.", "operationId": "getVideoChapters", "parameters": [ { "description": "Unique video identifier", "in": "path", "name": "id", "required": true, "schema": { "description": "Unique video identifier", "example": "vid_abc123def456", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "description": "Video chapters", "properties": { "chapters": { "description": "Chapters on the final video timeline, ordered by timestamp", "items": { "$ref": "#/components/schemas/Chapter" }, "type": "array" } }, "required": [ "chapters" ], "type": "object" } } }, "description": "Video chapters", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "400": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "bad_request", "message": "The request was malformed or contained invalid parameters." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request was malformed or contained invalid parameters.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "401": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "unauthorized", "message": "Authentication is required. Provide a valid API key." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required. Provide a valid API key.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "403": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "forbidden", "message": "You don't have permission to access this resource." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "You don't have permission to access this resource.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "404": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "not_found", "message": "The requested resource was not found." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested resource was not found.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "429": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "rate_limited", "message": "You have exceeded the rate limit. Please slow down." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "You have exceeded the rate limit. Please slow down.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Retry-After": { "$ref": "#/components/headers/RetryAfter" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "500": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "server_error", "message": "An unexpected error occurred" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "501": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "not_implemented", "message": "The requested operation is not implemented." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested operation is not implemented.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } } }, "security": [ { "BearerAuth": [] } ], "summary": "Get video chapters", "tags": [ "Videos" ] }, "put": { "description": "Replaces the complete chapter list. Timestamps are seconds on the final video timeline and must be non-negative, ascending, and within the video duration. Pass an empty array to clear all chapters.", "operationId": "setVideoChapters", "parameters": [ { "description": "Unique video identifier", "in": "path", "name": "id", "required": true, "schema": { "description": "Unique video identifier", "example": "vid_abc123def456", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "description": "Replace all chapters on a video", "properties": { "chapters": { "description": "Complete replacement chapter list in ascending timestamp order (maximum 100). Pass an empty array to clear all chapters.", "items": { "$ref": "#/components/schemas/ChapterInput" }, "maxItems": 100, "type": "array" } }, "required": [ "chapters" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "description": "Video chapters", "properties": { "chapters": { "description": "Chapters on the final video timeline, ordered by timestamp", "items": { "$ref": "#/components/schemas/Chapter" }, "type": "array" } }, "required": [ "chapters" ], "type": "object" } } }, "description": "Chapters replaced", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "400": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "bad_request", "message": "The request was malformed or contained invalid parameters." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request was malformed or contained invalid parameters.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "401": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "unauthorized", "message": "Authentication is required. Provide a valid API key." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required. Provide a valid API key.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "403": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "forbidden", "message": "You don't have permission to access this resource." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "You don't have permission to access this resource.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "404": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "not_found", "message": "The requested resource was not found." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested resource was not found.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "429": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "rate_limited", "message": "You have exceeded the rate limit. Please slow down." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "You have exceeded the rate limit. Please slow down.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Retry-After": { "$ref": "#/components/headers/RetryAfter" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "500": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "server_error", "message": "An unexpected error occurred" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "501": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "not_implemented", "message": "The requested operation is not implemented." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested operation is not implemented.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } } }, "security": [ { "BearerAuth": [] } ], "summary": "Replace video chapters", "tags": [ "Videos" ] } }, "/v1/videos/{id}/clips": { "get": { "description": "Returns the clips of a video in playback order.", "operationId": "listClips", "parameters": [ { "description": "Video identifier", "in": "path", "name": "id", "required": true, "schema": { "description": "Video identifier", "example": "vid_abc123def456", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListClipsResponse" } } }, "description": "OK", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "400": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "bad_request", "message": "The request was malformed or contained invalid parameters." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request was malformed or contained invalid parameters.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "401": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "unauthorized", "message": "Authentication is required. Provide a valid API key." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required. Provide a valid API key.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "403": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "forbidden", "message": "You don't have permission to access this resource." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "You don't have permission to access this resource.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "404": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "not_found", "message": "The requested resource was not found." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested resource was not found.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "429": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "rate_limited", "message": "You have exceeded the rate limit. Please slow down." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "You have exceeded the rate limit. Please slow down.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Retry-After": { "$ref": "#/components/headers/RetryAfter" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "500": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "server_error", "message": "An unexpected error occurred" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "501": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "not_implemented", "message": "The requested operation is not implemented." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested operation is not implemented.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } } }, "security": [ { "BearerAuth": [] } ], "summary": "List clips for a video", "tags": [ "Clips" ] }, "post": { "description": "Add a new clip to a video. Create a source via `POST /v1/sources`, PUT the bytes, then pass the returned `sourceId` here.", "operationId": "addClip", "parameters": [ { "description": "Video identifier", "in": "path", "name": "id", "required": true, "schema": { "description": "Video identifier", "example": "vid_abc123def456", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddClipRequest" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetClipResponse" } } }, "description": "OK", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "400": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "bad_request", "message": "The request was malformed or contained invalid parameters." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request was malformed or contained invalid parameters.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "401": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "unauthorized", "message": "Authentication is required. Provide a valid API key." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required. Provide a valid API key.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "403": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "forbidden", "message": "You don't have permission to access this resource." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "You don't have permission to access this resource.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "404": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "not_found", "message": "The requested resource was not found." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested resource was not found.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "429": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "rate_limited", "message": "You have exceeded the rate limit. Please slow down." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "You have exceeded the rate limit. Please slow down.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Retry-After": { "$ref": "#/components/headers/RetryAfter" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "500": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "server_error", "message": "An unexpected error occurred" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "501": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "not_implemented", "message": "The requested operation is not implemented." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested operation is not implemented.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } } }, "security": [ { "BearerAuth": [] } ], "summary": "Add a clip from an uploaded source", "tags": [ "Clips" ] } }, "/v1/videos/{id}/clips/{clipId}": { "delete": { "description": "Removes a clip from its video. The underlying recording is preserved.", "operationId": "deleteClip", "parameters": [ { "description": "Video identifier", "in": "path", "name": "id", "required": true, "schema": { "description": "Video identifier", "example": "vid_abc123def456", "type": "string" } }, { "description": "Clip identifier", "in": "path", "name": "clipId", "required": true, "schema": { "description": "Clip identifier", "example": "cl_xyz789ghi012", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } }, "description": "Clip removed from video", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "400": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "bad_request", "message": "The request was malformed or contained invalid parameters." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request was malformed or contained invalid parameters.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "401": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "unauthorized", "message": "Authentication is required. Provide a valid API key." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required. Provide a valid API key.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "403": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "forbidden", "message": "You don't have permission to access this resource." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "You don't have permission to access this resource.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "404": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "not_found", "message": "The requested resource was not found." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested resource was not found.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "429": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "rate_limited", "message": "You have exceeded the rate limit. Please slow down." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "You have exceeded the rate limit. Please slow down.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Retry-After": { "$ref": "#/components/headers/RetryAfter" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "500": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "server_error", "message": "An unexpected error occurred" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "501": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "not_implemented", "message": "The requested operation is not implemented." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested operation is not implemented.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } } }, "security": [ { "BearerAuth": [] } ], "summary": "Delete a clip", "tags": [ "Clips" ] }, "get": { "description": "Returns a single clip in a video.", "operationId": "getClip", "parameters": [ { "description": "Video identifier", "in": "path", "name": "id", "required": true, "schema": { "description": "Video identifier", "example": "vid_abc123def456", "type": "string" } }, { "description": "Clip identifier", "in": "path", "name": "clipId", "required": true, "schema": { "description": "Clip identifier", "example": "cl_xyz789ghi012", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetClipResponse" } } }, "description": "OK", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "400": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "bad_request", "message": "The request was malformed or contained invalid parameters." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request was malformed or contained invalid parameters.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "401": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "unauthorized", "message": "Authentication is required. Provide a valid API key." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required. Provide a valid API key.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "403": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "forbidden", "message": "You don't have permission to access this resource." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "You don't have permission to access this resource.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "404": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "not_found", "message": "The requested resource was not found." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested resource was not found.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "429": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "rate_limited", "message": "You have exceeded the rate limit. Please slow down." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "You have exceeded the rate limit. Please slow down.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Retry-After": { "$ref": "#/components/headers/RetryAfter" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "500": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "server_error", "message": "An unexpected error occurred" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "501": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "not_implemented", "message": "The requested operation is not implemented." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested operation is not implemented.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } } }, "security": [ { "BearerAuth": [] } ], "summary": "Get a clip", "tags": [ "Clips" ] }, "patch": { "description": "Update a clip's name, ordering, cuts, background, or transition. At least one field must be provided.", "operationId": "updateClip", "parameters": [ { "description": "Video identifier", "in": "path", "name": "id", "required": true, "schema": { "description": "Video identifier", "example": "vid_abc123def456", "type": "string" } }, { "description": "Clip identifier", "in": "path", "name": "clipId", "required": true, "schema": { "description": "Clip identifier", "example": "cl_xyz789ghi012", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateClipRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetClipResponse" } } }, "description": "OK", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "400": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "bad_request", "message": "The request was malformed or contained invalid parameters." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request was malformed or contained invalid parameters.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "401": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "unauthorized", "message": "Authentication is required. Provide a valid API key." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required. Provide a valid API key.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "403": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "forbidden", "message": "You don't have permission to access this resource." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "You don't have permission to access this resource.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "404": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "not_found", "message": "The requested resource was not found." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested resource was not found.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "429": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "rate_limited", "message": "You have exceeded the rate limit. Please slow down." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "You have exceeded the rate limit. Please slow down.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Retry-After": { "$ref": "#/components/headers/RetryAfter" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "500": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "server_error", "message": "An unexpected error occurred" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "501": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "not_implemented", "message": "The requested operation is not implemented." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested operation is not implemented.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } } }, "security": [ { "BearerAuth": [] } ], "summary": "Update a clip", "tags": [ "Clips" ] } }, "/v1/videos/{id}/clips/{clipId}/auto-crop": { "post": { "description": "Detects the visible content at a frame and applies the recommended crop to the clip's screen recording. The frame time uses the clip playback timeline, with cuts already removed. Existing masks and custom-layout geometry are adjusted with the crop.", "operationId": "autoCropClip", "parameters": [ { "description": "Video identifier", "in": "path", "name": "id", "required": true, "schema": { "description": "Video identifier", "example": "vid_abc123def456", "type": "string" } }, { "description": "Clip identifier", "in": "path", "name": "clipId", "required": true, "schema": { "description": "Clip identifier", "example": "cl_xyz789ghi012", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AutoCropRequest" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AutoCropResponse" } } }, "description": "Crop applied", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "400": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "bad_request", "message": "The request was malformed or contained invalid parameters." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request was malformed or contained invalid parameters.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "401": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "unauthorized", "message": "Authentication is required. Provide a valid API key." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required. Provide a valid API key.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "403": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "forbidden", "message": "You don't have permission to access this resource." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "You don't have permission to access this resource.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "404": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "not_found", "message": "The requested resource was not found." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested resource was not found.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "429": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "rate_limited", "message": "You have exceeded the rate limit. Please slow down." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "You have exceeded the rate limit. Please slow down.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Retry-After": { "$ref": "#/components/headers/RetryAfter" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "500": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "server_error", "message": "An unexpected error occurred" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "501": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "not_implemented", "message": "The requested operation is not implemented." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested operation is not implemented.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } } }, "security": [ { "BearerAuth": [] } ], "summary": "Auto-crop a clip's screen recording", "tags": [ "Clips" ] } }, "/v1/videos/{id}/clips/{clipId}/blurs": { "get": { "description": "Returns the blur masks on a clip.", "operationId": "listClipBlurs", "parameters": [ { "description": "Video identifier", "in": "path", "name": "id", "required": true, "schema": { "description": "Video identifier", "example": "vid_abc123def456", "type": "string" } }, { "description": "Clip identifier", "in": "path", "name": "clipId", "required": true, "schema": { "description": "Clip identifier", "example": "cl_xyz789ghi012", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListClipMasksResponse" } } }, "description": "OK", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "400": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "bad_request", "message": "The request was malformed or contained invalid parameters." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request was malformed or contained invalid parameters.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "401": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "unauthorized", "message": "Authentication is required. Provide a valid API key." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required. Provide a valid API key.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "403": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "forbidden", "message": "You don't have permission to access this resource." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "You don't have permission to access this resource.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "404": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "not_found", "message": "The requested resource was not found." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested resource was not found.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "429": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "rate_limited", "message": "You have exceeded the rate limit. Please slow down." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "You have exceeded the rate limit. Please slow down.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Retry-After": { "$ref": "#/components/headers/RetryAfter" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "500": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "server_error", "message": "An unexpected error occurred" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "501": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "not_implemented", "message": "The requested operation is not implemented." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested operation is not implemented.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } } }, "security": [ { "BearerAuth": [] } ], "summary": "List blurs on a clip", "tags": [ "Clips" ] }, "post": { "description": "Adds a blur mask to a clip. Always targets the subject screen layer (the only supported target).", "operationId": "addClipBlur", "parameters": [ { "description": "Video identifier", "in": "path", "name": "id", "required": true, "schema": { "description": "Video identifier", "example": "vid_abc123def456", "type": "string" } }, { "description": "Clip identifier", "in": "path", "name": "clipId", "required": true, "schema": { "description": "Clip identifier", "example": "cl_xyz789ghi012", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddClipMaskRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClipMaskResponse" } } }, "description": "OK", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "400": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "bad_request", "message": "The request was malformed or contained invalid parameters." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request was malformed or contained invalid parameters.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "401": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "unauthorized", "message": "Authentication is required. Provide a valid API key." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required. Provide a valid API key.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "403": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "forbidden", "message": "You don't have permission to access this resource." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "You don't have permission to access this resource.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "404": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "not_found", "message": "The requested resource was not found." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested resource was not found.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "429": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "rate_limited", "message": "You have exceeded the rate limit. Please slow down." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "You have exceeded the rate limit. Please slow down.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Retry-After": { "$ref": "#/components/headers/RetryAfter" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "500": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "server_error", "message": "An unexpected error occurred" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "501": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "not_implemented", "message": "The requested operation is not implemented." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested operation is not implemented.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } } }, "security": [ { "BearerAuth": [] } ], "summary": "Add a blur to a clip", "tags": [ "Clips" ] } }, "/v1/videos/{id}/clips/{clipId}/blurs/{maskId}": { "delete": { "description": "Removes a blur mask from a clip.", "operationId": "removeClipBlur", "parameters": [ { "description": "Video ID", "in": "path", "name": "id", "required": true, "schema": { "description": "Video ID", "type": "string" } }, { "description": "Clip ID", "in": "path", "name": "clipId", "required": true, "schema": { "description": "Clip ID", "type": "string" } }, { "description": "Mask ID", "in": "path", "name": "maskId", "required": true, "schema": { "description": "Mask ID", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } }, "description": "Blur removed", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "400": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "bad_request", "message": "The request was malformed or contained invalid parameters." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request was malformed or contained invalid parameters.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "401": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "unauthorized", "message": "Authentication is required. Provide a valid API key." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required. Provide a valid API key.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "403": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "forbidden", "message": "You don't have permission to access this resource." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "You don't have permission to access this resource.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "404": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "not_found", "message": "The requested resource was not found." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested resource was not found.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "429": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "rate_limited", "message": "You have exceeded the rate limit. Please slow down." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "You have exceeded the rate limit. Please slow down.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Retry-After": { "$ref": "#/components/headers/RetryAfter" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "500": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "server_error", "message": "An unexpected error occurred" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "501": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "not_implemented", "message": "The requested operation is not implemented." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested operation is not implemented.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } } }, "security": [ { "BearerAuth": [] } ], "summary": "Remove a blur", "tags": [ "Clips" ] }, "patch": { "description": "Update a blur mask's timing, position, or size. Only the fields you send are changed.", "operationId": "updateClipBlur", "parameters": [ { "description": "Video ID", "in": "path", "name": "id", "required": true, "schema": { "description": "Video ID", "type": "string" } }, { "description": "Clip ID", "in": "path", "name": "clipId", "required": true, "schema": { "description": "Clip ID", "type": "string" } }, { "description": "Mask ID", "in": "path", "name": "maskId", "required": true, "schema": { "description": "Mask ID", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateClipMaskRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClipMaskResponse" } } }, "description": "OK", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "400": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "bad_request", "message": "The request was malformed or contained invalid parameters." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request was malformed or contained invalid parameters.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "401": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "unauthorized", "message": "Authentication is required. Provide a valid API key." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required. Provide a valid API key.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "403": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "forbidden", "message": "You don't have permission to access this resource." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "You don't have permission to access this resource.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "404": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "not_found", "message": "The requested resource was not found." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested resource was not found.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "429": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "rate_limited", "message": "You have exceeded the rate limit. Please slow down." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "You have exceeded the rate limit. Please slow down.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Retry-After": { "$ref": "#/components/headers/RetryAfter" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "500": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "server_error", "message": "An unexpected error occurred" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "501": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "not_implemented", "message": "The requested operation is not implemented." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested operation is not implemented.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } } }, "security": [ { "BearerAuth": [] } ], "summary": "Update a blur", "tags": [ "Clips" ] } }, "/v1/videos/{id}/clips/{clipId}/cut": { "post": { "description": "Cut one or more time ranges from a clip in a single request. Pass `cuts: [{fromMs, toMs}, ...]` for multiple ranges or the legacy `fromMs`/`toMs` pair for a single range. Overlapping or adjacent ranges are merged into the clip's existing cuts. To clear all cuts, call updateClip with cuts: [].", "operationId": "cutClip", "parameters": [ { "description": "Video identifier", "in": "path", "name": "id", "required": true, "schema": { "description": "Video identifier", "example": "vid_abc123def456", "type": "string" } }, { "description": "Clip identifier", "in": "path", "name": "clipId", "required": true, "schema": { "description": "Clip identifier", "example": "cl_xyz789ghi012", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CutClipRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetClipResponse" } } }, "description": "OK", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "400": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "bad_request", "message": "The request was malformed or contained invalid parameters." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request was malformed or contained invalid parameters.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "401": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "unauthorized", "message": "Authentication is required. Provide a valid API key." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required. Provide a valid API key.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "403": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "forbidden", "message": "You don't have permission to access this resource." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "You don't have permission to access this resource.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "404": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "not_found", "message": "The requested resource was not found." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested resource was not found.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "429": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "rate_limited", "message": "You have exceeded the rate limit. Please slow down." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "You have exceeded the rate limit. Please slow down.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Retry-After": { "$ref": "#/components/headers/RetryAfter" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "500": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "server_error", "message": "An unexpected error occurred" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "501": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "not_implemented", "message": "The requested operation is not implemented." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested operation is not implemented.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } } }, "security": [ { "BearerAuth": [] } ], "summary": "Cut one or more time ranges from a clip", "tags": [ "Clips" ] } }, "/v1/videos/{id}/clips/{clipId}/cut-by-transcript": { "post": { "description": "Cut one or more ranges from a clip by referencing word indices in the transcript. The server reads each word's exact `startTimeMs` / `endTimeMs` and merges the resulting cuts — no padding is applied to word boundaries.", "operationId": "cutClipByTranscript", "parameters": [ { "description": "Video identifier", "in": "path", "name": "id", "required": true, "schema": { "description": "Video identifier", "example": "vid_abc123def456", "type": "string" } }, { "description": "Clip identifier", "in": "path", "name": "clipId", "required": true, "schema": { "description": "Clip identifier", "example": "cl_xyz789ghi012", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CutClipByTranscriptRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetClipResponse" } } }, "description": "OK", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "400": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "bad_request", "message": "The request was malformed or contained invalid parameters." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request was malformed or contained invalid parameters.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "401": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "unauthorized", "message": "Authentication is required. Provide a valid API key." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required. Provide a valid API key.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "403": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "forbidden", "message": "You don't have permission to access this resource." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "You don't have permission to access this resource.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "404": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "not_found", "message": "The requested resource was not found." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested resource was not found.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "429": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "rate_limited", "message": "You have exceeded the rate limit. Please slow down." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "You have exceeded the rate limit. Please slow down.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Retry-After": { "$ref": "#/components/headers/RetryAfter" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "500": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "server_error", "message": "An unexpected error occurred" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "501": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "not_implemented", "message": "The requested operation is not implemented." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested operation is not implemented.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } } }, "security": [ { "BearerAuth": [] } ], "summary": "Cut clip ranges by transcript word indices", "tags": [ "Clips" ] } }, "/v1/videos/{id}/clips/{clipId}/duplicate": { "post": { "description": "Duplicates an existing clip in its video. By default the new clip is inserted right after the source.", "operationId": "duplicateClip", "parameters": [ { "description": "Video identifier", "in": "path", "name": "id", "required": true, "schema": { "description": "Video identifier", "example": "vid_abc123def456", "type": "string" } }, { "description": "Clip identifier", "in": "path", "name": "clipId", "required": true, "schema": { "description": "Clip identifier", "example": "cl_xyz789ghi012", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DuplicateClipRequest" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetClipResponse" } } }, "description": "OK", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "400": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "bad_request", "message": "The request was malformed or contained invalid parameters." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request was malformed or contained invalid parameters.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "401": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "unauthorized", "message": "Authentication is required. Provide a valid API key." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required. Provide a valid API key.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "403": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "forbidden", "message": "You don't have permission to access this resource." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "You don't have permission to access this resource.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "404": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "not_found", "message": "The requested resource was not found." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested resource was not found.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "429": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "rate_limited", "message": "You have exceeded the rate limit. Please slow down." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "You have exceeded the rate limit. Please slow down.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Retry-After": { "$ref": "#/components/headers/RetryAfter" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "500": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "server_error", "message": "An unexpected error occurred" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "501": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "not_implemented", "message": "The requested operation is not implemented." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested operation is not implemented.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } } }, "security": [ { "BearerAuth": [] } ], "summary": "Duplicate a clip", "tags": [ "Clips" ] } }, "/v1/videos/{id}/clips/{clipId}/highlights": { "get": { "description": "Returns the highlight masks on a clip.", "operationId": "listClipHighlights", "parameters": [ { "description": "Video identifier", "in": "path", "name": "id", "required": true, "schema": { "description": "Video identifier", "example": "vid_abc123def456", "type": "string" } }, { "description": "Clip identifier", "in": "path", "name": "clipId", "required": true, "schema": { "description": "Clip identifier", "example": "cl_xyz789ghi012", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListClipMasksResponse" } } }, "description": "OK", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "400": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "bad_request", "message": "The request was malformed or contained invalid parameters." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request was malformed or contained invalid parameters.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "401": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "unauthorized", "message": "Authentication is required. Provide a valid API key." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required. Provide a valid API key.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "403": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "forbidden", "message": "You don't have permission to access this resource." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "You don't have permission to access this resource.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "404": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "not_found", "message": "The requested resource was not found." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested resource was not found.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "429": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "rate_limited", "message": "You have exceeded the rate limit. Please slow down." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "You have exceeded the rate limit. Please slow down.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Retry-After": { "$ref": "#/components/headers/RetryAfter" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "500": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "server_error", "message": "An unexpected error occurred" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "501": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "not_implemented", "message": "The requested operation is not implemented." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested operation is not implemented.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } } }, "security": [ { "BearerAuth": [] } ], "summary": "List highlights on a clip", "tags": [ "Clips" ] }, "post": { "description": "Adds a highlight mask to a clip. Always targets the subject screen layer (the only supported target).", "operationId": "addClipHighlight", "parameters": [ { "description": "Video identifier", "in": "path", "name": "id", "required": true, "schema": { "description": "Video identifier", "example": "vid_abc123def456", "type": "string" } }, { "description": "Clip identifier", "in": "path", "name": "clipId", "required": true, "schema": { "description": "Clip identifier", "example": "cl_xyz789ghi012", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddClipMaskRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClipMaskResponse" } } }, "description": "OK", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "400": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "bad_request", "message": "The request was malformed or contained invalid parameters." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request was malformed or contained invalid parameters.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "401": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "unauthorized", "message": "Authentication is required. Provide a valid API key." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required. Provide a valid API key.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "403": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "forbidden", "message": "You don't have permission to access this resource." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "You don't have permission to access this resource.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "404": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "not_found", "message": "The requested resource was not found." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested resource was not found.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "429": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "rate_limited", "message": "You have exceeded the rate limit. Please slow down." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "You have exceeded the rate limit. Please slow down.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Retry-After": { "$ref": "#/components/headers/RetryAfter" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "500": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "server_error", "message": "An unexpected error occurred" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "501": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "not_implemented", "message": "The requested operation is not implemented." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested operation is not implemented.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } } }, "security": [ { "BearerAuth": [] } ], "summary": "Add a highlight to a clip", "tags": [ "Clips" ] } }, "/v1/videos/{id}/clips/{clipId}/highlights/{maskId}": { "delete": { "description": "Removes a highlight mask from a clip.", "operationId": "removeClipHighlight", "parameters": [ { "description": "Video ID", "in": "path", "name": "id", "required": true, "schema": { "description": "Video ID", "type": "string" } }, { "description": "Clip ID", "in": "path", "name": "clipId", "required": true, "schema": { "description": "Clip ID", "type": "string" } }, { "description": "Mask ID", "in": "path", "name": "maskId", "required": true, "schema": { "description": "Mask ID", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } }, "description": "Highlight removed", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "400": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "bad_request", "message": "The request was malformed or contained invalid parameters." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request was malformed or contained invalid parameters.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "401": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "unauthorized", "message": "Authentication is required. Provide a valid API key." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required. Provide a valid API key.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "403": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "forbidden", "message": "You don't have permission to access this resource." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "You don't have permission to access this resource.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "404": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "not_found", "message": "The requested resource was not found." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested resource was not found.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "429": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "rate_limited", "message": "You have exceeded the rate limit. Please slow down." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "You have exceeded the rate limit. Please slow down.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Retry-After": { "$ref": "#/components/headers/RetryAfter" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "500": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "server_error", "message": "An unexpected error occurred" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "501": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "not_implemented", "message": "The requested operation is not implemented." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested operation is not implemented.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } } }, "security": [ { "BearerAuth": [] } ], "summary": "Remove a highlight", "tags": [ "Clips" ] }, "patch": { "description": "Update a highlight mask's timing, position, or size. Only the fields you send are changed.", "operationId": "updateClipHighlight", "parameters": [ { "description": "Video ID", "in": "path", "name": "id", "required": true, "schema": { "description": "Video ID", "type": "string" } }, { "description": "Clip ID", "in": "path", "name": "clipId", "required": true, "schema": { "description": "Clip ID", "type": "string" } }, { "description": "Mask ID", "in": "path", "name": "maskId", "required": true, "schema": { "description": "Mask ID", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateClipMaskRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClipMaskResponse" } } }, "description": "OK", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "400": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "bad_request", "message": "The request was malformed or contained invalid parameters." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request was malformed or contained invalid parameters.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "401": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "unauthorized", "message": "Authentication is required. Provide a valid API key." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required. Provide a valid API key.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "403": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "forbidden", "message": "You don't have permission to access this resource." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "You don't have permission to access this resource.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "404": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "not_found", "message": "The requested resource was not found." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested resource was not found.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "429": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "rate_limited", "message": "You have exceeded the rate limit. Please slow down." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "You have exceeded the rate limit. Please slow down.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Retry-After": { "$ref": "#/components/headers/RetryAfter" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "500": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "server_error", "message": "An unexpected error occurred" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "501": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "not_implemented", "message": "The requested operation is not implemented." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested operation is not implemented.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } } }, "security": [ { "BearerAuth": [] } ], "summary": "Update a highlight", "tags": [ "Clips" ] } }, "/v1/videos/{id}/clips/{clipId}/layouts": { "get": { "description": "Returns the layouts (sections) attached to a clip.", "operationId": "listClipLayouts", "parameters": [ { "description": "Video identifier", "in": "path", "name": "id", "required": true, "schema": { "description": "Video identifier", "example": "vid_abc123def456", "type": "string" } }, { "description": "Clip identifier", "in": "path", "name": "clipId", "required": true, "schema": { "description": "Clip identifier", "example": "cl_xyz789ghi012", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListClipLayoutsResponse" } } }, "description": "OK", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "400": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "bad_request", "message": "The request was malformed or contained invalid parameters." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request was malformed or contained invalid parameters.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "401": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "unauthorized", "message": "Authentication is required. Provide a valid API key." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required. Provide a valid API key.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "403": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "forbidden", "message": "You don't have permission to access this resource." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "You don't have permission to access this resource.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "404": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "not_found", "message": "The requested resource was not found." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested resource was not found.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "429": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "rate_limited", "message": "You have exceeded the rate limit. Please slow down." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "You have exceeded the rate limit. Please slow down.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Retry-After": { "$ref": "#/components/headers/RetryAfter" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "500": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "server_error", "message": "An unexpected error occurred" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "501": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "not_implemented", "message": "The requested operation is not implemented." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested operation is not implemented.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } } }, "security": [ { "BearerAuth": [] } ], "summary": "List layouts on a clip", "tags": [ "Clips" ] }, "post": { "description": "Adds a layout to a clip. Provide both startTimeMs and durationMs for a time-ranged layout, or omit both for a clip-spanning layout.", "operationId": "addClipLayout", "parameters": [ { "description": "Video identifier", "in": "path", "name": "id", "required": true, "schema": { "description": "Video identifier", "example": "vid_abc123def456", "type": "string" } }, { "description": "Clip identifier", "in": "path", "name": "clipId", "required": true, "schema": { "description": "Clip identifier", "example": "cl_xyz789ghi012", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddClipLayoutRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClipLayoutResponse" } } }, "description": "OK", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "400": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "bad_request", "message": "The request was malformed or contained invalid parameters." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request was malformed or contained invalid parameters.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "401": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "unauthorized", "message": "Authentication is required. Provide a valid API key." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required. Provide a valid API key.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "403": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "forbidden", "message": "You don't have permission to access this resource." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "You don't have permission to access this resource.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "404": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "not_found", "message": "The requested resource was not found." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested resource was not found.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "429": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "rate_limited", "message": "You have exceeded the rate limit. Please slow down." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "You have exceeded the rate limit. Please slow down.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Retry-After": { "$ref": "#/components/headers/RetryAfter" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "500": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "server_error", "message": "An unexpected error occurred" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "501": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "not_implemented", "message": "The requested operation is not implemented." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested operation is not implemented.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } } }, "security": [ { "BearerAuth": [] } ], "summary": "Add a layout to a clip", "tags": [ "Clips" ] } }, "/v1/videos/{id}/clips/{clipId}/layouts/auto": { "post": { "description": "Lets AI watch the clip and lay it out — the API twin of the editor's \"Auto layouts\". The clip's existing layouts are replaced: the AI picks an editing style (or follows `style`), sets the clip's base layout, and adds time-ranged layout changes. Generation watches the actual video, so expect the request to take on the order of a minute for longer clips.", "operationId": "generateAutoLayouts", "parameters": [ { "description": "Video identifier", "in": "path", "name": "id", "required": true, "schema": { "description": "Video identifier", "example": "vid_abc123def456", "type": "string" } }, { "description": "Clip identifier", "in": "path", "name": "clipId", "required": true, "schema": { "description": "Clip identifier", "example": "cl_xyz789ghi012", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GenerateAutoLayoutsRequest" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GenerateAutoLayoutsResponse" } } }, "description": "OK", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "400": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "bad_request", "message": "The request was malformed or contained invalid parameters." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request was malformed or contained invalid parameters.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "401": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "unauthorized", "message": "Authentication is required. Provide a valid API key." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required. Provide a valid API key.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "403": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "forbidden", "message": "You don't have permission to access this resource." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "You don't have permission to access this resource.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "404": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "not_found", "message": "The requested resource was not found." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested resource was not found.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "429": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "rate_limited", "message": "You have exceeded the rate limit. Please slow down." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "You have exceeded the rate limit. Please slow down.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Retry-After": { "$ref": "#/components/headers/RetryAfter" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "500": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "server_error", "message": "An unexpected error occurred" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "501": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "not_implemented", "message": "The requested operation is not implemented." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested operation is not implemented.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } } }, "security": [ { "BearerAuth": [] } ], "summary": "Auto-generate layouts with AI", "tags": [ "Clips" ] } }, "/v1/videos/{id}/clips/{clipId}/layouts/{layoutId}": { "delete": { "description": "Removes a layout from a clip.", "operationId": "removeClipLayout", "parameters": [ { "description": "Video ID", "in": "path", "name": "id", "required": true, "schema": { "description": "Video ID", "type": "string" } }, { "description": "Clip ID", "in": "path", "name": "clipId", "required": true, "schema": { "description": "Clip ID", "type": "string" } }, { "description": "Layout (section) ID", "in": "path", "name": "layoutId", "required": true, "schema": { "description": "Layout (section) ID", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } }, "description": "Layout removed", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "400": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "bad_request", "message": "The request was malformed or contained invalid parameters." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request was malformed or contained invalid parameters.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "401": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "unauthorized", "message": "Authentication is required. Provide a valid API key." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required. Provide a valid API key.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "403": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "forbidden", "message": "You don't have permission to access this resource." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "You don't have permission to access this resource.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "404": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "not_found", "message": "The requested resource was not found." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested resource was not found.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "429": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "rate_limited", "message": "You have exceeded the rate limit. Please slow down." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "You have exceeded the rate limit. Please slow down.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Retry-After": { "$ref": "#/components/headers/RetryAfter" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "500": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "server_error", "message": "An unexpected error occurred" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "501": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "not_implemented", "message": "The requested operation is not implemented." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested operation is not implemented.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } } }, "security": [ { "BearerAuth": [] } ], "summary": "Remove a layout", "tags": [ "Clips" ] }, "patch": { "description": "Update a layout's shape, timing, transition style, or media. `transitionStyle` and `media` are only valid on time-ranged layouts, not on the base (clip-spanning) layout.", "operationId": "updateClipLayout", "parameters": [ { "description": "Video ID", "in": "path", "name": "id", "required": true, "schema": { "description": "Video ID", "type": "string" } }, { "description": "Clip ID", "in": "path", "name": "clipId", "required": true, "schema": { "description": "Clip ID", "type": "string" } }, { "description": "Layout (section) ID", "in": "path", "name": "layoutId", "required": true, "schema": { "description": "Layout (section) ID", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateClipLayoutRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClipLayoutResponse" } } }, "description": "OK", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "400": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "bad_request", "message": "The request was malformed or contained invalid parameters." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request was malformed or contained invalid parameters.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "401": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "unauthorized", "message": "Authentication is required. Provide a valid API key." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required. Provide a valid API key.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "403": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "forbidden", "message": "You don't have permission to access this resource." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "You don't have permission to access this resource.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "404": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "not_found", "message": "The requested resource was not found." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested resource was not found.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "429": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "rate_limited", "message": "You have exceeded the rate limit. Please slow down." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "You have exceeded the rate limit. Please slow down.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Retry-After": { "$ref": "#/components/headers/RetryAfter" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "500": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "server_error", "message": "An unexpected error occurred" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "501": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "not_implemented", "message": "The requested operation is not implemented." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested operation is not implemented.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } } }, "security": [ { "BearerAuth": [] } ], "summary": "Update a layout", "tags": [ "Clips" ] } }, "/v1/videos/{id}/clips/{clipId}/mouse-events": { "get": { "description": "Returns the cursor path and clicks recorded with the clip's screen recording, mapped onto the clip's playback timeline (cuts applied). Positions are percentages of the screen recording's dimensions — the same coordinate space as zoom focus points. Events during cut-out footage are dropped, and move events are sampled (default one per 100ms, `intervalMs=0` for every event). Use `types=clicks` to return only clicks. Returns an empty list when the recording has no mouse data (camera-only clips, uploads, older recorder versions).", "operationId": "listClipMouseEvents", "parameters": [ { "description": "Video identifier", "in": "path", "name": "id", "required": true, "schema": { "description": "Video identifier", "example": "vid_abc123def456", "type": "string" } }, { "description": "Clip identifier", "in": "path", "name": "clipId", "required": true, "schema": { "description": "Clip identifier", "example": "cl_xyz789ghi012", "type": "string" } }, { "description": "Thin move events to at most one per this many ms of playback — clicks are always kept. Defaults to 100. Pass 0 for every recorded event (can be tens of thousands on long recordings).", "in": "query", "name": "intervalMs", "schema": { "description": "Thin move events to at most one per this many ms of playback — clicks are always kept. Defaults to 100. Pass 0 for every recorded event (can be tens of thousands on long recordings).", "example": 100, "maximum": 9007199254740991, "minimum": 0, "type": "integer" } }, { "description": "Comma-separated event kinds to return: clicks, moves. Default: both. Use types=clicks for the positions where a mouse button went down — one event per press, not one per sample of a held button.", "in": "query", "name": "types", "schema": { "description": "Comma-separated event kinds to return: clicks, moves. Default: both. Use types=clicks for the positions where a mouse button went down — one event per press, not one per sample of a held button.", "example": "clicks", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListClipMouseEventsResponse" } } }, "description": "OK", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "400": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "bad_request", "message": "The request was malformed or contained invalid parameters." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request was malformed or contained invalid parameters.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "401": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "unauthorized", "message": "Authentication is required. Provide a valid API key." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required. Provide a valid API key.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "403": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "forbidden", "message": "You don't have permission to access this resource." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "You don't have permission to access this resource.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "404": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "not_found", "message": "The requested resource was not found." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested resource was not found.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "429": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "rate_limited", "message": "You have exceeded the rate limit. Please slow down." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "You have exceeded the rate limit. Please slow down.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Retry-After": { "$ref": "#/components/headers/RetryAfter" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "500": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "server_error", "message": "An unexpected error occurred" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "501": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "not_implemented", "message": "The requested operation is not implemented." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested operation is not implemented.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } } }, "security": [ { "BearerAuth": [] } ], "summary": "List mouse events on a clip", "tags": [ "Clips" ] } }, "/v1/videos/{id}/clips/{clipId}/overlays": { "get": { "description": "Returns the image and video overlays on a clip.", "operationId": "listClipOverlays", "parameters": [ { "description": "Video identifier", "in": "path", "name": "id", "required": true, "schema": { "description": "Video identifier", "example": "vid_abc123def456", "type": "string" } }, { "description": "Clip identifier", "in": "path", "name": "clipId", "required": true, "schema": { "description": "Clip identifier", "example": "cl_xyz789ghi012", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListClipOverlaysResponse" } } }, "description": "OK", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "400": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "bad_request", "message": "The request was malformed or contained invalid parameters." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request was malformed or contained invalid parameters.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "401": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "unauthorized", "message": "Authentication is required. Provide a valid API key." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required. Provide a valid API key.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "403": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "forbidden", "message": "You don't have permission to access this resource." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "You don't have permission to access this resource.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "404": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "not_found", "message": "The requested resource was not found." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested resource was not found.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "429": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "rate_limited", "message": "You have exceeded the rate limit. Please slow down." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "You have exceeded the rate limit. Please slow down.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Retry-After": { "$ref": "#/components/headers/RetryAfter" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "500": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "server_error", "message": "An unexpected error occurred" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "501": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "not_implemented", "message": "The requested operation is not implemented." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested operation is not implemented.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } } }, "security": [ { "BearerAuth": [] } ], "summary": "List overlays on a clip", "tags": [ "Clips" ] }, "post": { "description": "Adds an image or video overlay to a clip. Upload the bytes via `POST /v1/sources` (`kind: image` or `kind: video`) and pass the `sourceId`; the overlay type follows the source's kind.", "operationId": "addClipOverlay", "parameters": [ { "description": "Video identifier", "in": "path", "name": "id", "required": true, "schema": { "description": "Video identifier", "example": "vid_abc123def456", "type": "string" } }, { "description": "Clip identifier", "in": "path", "name": "clipId", "required": true, "schema": { "description": "Clip identifier", "example": "cl_xyz789ghi012", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddClipOverlayRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClipOverlayResponse" } } }, "description": "OK", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "400": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "bad_request", "message": "The request was malformed or contained invalid parameters." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request was malformed or contained invalid parameters.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "401": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "unauthorized", "message": "Authentication is required. Provide a valid API key." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required. Provide a valid API key.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "403": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "forbidden", "message": "You don't have permission to access this resource." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "You don't have permission to access this resource.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "404": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "not_found", "message": "The requested resource was not found." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested resource was not found.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "429": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "rate_limited", "message": "You have exceeded the rate limit. Please slow down." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "You have exceeded the rate limit. Please slow down.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Retry-After": { "$ref": "#/components/headers/RetryAfter" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "500": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "server_error", "message": "An unexpected error occurred" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "501": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "not_implemented", "message": "The requested operation is not implemented." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested operation is not implemented.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } } }, "security": [ { "BearerAuth": [] } ], "summary": "Add an overlay to a clip", "tags": [ "Clips" ] } }, "/v1/videos/{id}/clips/{clipId}/overlays/{overlayId}": { "delete": { "description": "Removes an image or video overlay from a clip.", "operationId": "removeClipOverlay", "parameters": [ { "description": "Video ID", "in": "path", "name": "id", "required": true, "schema": { "description": "Video ID", "type": "string" } }, { "description": "Clip ID", "in": "path", "name": "clipId", "required": true, "schema": { "description": "Clip ID", "type": "string" } }, { "description": "Overlay ID", "in": "path", "name": "overlayId", "required": true, "schema": { "description": "Overlay ID", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } }, "description": "Overlay removed", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "400": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "bad_request", "message": "The request was malformed or contained invalid parameters." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request was malformed or contained invalid parameters.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "401": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "unauthorized", "message": "Authentication is required. Provide a valid API key." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required. Provide a valid API key.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "403": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "forbidden", "message": "You don't have permission to access this resource." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "You don't have permission to access this resource.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "404": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "not_found", "message": "The requested resource was not found." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested resource was not found.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "429": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "rate_limited", "message": "You have exceeded the rate limit. Please slow down." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "You have exceeded the rate limit. Please slow down.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Retry-After": { "$ref": "#/components/headers/RetryAfter" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "500": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "server_error", "message": "An unexpected error occurred" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "501": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "not_implemented", "message": "The requested operation is not implemented." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested operation is not implemented.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } } }, "security": [ { "BearerAuth": [] } ], "summary": "Remove an overlay", "tags": [ "Clips" ] }, "patch": { "description": "Update an overlay's name, timing, position, or dimensions. Only the fields you send are changed.", "operationId": "updateClipOverlay", "parameters": [ { "description": "Video ID", "in": "path", "name": "id", "required": true, "schema": { "description": "Video ID", "type": "string" } }, { "description": "Clip ID", "in": "path", "name": "clipId", "required": true, "schema": { "description": "Clip ID", "type": "string" } }, { "description": "Overlay ID", "in": "path", "name": "overlayId", "required": true, "schema": { "description": "Overlay ID", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateClipOverlayRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClipOverlayResponse" } } }, "description": "OK", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "400": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "bad_request", "message": "The request was malformed or contained invalid parameters." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request was malformed or contained invalid parameters.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "401": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "unauthorized", "message": "Authentication is required. Provide a valid API key." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required. Provide a valid API key.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "403": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "forbidden", "message": "You don't have permission to access this resource." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "You don't have permission to access this resource.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "404": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "not_found", "message": "The requested resource was not found." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested resource was not found.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "429": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "rate_limited", "message": "You have exceeded the rate limit. Please slow down." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "You have exceeded the rate limit. Please slow down.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Retry-After": { "$ref": "#/components/headers/RetryAfter" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "500": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "server_error", "message": "An unexpected error occurred" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "501": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "not_implemented", "message": "The requested operation is not implemented." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested operation is not implemented.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } } }, "security": [ { "BearerAuth": [] } ], "summary": "Update an overlay", "tags": [ "Clips" ] } }, "/v1/videos/{id}/clips/{clipId}/remove-fillers": { "post": { "description": "Detects filler words ('um', 'uh', 'hmm', etc.) and adds cuts that bracket each filler. New cuts are merged with any existing cuts. Returns the updated clip.", "operationId": "removeClipFillers", "parameters": [ { "description": "Video identifier", "in": "path", "name": "id", "required": true, "schema": { "description": "Video identifier", "example": "vid_abc123def456", "type": "string" } }, { "description": "Clip identifier", "in": "path", "name": "clipId", "required": true, "schema": { "description": "Clip identifier", "example": "cl_xyz789ghi012", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetClipResponse" } } }, "description": "OK", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "400": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "bad_request", "message": "The request was malformed or contained invalid parameters." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request was malformed or contained invalid parameters.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "401": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "unauthorized", "message": "Authentication is required. Provide a valid API key." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required. Provide a valid API key.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "403": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "forbidden", "message": "You don't have permission to access this resource." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "You don't have permission to access this resource.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "404": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "not_found", "message": "The requested resource was not found." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested resource was not found.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "429": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "rate_limited", "message": "You have exceeded the rate limit. Please slow down." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "You have exceeded the rate limit. Please slow down.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Retry-After": { "$ref": "#/components/headers/RetryAfter" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "500": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "server_error", "message": "An unexpected error occurred" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "501": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "not_implemented", "message": "The requested operation is not implemented." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested operation is not implemented.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } } }, "security": [ { "BearerAuth": [] } ], "summary": "Remove filler words from a clip", "tags": [ "Clips" ] } }, "/v1/videos/{id}/clips/{clipId}/remove-silences": { "post": { "description": "Detects silent pauses in the clip's audio and adds cuts that remove them, like the editor's Remove silences tool. `mode` controls aggressiveness: natural cuts pauses longer than 800ms, fast longer than 500ms, faster longer than 300ms (default natural). New cuts are merged with any existing cuts. Returns the updated clip.", "operationId": "removeClipSilences", "parameters": [ { "description": "Video identifier", "in": "path", "name": "id", "required": true, "schema": { "description": "Video identifier", "example": "vid_abc123def456", "type": "string" } }, { "description": "Clip identifier", "in": "path", "name": "clipId", "required": true, "schema": { "description": "Clip identifier", "example": "cl_xyz789ghi012", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RemoveSilencesRequest" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetClipResponse" } } }, "description": "OK", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "400": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "bad_request", "message": "The request was malformed or contained invalid parameters." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request was malformed or contained invalid parameters.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "401": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "unauthorized", "message": "Authentication is required. Provide a valid API key." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required. Provide a valid API key.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "403": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "forbidden", "message": "You don't have permission to access this resource." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "You don't have permission to access this resource.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "404": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "not_found", "message": "The requested resource was not found." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested resource was not found.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "429": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "rate_limited", "message": "You have exceeded the rate limit. Please slow down." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "You have exceeded the rate limit. Please slow down.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Retry-After": { "$ref": "#/components/headers/RetryAfter" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "500": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "server_error", "message": "An unexpected error occurred" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "501": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "not_implemented", "message": "The requested operation is not implemented." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested operation is not implemented.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } } }, "security": [ { "BearerAuth": [] } ], "summary": "Remove silences from a clip", "tags": [ "Clips" ] } }, "/v1/videos/{id}/clips/{clipId}/reorder": { "post": { "description": "Moves a clip to a new position within its video. Other clips are renumbered to keep ordering contiguous.", "operationId": "reorderClip", "parameters": [ { "description": "Video identifier", "in": "path", "name": "id", "required": true, "schema": { "description": "Video identifier", "example": "vid_abc123def456", "type": "string" } }, { "description": "Clip identifier", "in": "path", "name": "clipId", "required": true, "schema": { "description": "Clip identifier", "example": "cl_xyz789ghi012", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReorderClipRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetClipResponse" } } }, "description": "OK", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "400": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "bad_request", "message": "The request was malformed or contained invalid parameters." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request was malformed or contained invalid parameters.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "401": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "unauthorized", "message": "Authentication is required. Provide a valid API key." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required. Provide a valid API key.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "403": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "forbidden", "message": "You don't have permission to access this resource." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "You don't have permission to access this resource.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "404": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "not_found", "message": "The requested resource was not found." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested resource was not found.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "429": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "rate_limited", "message": "You have exceeded the rate limit. Please slow down." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "You have exceeded the rate limit. Please slow down.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Retry-After": { "$ref": "#/components/headers/RetryAfter" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "500": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "server_error", "message": "An unexpected error occurred" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "501": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "not_implemented", "message": "The requested operation is not implemented." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested operation is not implemented.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } } }, "security": [ { "BearerAuth": [] } ], "summary": "Reorder a clip", "tags": [ "Clips" ] } }, "/v1/videos/{id}/clips/{clipId}/silences": { "get": { "description": "Returns silent ranges in a clip's audio, in ms on the clip's playback timeline (cuts applied) — pass ranges directly to the cut endpoint. Silences already removed by cuts are not reported.", "operationId": "getClipSilences", "parameters": [ { "description": "Video identifier", "in": "path", "name": "id", "required": true, "schema": { "description": "Video identifier", "example": "vid_abc123def456", "type": "string" } }, { "description": "Clip identifier", "in": "path", "name": "clipId", "required": true, "schema": { "description": "Clip identifier", "example": "cl_xyz789ghi012", "type": "string" } }, { "description": "Minimum silence duration to report, in ms. Defaults to 200.", "in": "query", "name": "minDurationMs", "schema": { "description": "Minimum silence duration to report, in ms. Defaults to 200.", "example": 500, "exclusiveMinimum": true, "maximum": 9007199254740991, "minimum": 0, "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListClipSilencesResponse" } } }, "description": "OK", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "400": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "bad_request", "message": "The request was malformed or contained invalid parameters." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request was malformed or contained invalid parameters.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "401": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "unauthorized", "message": "Authentication is required. Provide a valid API key." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required. Provide a valid API key.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "403": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "forbidden", "message": "You don't have permission to access this resource." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "You don't have permission to access this resource.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "404": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "not_found", "message": "The requested resource was not found." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested resource was not found.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "429": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "rate_limited", "message": "You have exceeded the rate limit. Please slow down." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "You have exceeded the rate limit. Please slow down.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Retry-After": { "$ref": "#/components/headers/RetryAfter" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "500": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "server_error", "message": "An unexpected error occurred" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "501": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "not_implemented", "message": "The requested operation is not implemented." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested operation is not implemented.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } } }, "security": [ { "BearerAuth": [] } ], "summary": "Get silent ranges in a clip", "tags": [ "Clips" ] } }, "/v1/videos/{id}/clips/{clipId}/sound-effects": { "get": { "description": "Returns the sound effects (audio overlays) on a clip.", "operationId": "listClipSoundEffects", "parameters": [ { "description": "Video identifier", "in": "path", "name": "id", "required": true, "schema": { "description": "Video identifier", "example": "vid_abc123def456", "type": "string" } }, { "description": "Clip identifier", "in": "path", "name": "clipId", "required": true, "schema": { "description": "Clip identifier", "example": "cl_xyz789ghi012", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListClipSoundEffectsResponse" } } }, "description": "OK", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "400": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "bad_request", "message": "The request was malformed or contained invalid parameters." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request was malformed or contained invalid parameters.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "401": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "unauthorized", "message": "Authentication is required. Provide a valid API key." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required. Provide a valid API key.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "403": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "forbidden", "message": "You don't have permission to access this resource." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "You don't have permission to access this resource.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "404": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "not_found", "message": "The requested resource was not found." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested resource was not found.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "429": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "rate_limited", "message": "You have exceeded the rate limit. Please slow down." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "You have exceeded the rate limit. Please slow down.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Retry-After": { "$ref": "#/components/headers/RetryAfter" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "500": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "server_error", "message": "An unexpected error occurred" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "501": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "not_implemented", "message": "The requested operation is not implemented." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested operation is not implemented.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } } }, "security": [ { "BearerAuth": [] } ], "summary": "List sound effects on a clip", "tags": [ "Clips" ] }, "post": { "description": "Adds a sound effect to a clip from Tella's curated catalog (`presetId`) or your own audio (`sourceId`).", "operationId": "addClipSoundEffect", "parameters": [ { "description": "Video identifier", "in": "path", "name": "id", "required": true, "schema": { "description": "Video identifier", "example": "vid_abc123def456", "type": "string" } }, { "description": "Clip identifier", "in": "path", "name": "clipId", "required": true, "schema": { "description": "Clip identifier", "example": "cl_xyz789ghi012", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddClipSoundEffectRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClipSoundEffectResponse" } } }, "description": "OK", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "400": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "bad_request", "message": "The request was malformed or contained invalid parameters." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request was malformed or contained invalid parameters.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "401": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "unauthorized", "message": "Authentication is required. Provide a valid API key." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required. Provide a valid API key.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "403": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "forbidden", "message": "You don't have permission to access this resource." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "You don't have permission to access this resource.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "404": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "not_found", "message": "The requested resource was not found." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested resource was not found.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "429": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "rate_limited", "message": "You have exceeded the rate limit. Please slow down." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "You have exceeded the rate limit. Please slow down.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Retry-After": { "$ref": "#/components/headers/RetryAfter" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "500": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "server_error", "message": "An unexpected error occurred" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "501": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "not_implemented", "message": "The requested operation is not implemented." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested operation is not implemented.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } } }, "security": [ { "BearerAuth": [] } ], "summary": "Add a sound effect to a clip", "tags": [ "Clips" ] } }, "/v1/videos/{id}/clips/{clipId}/sound-effects/{soundEffectId}": { "delete": { "description": "Removes a sound effect from a clip.", "operationId": "removeClipSoundEffect", "parameters": [ { "description": "Video ID", "in": "path", "name": "id", "required": true, "schema": { "description": "Video ID", "type": "string" } }, { "description": "Clip ID", "in": "path", "name": "clipId", "required": true, "schema": { "description": "Clip ID", "type": "string" } }, { "description": "Sound effect ID", "in": "path", "name": "soundEffectId", "required": true, "schema": { "description": "Sound effect ID", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } }, "description": "Sound effect removed", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "400": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "bad_request", "message": "The request was malformed or contained invalid parameters." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request was malformed or contained invalid parameters.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "401": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "unauthorized", "message": "Authentication is required. Provide a valid API key." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required. Provide a valid API key.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "403": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "forbidden", "message": "You don't have permission to access this resource." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "You don't have permission to access this resource.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "404": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "not_found", "message": "The requested resource was not found." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested resource was not found.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "429": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "rate_limited", "message": "You have exceeded the rate limit. Please slow down." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "You have exceeded the rate limit. Please slow down.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Retry-After": { "$ref": "#/components/headers/RetryAfter" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "500": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "server_error", "message": "An unexpected error occurred" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "501": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "not_implemented", "message": "The requested operation is not implemented." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested operation is not implemented.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } } }, "security": [ { "BearerAuth": [] } ], "summary": "Remove a sound effect", "tags": [ "Clips" ] }, "patch": { "description": "Update a sound effect's name, timing, or volume. Only the fields you send are changed.", "operationId": "updateClipSoundEffect", "parameters": [ { "description": "Video ID", "in": "path", "name": "id", "required": true, "schema": { "description": "Video ID", "type": "string" } }, { "description": "Clip ID", "in": "path", "name": "clipId", "required": true, "schema": { "description": "Clip ID", "type": "string" } }, { "description": "Sound effect ID", "in": "path", "name": "soundEffectId", "required": true, "schema": { "description": "Sound effect ID", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateClipSoundEffectRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClipSoundEffectResponse" } } }, "description": "OK", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "400": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "bad_request", "message": "The request was malformed or contained invalid parameters." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request was malformed or contained invalid parameters.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "401": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "unauthorized", "message": "Authentication is required. Provide a valid API key." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required. Provide a valid API key.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "403": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "forbidden", "message": "You don't have permission to access this resource." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "You don't have permission to access this resource.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "404": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "not_found", "message": "The requested resource was not found." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested resource was not found.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "429": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "rate_limited", "message": "You have exceeded the rate limit. Please slow down." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "You have exceeded the rate limit. Please slow down.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Retry-After": { "$ref": "#/components/headers/RetryAfter" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "500": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "server_error", "message": "An unexpected error occurred" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "501": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "not_implemented", "message": "The requested operation is not implemented." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested operation is not implemented.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } } }, "security": [ { "BearerAuth": [] } ], "summary": "Update a sound effect", "tags": [ "Clips" ] } }, "/v1/videos/{id}/clips/{clipId}/sources": { "get": { "description": "Returns the underlying sources used by a clip's layers, each with the volume it plays at in this clip.", "operationId": "listClipSources", "parameters": [ { "description": "Video identifier", "in": "path", "name": "id", "required": true, "schema": { "description": "Video identifier", "example": "vid_abc123def456", "type": "string" } }, { "description": "Clip identifier", "in": "path", "name": "clipId", "required": true, "schema": { "description": "Clip identifier", "example": "cl_xyz789ghi012", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListClipSourcesResponse" } } }, "description": "OK", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "400": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "bad_request", "message": "The request was malformed or contained invalid parameters." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request was malformed or contained invalid parameters.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "401": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "unauthorized", "message": "Authentication is required. Provide a valid API key." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required. Provide a valid API key.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "403": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "forbidden", "message": "You don't have permission to access this resource." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "You don't have permission to access this resource.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "404": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "not_found", "message": "The requested resource was not found." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested resource was not found.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "429": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "rate_limited", "message": "You have exceeded the rate limit. Please slow down." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "You have exceeded the rate limit. Please slow down.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Retry-After": { "$ref": "#/components/headers/RetryAfter" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "500": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "server_error", "message": "An unexpected error occurred" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "501": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "not_implemented", "message": "The requested operation is not implemented." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested operation is not implemented.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } } }, "security": [ { "BearerAuth": [] } ], "summary": "List sources for a clip", "tags": [ "Clips" ] } }, "/v1/videos/{id}/clips/{clipId}/sources/{sourceId}/thumbnail": { "get": { "description": "Get a thumbnail of a source. If you pass `width`/`height`, the aspect ratio must match the source's native ratio. Omit both to default to the source's native size.", "operationId": "getSourceThumbnail", "parameters": [ { "description": "Video ID", "in": "path", "name": "id", "required": true, "schema": { "description": "Video ID", "type": "string" } }, { "description": "Clip ID", "in": "path", "name": "clipId", "required": true, "schema": { "description": "Clip ID", "type": "string" } }, { "description": "Source ID", "in": "path", "name": "sourceId", "required": true, "schema": { "description": "Source ID", "type": "string" } }, { "description": "Output format. Defaults to jpg.", "in": "query", "name": "format", "schema": { "description": "Output format. Defaults to jpg.", "enum": [ "jpg", "png", "webp", "gif", "mp4" ], "example": "jpg", "type": "string" } }, { "description": "Frame offset in ms from the source's start. Defaults to 0.", "in": "query", "name": "inpointMs", "schema": { "description": "Frame offset in ms from the source's start. Defaults to 0.", "example": 1000, "maximum": 9007199254740991, "minimum": 0, "type": "integer" } }, { "description": "Duration of the animated preview in ms. Only valid when format is gif or mp4.", "in": "query", "name": "durationMs", "schema": { "description": "Duration of the animated preview in ms. Only valid when format is gif or mp4.", "example": 3000, "exclusiveMinimum": true, "maximum": 9007199254740991, "minimum": 0, "type": "integer" } }, { "description": "Output width in pixels. The thumbnail keeps the source's aspect ratio; a missing side is derived from it.", "in": "query", "name": "width", "schema": { "description": "Output width in pixels. The thumbnail keeps the source's aspect ratio; a missing side is derived from it.", "example": 1280, "exclusiveMinimum": true, "maximum": 9007199254740991, "minimum": 0, "type": "integer" } }, { "description": "Output height in pixels. Derived from the source's aspect ratio when omitted.", "in": "query", "name": "height", "schema": { "description": "Output height in pixels. Derived from the source's aspect ratio when omitted.", "example": 720, "exclusiveMinimum": true, "maximum": 9007199254740991, "minimum": 0, "type": "integer" } }, { "description": "Suggest a download disposition on the signed URL.", "in": "query", "name": "download", "schema": { "anyOf": [ { "enum": [ "true" ], "type": "string" }, { "enum": [ "false" ], "type": "string" } ], "description": "Suggest a download disposition on the signed URL." } }, { "description": "Set to 'json' to receive `{url}` instead of the default 302 redirect.", "in": "query", "name": "response", "schema": { "description": "Set to 'json' to receive `{url}` instead of the default 302 redirect.", "enum": [ "json" ], "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ThumbnailResponse" } } }, "description": "Returned when `?response=json` is set", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "302": { "description": "Redirect to the signed CDN URL", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "400": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "bad_request", "message": "The request was malformed or contained invalid parameters." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request was malformed or contained invalid parameters.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "401": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "unauthorized", "message": "Authentication is required. Provide a valid API key." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required. Provide a valid API key.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "403": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "forbidden", "message": "You don't have permission to access this resource." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "You don't have permission to access this resource.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "404": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "not_found", "message": "The requested resource was not found." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested resource was not found.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "429": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "rate_limited", "message": "You have exceeded the rate limit. Please slow down." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "You have exceeded the rate limit. Please slow down.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Retry-After": { "$ref": "#/components/headers/RetryAfter" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "500": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "server_error", "message": "An unexpected error occurred" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "501": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "not_implemented", "message": "The requested operation is not implemented." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested operation is not implemented.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } } }, "security": [ { "BearerAuth": [] } ], "summary": "Get a source thumbnail or animated preview", "tags": [ "Clips" ] } }, "/v1/videos/{id}/clips/{clipId}/sources/{sourceId}/waveform": { "get": { "description": "Returns the audio waveform JSON for a source in BBC audiowaveform format. Use the `data` array to render a custom waveform visualization.", "operationId": "getSourceWaveform", "parameters": [ { "description": "Video ID", "in": "path", "name": "id", "required": true, "schema": { "description": "Video ID", "type": "string" } }, { "description": "Clip ID", "in": "path", "name": "clipId", "required": true, "schema": { "description": "Clip ID", "type": "string" } }, { "description": "Source ID", "in": "path", "name": "sourceId", "required": true, "schema": { "description": "Source ID", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SourceWaveformResponse" } } }, "description": "OK", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "400": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "bad_request", "message": "The request was malformed or contained invalid parameters." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request was malformed or contained invalid parameters.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "401": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "unauthorized", "message": "Authentication is required. Provide a valid API key." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required. Provide a valid API key.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "403": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "forbidden", "message": "You don't have permission to access this resource." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "You don't have permission to access this resource.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "404": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "not_found", "message": "The requested resource was not found." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested resource was not found.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "429": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "rate_limited", "message": "You have exceeded the rate limit. Please slow down." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "You have exceeded the rate limit. Please slow down.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Retry-After": { "$ref": "#/components/headers/RetryAfter" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "500": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "server_error", "message": "An unexpected error occurred" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "501": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "not_implemented", "message": "The requested operation is not implemented." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested operation is not implemented.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } } }, "security": [ { "BearerAuth": [] } ], "summary": "Get the audio waveform JSON for a source", "tags": [ "Clips" ] } }, "/v1/videos/{id}/clips/{clipId}/storyboard": { "get": { "description": "Returns a signed 4x4 WebP storyboard whose 16 tiles are sampled evenly across the requested window (`durationMs`/16 apart; every 5 seconds for the default 80s window) from a rendered clip, including its layouts, b-roll, zooms, and masks. `startTimeMs` is on the clip's playback timeline (cuts applied). Only `startTimeMs` and `durationMs` control the storyboard; tile count, dimensions, and format are fixed. By default returns a 302 redirect — set `?response=json` to get `{url}` JSON instead.", "operationId": "getClipStoryboard", "parameters": [ { "description": "Video identifier", "in": "path", "name": "id", "required": true, "schema": { "description": "Video identifier", "example": "vid_abc123def456", "type": "string" } }, { "description": "Clip identifier", "in": "path", "name": "clipId", "required": true, "schema": { "description": "Clip identifier", "example": "cl_xyz789ghi012", "type": "string" } }, { "description": "Start time in ms on the selected target's playback timeline. Defaults to 0.", "in": "query", "name": "startTimeMs", "schema": { "description": "Start time in ms on the selected target's playback timeline. Defaults to 0.", "example": 1000, "maximum": 2147483647, "minimum": 0, "type": "integer" } }, { "description": "Storyboard window duration in ms. Defaults to 80000; the selected target's remaining duration may shorten it. Pass the target's full duration to sample it end to end.", "in": "query", "name": "durationMs", "schema": { "description": "Storyboard window duration in ms. Defaults to 80000; the selected target's remaining duration may shorten it. Pass the target's full duration to sample it end to end.", "example": 30000, "maximum": 2147483647, "minimum": 1, "type": "integer" } }, { "description": "Set to 'json' to receive `{url}` instead of the default 302 redirect.", "in": "query", "name": "response", "schema": { "description": "Set to 'json' to receive `{url}` instead of the default 302 redirect.", "enum": [ "json" ], "example": "json", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StoryboardResponse" } } }, "description": "Returned when `?response=json` is set", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "302": { "description": "Redirect to the signed storyboard URL", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "400": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "bad_request", "message": "The request was malformed or contained invalid parameters." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request was malformed or contained invalid parameters.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "401": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "unauthorized", "message": "Authentication is required. Provide a valid API key." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required. Provide a valid API key.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "403": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "forbidden", "message": "You don't have permission to access this resource." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "You don't have permission to access this resource.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "404": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "not_found", "message": "The requested resource was not found." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested resource was not found.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "429": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "rate_limited", "message": "You have exceeded the rate limit. Please slow down." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "You have exceeded the rate limit. Please slow down.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Retry-After": { "$ref": "#/components/headers/RetryAfter" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "500": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "server_error", "message": "An unexpected error occurred" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "501": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "not_implemented", "message": "The requested operation is not implemented." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested operation is not implemented.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } } }, "security": [ { "BearerAuth": [] } ], "summary": "Get a clip storyboard", "tags": [ "Clips" ] } }, "/v1/videos/{id}/clips/{clipId}/text-overlays": { "get": { "description": "Returns the text overlays on a clip.", "operationId": "listClipTextOverlays", "parameters": [ { "description": "Video identifier", "in": "path", "name": "id", "required": true, "schema": { "description": "Video identifier", "example": "vid_abc123def456", "type": "string" } }, { "description": "Clip identifier", "in": "path", "name": "clipId", "required": true, "schema": { "description": "Clip identifier", "example": "cl_xyz789ghi012", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListClipTextOverlaysResponse" } } }, "description": "OK", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "400": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "bad_request", "message": "The request was malformed or contained invalid parameters." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request was malformed or contained invalid parameters.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "401": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "unauthorized", "message": "Authentication is required. Provide a valid API key." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required. Provide a valid API key.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "403": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "forbidden", "message": "You don't have permission to access this resource." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "You don't have permission to access this resource.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "404": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "not_found", "message": "The requested resource was not found." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested resource was not found.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "429": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "rate_limited", "message": "You have exceeded the rate limit. Please slow down." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "You have exceeded the rate limit. Please slow down.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Retry-After": { "$ref": "#/components/headers/RetryAfter" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "500": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "server_error", "message": "An unexpected error occurred" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "501": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "not_implemented", "message": "The requested operation is not implemented." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested operation is not implemented.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } } }, "security": [ { "BearerAuth": [] } ], "summary": "List text overlays on a clip", "tags": [ "Clips" ] }, "post": { "description": "Adds a text overlay to a clip. Nothing needs uploading — pass the copy directly. Font, color, position and size all fall back to the editor's defaults.", "operationId": "addClipTextOverlay", "parameters": [ { "description": "Video identifier", "in": "path", "name": "id", "required": true, "schema": { "description": "Video identifier", "example": "vid_abc123def456", "type": "string" } }, { "description": "Clip identifier", "in": "path", "name": "clipId", "required": true, "schema": { "description": "Clip identifier", "example": "cl_xyz789ghi012", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddClipTextOverlayRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClipTextOverlayResponse" } } }, "description": "OK", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "400": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "bad_request", "message": "The request was malformed or contained invalid parameters." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request was malformed or contained invalid parameters.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "401": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "unauthorized", "message": "Authentication is required. Provide a valid API key." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required. Provide a valid API key.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "403": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "forbidden", "message": "You don't have permission to access this resource." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "You don't have permission to access this resource.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "404": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "not_found", "message": "The requested resource was not found." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested resource was not found.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "429": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "rate_limited", "message": "You have exceeded the rate limit. Please slow down." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "You have exceeded the rate limit. Please slow down.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Retry-After": { "$ref": "#/components/headers/RetryAfter" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "500": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "server_error", "message": "An unexpected error occurred" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "501": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "not_implemented", "message": "The requested operation is not implemented." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested operation is not implemented.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } } }, "security": [ { "BearerAuth": [] } ], "summary": "Add a text overlay to a clip", "tags": [ "Clips" ] } }, "/v1/videos/{id}/clips/{clipId}/text-overlays/{textOverlayId}": { "delete": { "description": "Removes a text overlay from a clip.", "operationId": "removeClipTextOverlay", "parameters": [ { "description": "Video ID", "in": "path", "name": "id", "required": true, "schema": { "description": "Video ID", "type": "string" } }, { "description": "Clip ID", "in": "path", "name": "clipId", "required": true, "schema": { "description": "Clip ID", "type": "string" } }, { "description": "Text overlay ID", "in": "path", "name": "textOverlayId", "required": true, "schema": { "description": "Text overlay ID", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } }, "description": "Text overlay removed", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "400": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "bad_request", "message": "The request was malformed or contained invalid parameters." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request was malformed or contained invalid parameters.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "401": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "unauthorized", "message": "Authentication is required. Provide a valid API key." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required. Provide a valid API key.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "403": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "forbidden", "message": "You don't have permission to access this resource." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "You don't have permission to access this resource.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "404": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "not_found", "message": "The requested resource was not found." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested resource was not found.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "429": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "rate_limited", "message": "You have exceeded the rate limit. Please slow down." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "You have exceeded the rate limit. Please slow down.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Retry-After": { "$ref": "#/components/headers/RetryAfter" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "500": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "server_error", "message": "An unexpected error occurred" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "501": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "not_implemented", "message": "The requested operation is not implemented." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested operation is not implemented.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } } }, "security": [ { "BearerAuth": [] } ], "summary": "Remove a text overlay", "tags": [ "Clips" ] }, "patch": { "description": "Update a text overlay's copy, font, color, timing, position, or dimensions. Only the fields you send are changed.", "operationId": "updateClipTextOverlay", "parameters": [ { "description": "Video ID", "in": "path", "name": "id", "required": true, "schema": { "description": "Video ID", "type": "string" } }, { "description": "Clip ID", "in": "path", "name": "clipId", "required": true, "schema": { "description": "Clip ID", "type": "string" } }, { "description": "Text overlay ID", "in": "path", "name": "textOverlayId", "required": true, "schema": { "description": "Text overlay ID", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateClipTextOverlayRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClipTextOverlayResponse" } } }, "description": "OK", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "400": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "bad_request", "message": "The request was malformed or contained invalid parameters." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request was malformed or contained invalid parameters.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "401": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "unauthorized", "message": "Authentication is required. Provide a valid API key." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required. Provide a valid API key.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "403": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "forbidden", "message": "You don't have permission to access this resource." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "You don't have permission to access this resource.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "404": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "not_found", "message": "The requested resource was not found." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested resource was not found.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "429": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "rate_limited", "message": "You have exceeded the rate limit. Please slow down." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "You have exceeded the rate limit. Please slow down.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Retry-After": { "$ref": "#/components/headers/RetryAfter" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "500": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "server_error", "message": "An unexpected error occurred" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "501": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "not_implemented", "message": "The requested operation is not implemented." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested operation is not implemented.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } } }, "security": [ { "BearerAuth": [] } ], "summary": "Update a text overlay", "tags": [ "Clips" ] } }, "/v1/videos/{id}/clips/{clipId}/thumbnail": { "get": { "description": "Returns a signed CDN URL for a still image (jpg/png/webp) or animated preview (gif/mp4) of a clip — the rendered composite with the clip's layouts, zooms, and masks. By default returns a 302 redirect to the URL — set `?response=json` to get `{url}` JSON instead. `inpointMs` is on the clip's playback timeline (cuts applied). `durationMs` only applies to gif/mp4.", "operationId": "getClipThumbnail", "parameters": [ { "description": "Video identifier", "in": "path", "name": "id", "required": true, "schema": { "description": "Video identifier", "example": "vid_abc123def456", "type": "string" } }, { "description": "Clip identifier", "in": "path", "name": "clipId", "required": true, "schema": { "description": "Clip identifier", "example": "cl_xyz789ghi012", "type": "string" } }, { "description": "Output format. Defaults to jpg.", "in": "query", "name": "format", "schema": { "description": "Output format. Defaults to jpg.", "enum": [ "jpg", "png", "webp", "gif", "mp4" ], "example": "jpg", "type": "string" } }, { "description": "Frame offset in ms on the playback timeline (cuts applied) — clip-relative for the clip thumbnail, video-relative (cumulative across clips) for the video thumbnail. Defaults to 0.", "in": "query", "name": "inpointMs", "schema": { "description": "Frame offset in ms on the playback timeline (cuts applied) — clip-relative for the clip thumbnail, video-relative (cumulative across clips) for the video thumbnail. Defaults to 0.", "example": 1000, "maximum": 9007199254740991, "minimum": 0, "type": "integer" } }, { "description": "Duration of the animated preview in ms. Only valid when format is gif or mp4.", "in": "query", "name": "durationMs", "schema": { "description": "Duration of the animated preview in ms. Only valid when format is gif or mp4.", "example": 3000, "exclusiveMinimum": true, "maximum": 9007199254740991, "minimum": 0, "type": "integer" } }, { "description": "Frame rate for MP4 previews. Must be 1, 2, 5, 10, or 30. Defaults to 30.", "in": "query", "name": "fps", "schema": { "description": "Frame rate for MP4 previews. Must be 1, 2, 5, 10, or 30. Defaults to 30.", "example": 10, "type": "number" } }, { "description": "Output width in pixels. The thumbnail keeps the video's aspect ratio; a missing side is derived from it.", "in": "query", "name": "width", "schema": { "description": "Output width in pixels. The thumbnail keeps the video's aspect ratio; a missing side is derived from it.", "example": 1280, "exclusiveMinimum": true, "maximum": 9007199254740991, "minimum": 0, "type": "integer" } }, { "description": "Output height in pixels. Derived from the video's aspect ratio when omitted.", "in": "query", "name": "height", "schema": { "description": "Output height in pixels. Derived from the video's aspect ratio when omitted.", "example": 720, "exclusiveMinimum": true, "maximum": 9007199254740991, "minimum": 0, "type": "integer" } }, { "description": "Suggest a download disposition on the signed URL.", "in": "query", "name": "download", "schema": { "anyOf": [ { "enum": [ "true" ], "type": "string" }, { "enum": [ "false" ], "type": "string" } ], "description": "Suggest a download disposition on the signed URL.", "example": "false" } }, { "description": "Set to 'json' to receive `{url}` instead of the default 302 redirect.", "in": "query", "name": "response", "schema": { "description": "Set to 'json' to receive `{url}` instead of the default 302 redirect.", "enum": [ "json" ], "example": "json", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ThumbnailResponse" } } }, "description": "Returned when `?response=json` is set", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "302": { "description": "Redirect to the signed CDN URL", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "400": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "bad_request", "message": "The request was malformed or contained invalid parameters." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request was malformed or contained invalid parameters.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "401": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "unauthorized", "message": "Authentication is required. Provide a valid API key." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required. Provide a valid API key.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "403": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "forbidden", "message": "You don't have permission to access this resource." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "You don't have permission to access this resource.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "404": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "not_found", "message": "The requested resource was not found." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested resource was not found.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "429": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "rate_limited", "message": "You have exceeded the rate limit. Please slow down." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "You have exceeded the rate limit. Please slow down.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Retry-After": { "$ref": "#/components/headers/RetryAfter" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "500": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "server_error", "message": "An unexpected error occurred" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "501": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "not_implemented", "message": "The requested operation is not implemented." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested operation is not implemented.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } } }, "security": [ { "BearerAuth": [] } ], "summary": "Get a clip thumbnail or animated preview", "tags": [ "Clips" ] } }, "/v1/videos/{id}/clips/{clipId}/transcript": { "get": { "description": "Returns the words spoken in a clip with cuts applied — what viewers actually hear. Times are in ms relative to the clip's playback start. Word indices are stable identifiers for cut-by-transcript; they don't shift when cuts change.", "operationId": "getClipTranscript", "parameters": [ { "description": "Video identifier", "in": "path", "name": "id", "required": true, "schema": { "description": "Video identifier", "example": "vid_abc123def456", "type": "string" } }, { "description": "Clip identifier", "in": "path", "name": "clipId", "required": true, "schema": { "description": "Clip identifier", "example": "cl_xyz789ghi012", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClipTranscriptResponse" } } }, "description": "OK", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "400": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "bad_request", "message": "The request was malformed or contained invalid parameters." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request was malformed or contained invalid parameters.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "401": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "unauthorized", "message": "Authentication is required. Provide a valid API key." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required. Provide a valid API key.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "403": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "forbidden", "message": "You don't have permission to access this resource." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "You don't have permission to access this resource.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "404": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "not_found", "message": "The requested resource was not found." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested resource was not found.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "429": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "rate_limited", "message": "You have exceeded the rate limit. Please slow down." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "You have exceeded the rate limit. Please slow down.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Retry-After": { "$ref": "#/components/headers/RetryAfter" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "500": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "server_error", "message": "An unexpected error occurred" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "501": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "not_implemented", "message": "The requested operation is not implemented." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested operation is not implemented.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } } }, "security": [ { "BearerAuth": [] } ], "summary": "Get clip transcript", "tags": [ "Clips" ] } }, "/v1/videos/{id}/clips/{clipId}/transcript/words": { "patch": { "description": "Correct what a clip's transcript says, one or more words at a time (at most 100 per request). Each edit addresses a word by its transcript `index` and sets either `text` (the corrected wording, which also unhides the word) or `hidden` (whether the word appears in captions and subtitles). Edits change the transcript, captions and subtitles only — never the audio or the clip's timing; use cut-by-transcript to remove spoken words from the video. Visibility and wording are independent: hiding a word preserves any correction made to it. The whole batch is applied atomically as a single transaction, so a request never changes only some of its words. A `500` does not by itself mean nothing changed — the words can land and a later step of the commit still fail — so treat the outcome as either fully applied or not applied at all. Every edit assigns a word outright, so re-sending the identical request is safe and settles it.", "operationId": "updateClipTranscriptWords", "parameters": [ { "description": "Video identifier", "in": "path", "name": "id", "required": true, "schema": { "description": "Video identifier", "example": "vid_abc123def456", "type": "string" } }, { "description": "Clip identifier", "in": "path", "name": "clipId", "required": true, "schema": { "description": "Clip identifier", "example": "cl_xyz789ghi012", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateClipTranscriptWordsRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateClipTranscriptWordsResponse" } } }, "description": "OK", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "400": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "bad_request", "message": "The request was malformed or contained invalid parameters." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request was malformed or contained invalid parameters.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "401": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "unauthorized", "message": "Authentication is required. Provide a valid API key." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required. Provide a valid API key.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "403": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "forbidden", "message": "You don't have permission to access this resource." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "You don't have permission to access this resource.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "404": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "not_found", "message": "The requested resource was not found." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested resource was not found.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "429": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "rate_limited", "message": "You have exceeded the rate limit. Please slow down." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "You have exceeded the rate limit. Please slow down.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Retry-After": { "$ref": "#/components/headers/RetryAfter" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "500": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "server_error", "message": "An unexpected error occurred" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "501": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "not_implemented", "message": "The requested operation is not implemented." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested operation is not implemented.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } } }, "security": [ { "BearerAuth": [] } ], "summary": "Correct transcript words", "tags": [ "Clips" ] } }, "/v1/videos/{id}/clips/{clipId}/zooms": { "get": { "description": "Returns the zoom effects on a clip.", "operationId": "listClipZooms", "parameters": [ { "description": "Video identifier", "in": "path", "name": "id", "required": true, "schema": { "description": "Video identifier", "example": "vid_abc123def456", "type": "string" } }, { "description": "Clip identifier", "in": "path", "name": "clipId", "required": true, "schema": { "description": "Clip identifier", "example": "cl_xyz789ghi012", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListClipZoomsResponse" } } }, "description": "OK", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "400": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "bad_request", "message": "The request was malformed or contained invalid parameters." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request was malformed or contained invalid parameters.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "401": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "unauthorized", "message": "Authentication is required. Provide a valid API key." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required. Provide a valid API key.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "403": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "forbidden", "message": "You don't have permission to access this resource." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "You don't have permission to access this resource.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "404": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "not_found", "message": "The requested resource was not found." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested resource was not found.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "429": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "rate_limited", "message": "You have exceeded the rate limit. Please slow down." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "You have exceeded the rate limit. Please slow down.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Retry-After": { "$ref": "#/components/headers/RetryAfter" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "500": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "server_error", "message": "An unexpected error occurred" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "501": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "not_implemented", "message": "The requested operation is not implemented." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested operation is not implemented.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } } }, "security": [ { "BearerAuth": [] } ], "summary": "List zooms on a clip", "tags": [ "Clips" ] }, "post": { "description": "Adds a zoom to the clip's screen layer (the camera is unaffected). Use `manualZoom` with a `focusPoint`, or `trackingZoom` to follow the cursor.", "operationId": "addClipZoom", "parameters": [ { "description": "Video identifier", "in": "path", "name": "id", "required": true, "schema": { "description": "Video identifier", "example": "vid_abc123def456", "type": "string" } }, { "description": "Clip identifier", "in": "path", "name": "clipId", "required": true, "schema": { "description": "Clip identifier", "example": "cl_xyz789ghi012", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddClipZoomRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClipZoomResponse" } } }, "description": "OK", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "400": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "bad_request", "message": "The request was malformed or contained invalid parameters." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request was malformed or contained invalid parameters.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "401": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "unauthorized", "message": "Authentication is required. Provide a valid API key." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required. Provide a valid API key.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "403": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "forbidden", "message": "You don't have permission to access this resource." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "You don't have permission to access this resource.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "404": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "not_found", "message": "The requested resource was not found." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested resource was not found.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "429": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "rate_limited", "message": "You have exceeded the rate limit. Please slow down." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "You have exceeded the rate limit. Please slow down.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Retry-After": { "$ref": "#/components/headers/RetryAfter" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "500": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "server_error", "message": "An unexpected error occurred" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "501": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "not_implemented", "message": "The requested operation is not implemented." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested operation is not implemented.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } } }, "security": [ { "BearerAuth": [] } ], "summary": "Add a zoom to a clip", "tags": [ "Clips" ] } }, "/v1/videos/{id}/clips/{clipId}/zooms/auto": { "post": { "description": "Generates tracking zooms from the mouse clicks in the clip's screen recording — the API twin of the editor's \"Generate zooms\". Every click opens a zoom window; nearby windows are merged. Requires the clip to contain a screen recording; returns an empty list when it has no usable mouse clicks.", "operationId": "generateAutoZooms", "parameters": [ { "description": "Video identifier", "in": "path", "name": "id", "required": true, "schema": { "description": "Video identifier", "example": "vid_abc123def456", "type": "string" } }, { "description": "Clip identifier", "in": "path", "name": "clipId", "required": true, "schema": { "description": "Clip identifier", "example": "cl_xyz789ghi012", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GenerateAutoZoomsRequest" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GenerateAutoZoomsResponse" } } }, "description": "OK", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "400": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "bad_request", "message": "The request was malformed or contained invalid parameters." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request was malformed or contained invalid parameters.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "401": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "unauthorized", "message": "Authentication is required. Provide a valid API key." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required. Provide a valid API key.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "403": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "forbidden", "message": "You don't have permission to access this resource." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "You don't have permission to access this resource.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "404": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "not_found", "message": "The requested resource was not found." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested resource was not found.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "429": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "rate_limited", "message": "You have exceeded the rate limit. Please slow down." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "You have exceeded the rate limit. Please slow down.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Retry-After": { "$ref": "#/components/headers/RetryAfter" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "500": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "server_error", "message": "An unexpected error occurred" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "501": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "not_implemented", "message": "The requested operation is not implemented." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested operation is not implemented.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } } }, "security": [ { "BearerAuth": [] } ], "summary": "Auto-generate zooms from mouse activity", "tags": [ "Clips" ] } }, "/v1/videos/{id}/clips/{clipId}/zooms/{zoomId}": { "delete": { "description": "Removes a zoom effect from a clip.", "operationId": "removeClipZoom", "parameters": [ { "description": "Video ID", "in": "path", "name": "id", "required": true, "schema": { "description": "Video ID", "type": "string" } }, { "description": "Clip ID", "in": "path", "name": "clipId", "required": true, "schema": { "description": "Clip ID", "type": "string" } }, { "description": "Zoom ID", "in": "path", "name": "zoomId", "required": true, "schema": { "description": "Zoom ID", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } }, "description": "Zoom removed", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "400": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "bad_request", "message": "The request was malformed or contained invalid parameters." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request was malformed or contained invalid parameters.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "401": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "unauthorized", "message": "Authentication is required. Provide a valid API key." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required. Provide a valid API key.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "403": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "forbidden", "message": "You don't have permission to access this resource." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "You don't have permission to access this resource.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "404": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "not_found", "message": "The requested resource was not found." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested resource was not found.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "429": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "rate_limited", "message": "You have exceeded the rate limit. Please slow down." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "You have exceeded the rate limit. Please slow down.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Retry-After": { "$ref": "#/components/headers/RetryAfter" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "500": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "server_error", "message": "An unexpected error occurred" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "501": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "not_implemented", "message": "The requested operation is not implemented." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested operation is not implemented.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } } }, "security": [ { "BearerAuth": [] } ], "summary": "Remove a zoom", "tags": [ "Clips" ] }, "patch": { "description": "Update a zoom's type, timing, focus point, or scale. Only the fields you send are changed.", "operationId": "updateClipZoom", "parameters": [ { "description": "Video ID", "in": "path", "name": "id", "required": true, "schema": { "description": "Video ID", "type": "string" } }, { "description": "Clip ID", "in": "path", "name": "clipId", "required": true, "schema": { "description": "Clip ID", "type": "string" } }, { "description": "Zoom ID", "in": "path", "name": "zoomId", "required": true, "schema": { "description": "Zoom ID", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateClipZoomRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClipZoomResponse" } } }, "description": "OK", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "400": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "bad_request", "message": "The request was malformed or contained invalid parameters." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request was malformed or contained invalid parameters.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "401": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "unauthorized", "message": "Authentication is required. Provide a valid API key." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required. Provide a valid API key.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "403": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "forbidden", "message": "You don't have permission to access this resource." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "You don't have permission to access this resource.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "404": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "not_found", "message": "The requested resource was not found." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested resource was not found.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "429": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "rate_limited", "message": "You have exceeded the rate limit. Please slow down." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "You have exceeded the rate limit. Please slow down.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Retry-After": { "$ref": "#/components/headers/RetryAfter" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "500": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "server_error", "message": "An unexpected error occurred" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "501": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "not_implemented", "message": "The requested operation is not implemented." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested operation is not implemented.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } } }, "security": [ { "BearerAuth": [] } ], "summary": "Update a zoom", "tags": [ "Clips" ] } }, "/v1/videos/{id}/collaborators": { "post": { "description": "Grants access to a video for the specified user. The user must be a member of your workspace.", "operationId": "addCollaboratorToVideo", "parameters": [ { "description": "Unique video identifier", "in": "path", "name": "id", "required": true, "schema": { "description": "Unique video identifier", "example": "vid_abc123def456", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddCollaboratorRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddCollaboratorResponse" } } }, "description": "Collaborator added successfully", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "400": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "bad_request", "message": "The request was malformed or contained invalid parameters." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request was malformed or contained invalid parameters.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "401": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "unauthorized", "message": "Authentication is required. Provide a valid API key." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required. Provide a valid API key.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "403": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "forbidden", "message": "You don't have permission to access this resource." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "You don't have permission to access this resource.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "404": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "not_found", "message": "The requested resource was not found." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested resource was not found.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "429": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "rate_limited", "message": "You have exceeded the rate limit. Please slow down." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "You have exceeded the rate limit. Please slow down.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Retry-After": { "$ref": "#/components/headers/RetryAfter" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "500": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "server_error", "message": "An unexpected error occurred" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "501": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "not_implemented", "message": "The requested operation is not implemented." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested operation is not implemented.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } } }, "security": [ { "BearerAuth": [] } ], "summary": "Add a collaborator to a video", "tags": [ "Videos" ] } }, "/v1/videos/{id}/duplicate": { "post": { "description": "Creates a copy of the specified video. Optionally specify a new name for the duplicate.", "operationId": "duplicateVideo", "parameters": [ { "description": "Unique video identifier", "in": "path", "name": "id", "required": true, "schema": { "description": "Unique video identifier", "example": "vid_abc123def456", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DuplicateVideoRequest" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "video": { "$ref": "#/components/schemas/VideoDetail" } }, "required": [ "video" ], "type": "object" } } }, "description": "OK", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "400": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "bad_request", "message": "The request was malformed or contained invalid parameters." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request was malformed or contained invalid parameters.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "401": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "unauthorized", "message": "Authentication is required. Provide a valid API key." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required. Provide a valid API key.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "403": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "forbidden", "message": "You don't have permission to access this resource." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "You don't have permission to access this resource.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "404": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "not_found", "message": "The requested resource was not found." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested resource was not found.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "429": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "rate_limited", "message": "You have exceeded the rate limit. Please slow down." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "You have exceeded the rate limit. Please slow down.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Retry-After": { "$ref": "#/components/headers/RetryAfter" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "500": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "server_error", "message": "An unexpected error occurred" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "501": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "not_implemented", "message": "The requested operation is not implemented." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested operation is not implemented.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } } }, "security": [ { "BearerAuth": [] } ], "summary": "Duplicate a video", "tags": [ "Videos" ] } }, "/v1/videos/{id}/edits": { "post": { "description": "Adds up to 200 sound effects, text overlays, zooms, blurs, highlights, and image/video overlays across clips in one video. Operations run in array order and commit as one editor revision. Use this instead of repeated single-add requests.", "operationId": "applyVideoEdits", "parameters": [ { "description": "Unique video identifier", "in": "path", "name": "id", "required": true, "schema": { "description": "Unique video identifier", "example": "vid_abc123def456", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApplyVideoEditsRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApplyVideoEditsResponse" } } }, "description": "Edits applied", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "400": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "bad_request", "message": "The request was malformed or contained invalid parameters." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request was malformed or contained invalid parameters.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "401": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "unauthorized", "message": "Authentication is required. Provide a valid API key." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required. Provide a valid API key.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "403": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "forbidden", "message": "You don't have permission to access this resource." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "You don't have permission to access this resource.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "404": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "not_found", "message": "The requested resource was not found." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested resource was not found.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "429": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "rate_limited", "message": "You have exceeded the rate limit. Please slow down." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "You have exceeded the rate limit. Please slow down.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Retry-After": { "$ref": "#/components/headers/RetryAfter" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "500": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "server_error", "message": "An unexpected error occurred" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "501": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "not_implemented", "message": "The requested operation is not implemented." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested operation is not implemented.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } } }, "security": [ { "BearerAuth": [] } ], "summary": "Apply many video edits", "tags": [ "Videos" ] } }, "/v1/videos/{id}/exports": { "get": { "description": "Lists all exports for the specified video with their current status, progress, and download URL when ready. Requires edit access to the video, or viewer access to a video with downloads (or raw downloads) enabled.", "operationId": "listVideoExports", "parameters": [ { "description": "Unique video identifier", "in": "path", "name": "id", "required": true, "schema": { "description": "Unique video identifier", "example": "vid_abc123def456", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListExportsResponse" } } }, "description": "OK", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "400": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "bad_request", "message": "The request was malformed or contained invalid parameters." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request was malformed or contained invalid parameters.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "401": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "unauthorized", "message": "Authentication is required. Provide a valid API key." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required. Provide a valid API key.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "403": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "forbidden", "message": "You don't have permission to access this resource." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "You don't have permission to access this resource.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "404": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "not_found", "message": "The requested resource was not found." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested resource was not found.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "429": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "rate_limited", "message": "You have exceeded the rate limit. Please slow down." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "You have exceeded the rate limit. Please slow down.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Retry-After": { "$ref": "#/components/headers/RetryAfter" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "500": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "server_error", "message": "An unexpected error occurred" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "501": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "not_implemented", "message": "The requested operation is not implemented." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested operation is not implemented.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } } }, "security": [ { "BearerAuth": [] } ], "summary": "List video exports", "tags": [ "Videos" ] }, "post": { "description": "Starts an export of the specified video. Export processing is asynchronous: poll GET /v1/videos/{id}/exports/{exportId} for status and a download URL, or listen for the export.ready webhook. Creators and editors can always export. Viewers can only start an export if the video's download settings allow it: `video` and `clips` granularity require downloads to be enabled; `tracks` and `raw` require both downloads and raw downloads to be enabled.", "operationId": "exportVideo", "parameters": [ { "description": "Unique video identifier", "in": "path", "name": "id", "required": true, "schema": { "description": "Unique video identifier", "example": "vid_abc123def456", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExportVideoRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExportVideoResponse" } } }, "description": "OK", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "400": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "bad_request", "message": "The request was malformed or contained invalid parameters." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request was malformed or contained invalid parameters.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "401": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "unauthorized", "message": "Authentication is required. Provide a valid API key." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required. Provide a valid API key.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "403": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "forbidden", "message": "You don't have permission to access this resource." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "You don't have permission to access this resource.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "404": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "not_found", "message": "The requested resource was not found." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested resource was not found.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "429": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "rate_limited", "message": "You have exceeded the rate limit. Please slow down." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "You have exceeded the rate limit. Please slow down.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Retry-After": { "$ref": "#/components/headers/RetryAfter" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "500": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "server_error", "message": "An unexpected error occurred" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "501": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "not_implemented", "message": "The requested operation is not implemented." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested operation is not implemented.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } } }, "security": [ { "BearerAuth": [] } ], "summary": "Start a video export", "tags": [ "Videos" ] } }, "/v1/videos/{id}/exports/{exportId}": { "get": { "description": "Returns the current status and progress of an export. The download URL appears when the export is complete. The export ID contains slashes and must be percent-encoded as a single path segment. Requires edit access to the video, or viewer access to a video with downloads (or raw downloads) enabled.", "operationId": "getVideoExport", "parameters": [ { "description": "Unique video identifier", "in": "path", "name": "id", "required": true, "schema": { "description": "Unique video identifier", "example": "vid_abc123def456", "type": "string" } }, { "description": "Export identifier returned when the export was started. The identifier contains slashes and must be encoded as a single path segment when constructing a URL manually.", "in": "path", "name": "exportId", "required": true, "schema": { "description": "Export identifier returned when the export was started. The identifier contains slashes and must be encoded as a single path segment when constructing a URL manually.", "example": "Export-Story-vid_abc123def456/2026-01-15T10:00:00Z/Story/1920x1080/30FPS", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetExportResponse" } } }, "description": "OK", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "400": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "bad_request", "message": "The request was malformed or contained invalid parameters." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request was malformed or contained invalid parameters.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "401": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "unauthorized", "message": "Authentication is required. Provide a valid API key." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required. Provide a valid API key.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "403": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "forbidden", "message": "You don't have permission to access this resource." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "You don't have permission to access this resource.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "404": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "not_found", "message": "The requested resource was not found." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested resource was not found.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "429": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "rate_limited", "message": "You have exceeded the rate limit. Please slow down." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "You have exceeded the rate limit. Please slow down.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Retry-After": { "$ref": "#/components/headers/RetryAfter" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "500": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "server_error", "message": "An unexpected error occurred" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "501": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "not_implemented", "message": "The requested operation is not implemented." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested operation is not implemented.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } } }, "security": [ { "BearerAuth": [] } ], "summary": "Get video export status", "tags": [ "Videos" ] } }, "/v1/videos/{id}/storyboard": { "get": { "description": "Returns a signed 4x4 WebP storyboard whose 16 tiles are sampled evenly across the requested window (`durationMs`/16 apart; every 5 seconds for the default 80s window) on the video's playback timeline (cuts applied, cumulative across clips). Only `startTimeMs` and `durationMs` control the storyboard; tile count, dimensions, and format are fixed. By default returns a 302 redirect — set `?response=json` to get `{url}` JSON instead.", "operationId": "getVideoStoryboard", "parameters": [ { "description": "Unique video identifier", "in": "path", "name": "id", "required": true, "schema": { "description": "Unique video identifier", "example": "vid_abc123def456", "type": "string" } }, { "description": "Start time in ms on the selected target's playback timeline. Defaults to 0.", "in": "query", "name": "startTimeMs", "schema": { "description": "Start time in ms on the selected target's playback timeline. Defaults to 0.", "example": 1000, "maximum": 2147483647, "minimum": 0, "type": "integer" } }, { "description": "Storyboard window duration in ms. Defaults to 80000; the selected target's remaining duration may shorten it. Pass the target's full duration to sample it end to end.", "in": "query", "name": "durationMs", "schema": { "description": "Storyboard window duration in ms. Defaults to 80000; the selected target's remaining duration may shorten it. Pass the target's full duration to sample it end to end.", "example": 30000, "maximum": 2147483647, "minimum": 1, "type": "integer" } }, { "description": "Set to 'json' to receive `{url}` instead of the default 302 redirect.", "in": "query", "name": "response", "schema": { "description": "Set to 'json' to receive `{url}` instead of the default 302 redirect.", "enum": [ "json" ], "example": "json", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StoryboardResponse" } } }, "description": "Returned when `?response=json` is set", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "302": { "description": "Redirect to the signed storyboard URL", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "400": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "bad_request", "message": "The request was malformed or contained invalid parameters." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request was malformed or contained invalid parameters.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "401": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "unauthorized", "message": "Authentication is required. Provide a valid API key." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required. Provide a valid API key.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "403": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "forbidden", "message": "You don't have permission to access this resource." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "You don't have permission to access this resource.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "404": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "not_found", "message": "The requested resource was not found." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested resource was not found.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "429": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "rate_limited", "message": "You have exceeded the rate limit. Please slow down." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "You have exceeded the rate limit. Please slow down.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Retry-After": { "$ref": "#/components/headers/RetryAfter" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "500": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "server_error", "message": "An unexpected error occurred" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "501": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "not_implemented", "message": "The requested operation is not implemented." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested operation is not implemented.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } } }, "security": [ { "BearerAuth": [] } ], "summary": "Get a video storyboard", "tags": [ "Videos" ] } }, "/v1/videos/{id}/tags": { "get": { "description": "Returns the tags on a video that are visible to the authenticated user", "operationId": "listVideoTags", "parameters": [ { "description": "Unique video identifier", "in": "path", "name": "id", "required": true, "schema": { "description": "Unique video identifier", "example": "vid_abc123def456", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListVideoTagsResponse" } } }, "description": "OK", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "400": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "bad_request", "message": "The request was malformed or contained invalid parameters." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request was malformed or contained invalid parameters.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "401": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "unauthorized", "message": "Authentication is required. Provide a valid API key." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required. Provide a valid API key.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "403": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "forbidden", "message": "You don't have permission to access this resource." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "You don't have permission to access this resource.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "404": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "not_found", "message": "The requested resource was not found." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested resource was not found.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "429": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "rate_limited", "message": "You have exceeded the rate limit. Please slow down." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "You have exceeded the rate limit. Please slow down.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Retry-After": { "$ref": "#/components/headers/RetryAfter" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "500": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "server_error", "message": "An unexpected error occurred" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "501": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "not_implemented", "message": "The requested operation is not implemented." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested operation is not implemented.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } } }, "security": [ { "BearerAuth": [] } ], "summary": "List a video's tags", "tags": [ "Tags" ] }, "post": { "description": "Tag a video. Requires edit access to the video. Adding a private tag only affects the authenticated user's library.", "operationId": "addVideoTag", "parameters": [ { "description": "Unique video identifier", "in": "path", "name": "id", "required": true, "schema": { "description": "Unique video identifier", "example": "vid_abc123def456", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddVideoTagRequest" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } }, "description": "Tag added to video", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "400": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "bad_request", "message": "The request was malformed or contained invalid parameters." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request was malformed or contained invalid parameters.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "401": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "unauthorized", "message": "Authentication is required. Provide a valid API key." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required. Provide a valid API key.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "403": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "forbidden", "message": "You don't have permission to access this resource." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "You don't have permission to access this resource.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "404": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "not_found", "message": "The requested resource was not found." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested resource was not found.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "429": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "rate_limited", "message": "You have exceeded the rate limit. Please slow down." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "You have exceeded the rate limit. Please slow down.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Retry-After": { "$ref": "#/components/headers/RetryAfter" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "500": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "server_error", "message": "An unexpected error occurred" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "501": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "not_implemented", "message": "The requested operation is not implemented." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested operation is not implemented.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } } }, "security": [ { "BearerAuth": [] } ], "summary": "Add a tag to a video", "tags": [ "Tags" ] } }, "/v1/videos/{id}/tags/{tagId}": { "delete": { "description": "Untag a video. Requires edit access to the video. Private tags can only be removed by their owner.", "operationId": "removeVideoTag", "parameters": [ { "description": "Video ID", "in": "path", "name": "id", "required": true, "schema": { "description": "Video ID", "example": "vid_abc123def456", "type": "string" } }, { "description": "Tag ID", "in": "path", "name": "tagId", "required": true, "schema": { "description": "Tag ID", "example": "tag_abc123def456", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } }, "description": "Tag removed from video", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "400": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "bad_request", "message": "The request was malformed or contained invalid parameters." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request was malformed or contained invalid parameters.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "401": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "unauthorized", "message": "Authentication is required. Provide a valid API key." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required. Provide a valid API key.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "403": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "forbidden", "message": "You don't have permission to access this resource." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "You don't have permission to access this resource.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "404": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "not_found", "message": "The requested resource was not found." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested resource was not found.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "429": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "rate_limited", "message": "You have exceeded the rate limit. Please slow down." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "You have exceeded the rate limit. Please slow down.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Retry-After": { "$ref": "#/components/headers/RetryAfter" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "500": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "server_error", "message": "An unexpected error occurred" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "501": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "not_implemented", "message": "The requested operation is not implemented." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested operation is not implemented.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } } }, "security": [ { "BearerAuth": [] } ], "summary": "Remove a tag from a video", "tags": [ "Tags" ] } }, "/v1/videos/{id}/thumbnail": { "delete": { "description": "Removes the custom thumbnail (uploaded image or picked frame) and reverts the video to its default auto-generated thumbnail.", "operationId": "removeVideoThumbnail", "parameters": [ { "description": "Unique video identifier", "in": "path", "name": "id", "required": true, "schema": { "description": "Unique video identifier", "example": "vid_abc123def456", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "status": { "description": "Operation status", "enum": [ "ok" ], "example": "ok", "type": "string" } }, "required": [ "status" ], "type": "object" } } }, "description": "Thumbnail reset to default", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "400": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "bad_request", "message": "The request was malformed or contained invalid parameters." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request was malformed or contained invalid parameters.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "401": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "unauthorized", "message": "Authentication is required. Provide a valid API key." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required. Provide a valid API key.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "403": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "forbidden", "message": "You don't have permission to access this resource." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "You don't have permission to access this resource.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "404": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "not_found", "message": "The requested resource was not found." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested resource was not found.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "429": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "rate_limited", "message": "You have exceeded the rate limit. Please slow down." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "You have exceeded the rate limit. Please slow down.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Retry-After": { "$ref": "#/components/headers/RetryAfter" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "500": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "server_error", "message": "An unexpected error occurred" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "501": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "not_implemented", "message": "The requested operation is not implemented." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested operation is not implemented.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } } }, "security": [ { "BearerAuth": [] } ], "summary": "Remove a video's custom thumbnail", "tags": [ "Videos" ] }, "get": { "description": "Returns a signed CDN URL for a still image (jpg/png/webp) or animated preview (gif/mp4) of a video at a time on the video's playback timeline (cuts applied, cumulative across clips). By default returns a 302 redirect — set `?response=json` to get `{url}` JSON instead.", "operationId": "getVideoThumbnail", "parameters": [ { "description": "Unique video identifier", "in": "path", "name": "id", "required": true, "schema": { "description": "Unique video identifier", "example": "vid_abc123def456", "type": "string" } }, { "description": "Output format. Defaults to jpg.", "in": "query", "name": "format", "schema": { "description": "Output format. Defaults to jpg.", "enum": [ "jpg", "png", "webp", "gif", "mp4" ], "example": "jpg", "type": "string" } }, { "description": "Frame offset in ms on the playback timeline (cuts applied) — clip-relative for the clip thumbnail, video-relative (cumulative across clips) for the video thumbnail. Defaults to 0.", "in": "query", "name": "inpointMs", "schema": { "description": "Frame offset in ms on the playback timeline (cuts applied) — clip-relative for the clip thumbnail, video-relative (cumulative across clips) for the video thumbnail. Defaults to 0.", "example": 1000, "maximum": 9007199254740991, "minimum": 0, "type": "integer" } }, { "description": "Duration of the animated preview in ms. Only valid when format is gif or mp4.", "in": "query", "name": "durationMs", "schema": { "description": "Duration of the animated preview in ms. Only valid when format is gif or mp4.", "example": 3000, "exclusiveMinimum": true, "maximum": 9007199254740991, "minimum": 0, "type": "integer" } }, { "description": "Frame rate for MP4 previews. Must be 1, 2, 5, 10, or 30. Defaults to 30.", "in": "query", "name": "fps", "schema": { "description": "Frame rate for MP4 previews. Must be 1, 2, 5, 10, or 30. Defaults to 30.", "example": 10, "type": "number" } }, { "description": "Output width in pixels. The thumbnail keeps the video's aspect ratio; a missing side is derived from it.", "in": "query", "name": "width", "schema": { "description": "Output width in pixels. The thumbnail keeps the video's aspect ratio; a missing side is derived from it.", "example": 1280, "exclusiveMinimum": true, "maximum": 9007199254740991, "minimum": 0, "type": "integer" } }, { "description": "Output height in pixels. Derived from the video's aspect ratio when omitted.", "in": "query", "name": "height", "schema": { "description": "Output height in pixels. Derived from the video's aspect ratio when omitted.", "example": 720, "exclusiveMinimum": true, "maximum": 9007199254740991, "minimum": 0, "type": "integer" } }, { "description": "Suggest a download disposition on the signed URL.", "in": "query", "name": "download", "schema": { "anyOf": [ { "enum": [ "true" ], "type": "string" }, { "enum": [ "false" ], "type": "string" } ], "description": "Suggest a download disposition on the signed URL.", "example": "false" } }, { "description": "Set to 'json' to receive `{url}` instead of the default 302 redirect.", "in": "query", "name": "response", "schema": { "description": "Set to 'json' to receive `{url}` instead of the default 302 redirect.", "enum": [ "json" ], "example": "json", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ThumbnailResponse" } } }, "description": "Returned when `?response=json` is set", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "302": { "description": "Redirect to the signed CDN URL", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "400": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "bad_request", "message": "The request was malformed or contained invalid parameters." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request was malformed or contained invalid parameters.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "401": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "unauthorized", "message": "Authentication is required. Provide a valid API key." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required. Provide a valid API key.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "403": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "forbidden", "message": "You don't have permission to access this resource." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "You don't have permission to access this resource.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "404": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "not_found", "message": "The requested resource was not found." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested resource was not found.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "429": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "rate_limited", "message": "You have exceeded the rate limit. Please slow down." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "You have exceeded the rate limit. Please slow down.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Retry-After": { "$ref": "#/components/headers/RetryAfter" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "500": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "server_error", "message": "An unexpected error occurred" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "501": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "not_implemented", "message": "The requested operation is not implemented." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested operation is not implemented.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } } }, "security": [ { "BearerAuth": [] } ], "summary": "Get a video thumbnail or animated preview", "tags": [ "Videos" ] }, "put": { "description": "Sets the video's thumbnail from either an uploaded image or a frame of the video itself. Provide exactly one of `sourceId` (an image source from `POST /v1/sources` with `kind: \"image\"` — upload the image bytes to its `uploadUrl` first) or `inpointMs` (a time on the video's playback timeline). Setting one mode clears the other.", "operationId": "setVideoThumbnail", "parameters": [ { "description": "Unique video identifier", "in": "path", "name": "id", "required": true, "schema": { "description": "Unique video identifier", "example": "vid_abc123def456", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetVideoThumbnailRequest" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetVideoThumbnailResponse" } } }, "description": "Thumbnail set successfully", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "400": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "bad_request", "message": "The request was malformed or contained invalid parameters." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request was malformed or contained invalid parameters.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "401": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "unauthorized", "message": "Authentication is required. Provide a valid API key." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required. Provide a valid API key.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "403": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "forbidden", "message": "You don't have permission to access this resource." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "You don't have permission to access this resource.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "404": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "not_found", "message": "The requested resource was not found." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested resource was not found.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "429": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "rate_limited", "message": "You have exceeded the rate limit. Please slow down." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "You have exceeded the rate limit. Please slow down.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Retry-After": { "$ref": "#/components/headers/RetryAfter" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "500": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "server_error", "message": "An unexpected error occurred" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "501": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "not_implemented", "message": "The requested operation is not implemented." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested operation is not implemented.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } } }, "security": [ { "BearerAuth": [] } ], "summary": "Set a video's thumbnail", "tags": [ "Videos" ] } }, "/v1/videos/{id}/timeline": { "get": { "description": "Returns a compact ordered timeline outline by default: video identity, version, dimensions and duration plus every clip's video-timeline start, playback duration and content counts. Use `include` to fetch specific video or clip details, optionally scoped by `clipIds`; the complete outline remains in every response. Use `include=all` for the complete edit state. Effect and word times are ms on each clip's playback timeline (cuts applied). Raw cuts retain the source-recording timing used by the clip endpoints.", "operationId": "getVideoTimeline", "parameters": [ { "description": "Unique video identifier", "in": "path", "name": "id", "required": true, "schema": { "description": "Unique video identifier", "example": "vid_abc123def456", "type": "string" } }, { "description": "Comma-separated clip IDs to return details for. The complete ordered clip outline is always returned.", "in": "query", "name": "clipIds", "schema": { "description": "Comma-separated clip IDs to return details for. The complete ordered clip outline is always returned.", "example": "scn_abc123,scn_def456", "type": "string" } }, { "description": "Comma-separated details to include: all, settings, chapters, backgroundMusic, clipSettings, cuts, layouts, zooms, blurs, highlights, overlays, textOverlays, soundEffects, transcript, words. Default: none.", "in": "query", "name": "include", "schema": { "description": "Comma-separated details to include: all, settings, chapters, backgroundMusic, clipSettings, cuts, layouts, zooms, blurs, highlights, overlays, textOverlays, soundEffects, transcript, words. Default: none.", "example": "layouts,zooms,words", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTimelineResponse" } } }, "description": "The video's edit state", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "400": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "bad_request", "message": "The request was malformed or contained invalid parameters." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request was malformed or contained invalid parameters.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "401": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "unauthorized", "message": "Authentication is required. Provide a valid API key." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required. Provide a valid API key.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "403": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "forbidden", "message": "You don't have permission to access this resource." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "You don't have permission to access this resource.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "404": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "not_found", "message": "The requested resource was not found." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested resource was not found.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "429": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "rate_limited", "message": "You have exceeded the rate limit. Please slow down." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "You have exceeded the rate limit. Please slow down.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Retry-After": { "$ref": "#/components/headers/RetryAfter" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "500": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "server_error", "message": "An unexpected error occurred" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "501": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "not_implemented", "message": "The requested operation is not implemented." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested operation is not implemented.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } } }, "security": [ { "BearerAuth": [] } ], "summary": "Get a video's timeline", "tags": [ "Videos" ] } }, "/v1/webhooks/endpoints": { "get": { "description": "Lists the webhook subscriptions owned by the authenticated API key's user. Endpoints are scoped per user rather than shared across the workspace. Events are routed to the user context that emits them; playlist.video_added is delivered to the user who adds the video, who may be a playlist editor rather than its owner.", "operationId": "listWebhookEndpoints", "parameters": [ { "description": "Pagination cursor returned by the previous request", "in": "query", "name": "cursor", "schema": { "description": "Pagination cursor returned by the previous request", "type": "string" } }, { "description": "Maximum endpoints to return (default: 20, max: 100)", "in": "query", "name": "limit", "schema": { "description": "Maximum endpoints to return (default: 20, max: 100)", "example": 20, "maximum": 100, "minimum": 1, "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListWebhookEndpointsResponse" } } }, "description": "A page of webhook endpoints", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "400": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "bad_request", "message": "The request was malformed or contained invalid parameters." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request was malformed or contained invalid parameters.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "401": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "unauthorized", "message": "Authentication is required. Provide a valid API key." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required. Provide a valid API key.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "403": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "forbidden", "message": "You don't have permission to access this resource." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "You don't have permission to access this resource.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "404": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "not_found", "message": "The requested resource was not found." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested resource was not found.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "429": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "rate_limited", "message": "You have exceeded the rate limit. Please slow down." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "You have exceeded the rate limit. Please slow down.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Retry-After": { "$ref": "#/components/headers/RetryAfter" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "500": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "server_error", "message": "An unexpected error occurred" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "501": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "not_implemented", "message": "The requested operation is not implemented." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested operation is not implemented.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } } }, "security": [ { "BearerAuth": [] } ], "summary": "List webhook endpoints", "tags": [ "Webhooks" ] }, "post": { "description": "Creates a new webhook endpoint owned by the authenticated API key's user. Events are routed to the user context that emits them; playlist.video_added is delivered to the user who adds the video, who may be a playlist editor rather than its owner. Returns the endpoint ID and signing secret.", "operationId": "createWebhookEndpoint", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateEndpointRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateEndpointResponse" } } }, "description": "Endpoint created successfully", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "400": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "bad_request", "message": "The request was malformed or contained invalid parameters." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request was malformed or contained invalid parameters.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "401": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "unauthorized", "message": "Authentication is required. Provide a valid API key." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required. Provide a valid API key.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "403": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "forbidden", "message": "You don't have permission to access this resource." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "You don't have permission to access this resource.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "404": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "not_found", "message": "The requested resource was not found." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested resource was not found.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "429": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "rate_limited", "message": "You have exceeded the rate limit. Please slow down." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "You have exceeded the rate limit. Please slow down.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Retry-After": { "$ref": "#/components/headers/RetryAfter" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "500": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "server_error", "message": "An unexpected error occurred" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "501": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "not_implemented", "message": "The requested operation is not implemented." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested operation is not implemented.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } } }, "security": [ { "BearerAuth": [] } ], "summary": "Create a webhook endpoint", "tags": [ "Webhooks" ] } }, "/v1/webhooks/endpoints/{id}": { "delete": { "description": "Permanently deletes a webhook endpoint", "operationId": "deleteWebhookEndpoint", "parameters": [ { "description": "The webhook endpoint ID", "in": "path", "name": "id", "required": true, "schema": { "description": "The webhook endpoint ID", "example": "ep_abc123def456", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteEndpointResponse" } } }, "description": "Endpoint deleted successfully", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "400": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "bad_request", "message": "The request was malformed or contained invalid parameters." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request was malformed or contained invalid parameters.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "401": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "unauthorized", "message": "Authentication is required. Provide a valid API key." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required. Provide a valid API key.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "403": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "forbidden", "message": "You don't have permission to access this resource." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "You don't have permission to access this resource.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "404": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "not_found", "message": "The requested resource was not found." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested resource was not found.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "429": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "rate_limited", "message": "You have exceeded the rate limit. Please slow down." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "You have exceeded the rate limit. Please slow down.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Retry-After": { "$ref": "#/components/headers/RetryAfter" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "500": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "server_error", "message": "An unexpected error occurred" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "501": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "not_implemented", "message": "The requested operation is not implemented." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested operation is not implemented.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } } }, "security": [ { "BearerAuth": [] } ], "summary": "Delete a webhook endpoint", "tags": [ "Webhooks" ] }, "patch": { "description": "Updates the delivery URL, subscribed event types, or delivery status for a webhook endpoint.", "operationId": "updateWebhookEndpoint", "parameters": [ { "description": "The webhook endpoint ID", "in": "path", "name": "id", "required": true, "schema": { "description": "The webhook endpoint ID", "example": "ep_abc123def456", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateWebhookEndpointRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateWebhookEndpointResponse" } } }, "description": "Endpoint updated successfully", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "400": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "bad_request", "message": "The request was malformed or contained invalid parameters." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request was malformed or contained invalid parameters.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "401": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "unauthorized", "message": "Authentication is required. Provide a valid API key." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required. Provide a valid API key.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "403": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "forbidden", "message": "You don't have permission to access this resource." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "You don't have permission to access this resource.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "404": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "not_found", "message": "The requested resource was not found." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested resource was not found.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "429": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "rate_limited", "message": "You have exceeded the rate limit. Please slow down." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "You have exceeded the rate limit. Please slow down.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Retry-After": { "$ref": "#/components/headers/RetryAfter" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "500": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "server_error", "message": "An unexpected error occurred" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "501": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "not_implemented", "message": "The requested operation is not implemented." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested operation is not implemented.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } } }, "security": [ { "BearerAuth": [] } ], "summary": "Update a webhook endpoint", "tags": [ "Webhooks" ] } }, "/v1/webhooks/endpoints/{id}/secret": { "get": { "description": "Retrieves the signing secret for a webhook endpoint. Use this to verify incoming webhook payloads.", "operationId": "getWebhookEndpointSecret", "parameters": [ { "description": "The webhook endpoint ID", "in": "path", "name": "id", "required": true, "schema": { "description": "The webhook endpoint ID", "example": "ep_abc123def456", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EndpointSecretResponse" } } }, "description": "OK", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "400": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "bad_request", "message": "The request was malformed or contained invalid parameters." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request was malformed or contained invalid parameters.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "401": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "unauthorized", "message": "Authentication is required. Provide a valid API key." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required. Provide a valid API key.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "403": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "forbidden", "message": "You don't have permission to access this resource." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "You don't have permission to access this resource.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "404": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "not_found", "message": "The requested resource was not found." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested resource was not found.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "429": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "rate_limited", "message": "You have exceeded the rate limit. Please slow down." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "You have exceeded the rate limit. Please slow down.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Retry-After": { "$ref": "#/components/headers/RetryAfter" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "500": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "server_error", "message": "An unexpected error occurred" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "501": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "not_implemented", "message": "The requested operation is not implemented." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested operation is not implemented.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } } }, "security": [ { "BearerAuth": [] } ], "summary": "Get endpoint signing secret", "tags": [ "Webhooks" ] } }, "/v1/webhooks/messages": { "get": { "description": "Returns a list of recently sent webhook messages for debugging purposes", "operationId": "listWebhookMessages", "parameters": [ { "description": "Comma-separated list of event types to filter by", "in": "query", "name": "event_types", "schema": { "description": "Comma-separated list of event types to filter by", "example": "video.created,export.ready", "type": "string" } }, { "description": "Maximum number of messages to return (default: 10)", "in": "query", "name": "limit", "schema": { "description": "Maximum number of messages to return (default: 10)", "example": 20, "type": "number" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListMessagesResponse" } } }, "description": "OK", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "400": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "bad_request", "message": "The request was malformed or contained invalid parameters." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request was malformed or contained invalid parameters.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "401": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "unauthorized", "message": "Authentication is required. Provide a valid API key." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required. Provide a valid API key.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "403": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "forbidden", "message": "You don't have permission to access this resource." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "You don't have permission to access this resource.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "404": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "not_found", "message": "The requested resource was not found." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested resource was not found.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "429": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "rate_limited", "message": "You have exceeded the rate limit. Please slow down." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "You have exceeded the rate limit. Please slow down.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Retry-After": { "$ref": "#/components/headers/RetryAfter" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "500": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "server_error", "message": "An unexpected error occurred" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "501": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "not_implemented", "message": "The requested operation is not implemented." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested operation is not implemented.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } } }, "security": [ { "BearerAuth": [] } ], "summary": "List recent webhook messages", "tags": [ "Webhooks" ] } }, "/v1/webhooks/messages/{id}": { "get": { "description": "Returns details of a specific webhook message by ID", "operationId": "getWebhookMessage", "parameters": [ { "description": "The webhook message ID", "in": "path", "name": "id", "required": true, "schema": { "description": "The webhook message ID", "example": "msg_abc123", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookMessage" } } }, "description": "OK", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "400": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "bad_request", "message": "The request was malformed or contained invalid parameters." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request was malformed or contained invalid parameters.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "401": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "unauthorized", "message": "Authentication is required. Provide a valid API key." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required. Provide a valid API key.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "403": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "forbidden", "message": "You don't have permission to access this resource." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "You don't have permission to access this resource.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "404": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "not_found", "message": "The requested resource was not found." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested resource was not found.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "429": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "rate_limited", "message": "You have exceeded the rate limit. Please slow down." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "You have exceeded the rate limit. Please slow down.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Retry-After": { "$ref": "#/components/headers/RetryAfter" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "500": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "server_error", "message": "An unexpected error occurred" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } }, "501": { "content": { "application/json": { "example": { "docsUrl": "https://docs.tella.com/", "error": "not_implemented", "message": "The requested operation is not implemented." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested operation is not implemented.", "headers": { "Deprecation": { "$ref": "#/components/headers/Deprecation" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimitPolicy" }, "Sunset": { "$ref": "#/components/headers/Sunset" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/XRateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/XRateLimitRemaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/XRateLimitReset" } } } }, "security": [ { "BearerAuth": [] } ], "summary": "Get a specific webhook message", "tags": [ "Webhooks" ] } } }, "servers": [ { "description": "Production", "url": "https://api.tella.com" } ], "tags": [ { "description": "Video operations", "name": "Videos" }, { "description": "Sections of a video", "name": "Clips" }, { "description": "Playlist operations", "name": "Playlists" }, { "description": "Sidebar groups for organizing playlists", "name": "Playlist Groups" }, { "description": "Tags for categorizing and filtering videos", "name": "Tags" }, { "description": "Personal, workspace, and default video backgrounds", "name": "Backgrounds" }, { "description": "Reusable media saved to a workspace, plus Tella's curated sound effect catalog — the same items the editor's media panels show", "name": "Library" }, { "description": "Webhook endpoint management", "name": "Webhooks" } ] }