--- updatedAt: 2026-07-30T09:27:20.000Z agentTools: siteIndex: https://developer.bitmovin.com/llms.txt projectIndex: https://developer.bitmovin.com/encoding/llms.txt --- # List VTT Media # OpenAPI definition ```json { "openapi": "3.0.1", "info": { "title": "VOD Encoding API", "description": "Bitmovins API Reference Description", "version": "3.0", "termsOfService": "https://bitmovin.com", "contact": { "name": "Bitmovin Inc", "url": "https://bitmovin.com", "email": "support@bitmovin.com" } }, "servers": [ { "url": "https://api.bitmovin.com/v1", "description": "Bitmovin Server", "variables": {} } ], "security": [ { "ApiKeyAuth": [] }, { "ApiKeyAuth": [], "TenantOrgId": [] } ], "paths": { "/encoding/manifests/hls/{manifest_id}/media/vtt": { "get": { "tags": [ "HLS Media" ], "summary": "List VTT Media", "operationId": "GetEncodingManifestsHlsMediaVttByManifestId", "x-bitmovin": { "product": "shared" }, "parameters": [ { "name": "offset", "in": "query", "description": "Index of the first item to return, starting at 0. Default is 0", "style": "form", "schema": { "type": "integer", "example": "0" } }, { "name": "limit", "in": "query", "description": "Maximum number of items to return. Default is 25, maximum is 100", "style": "form", "schema": { "type": "integer", "example": "25" } }, { "name": "manifest_id", "in": "path", "description": "Id of the hls manifest.", "style": "simple", "required": true, "schema": { "type": "string", "example": "cb90b80c-8867-4e3b-8479-174aa2843f62" } } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ResponseEnvelope" }, { "properties": { "data": { "properties": { "result": { "allOf": [ { "$ref": "#/components/schemas/PaginationResponse" }, { "properties": { "items": { "description": "VTT media", "items": { "$ref": "#/components/schemas/VttMediaInfo" } } } } ] } } } } } ] } } } }, "default": { "description": "Error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseError" } } } } } } } }, "components": { "securitySchemes": { "ApiKeyAuth": { "type": "apiKey", "description": "Your Bitmovin API key", "name": "X-Api-Key", "in": "header" }, "TenantOrgId": { "type": "apiKey", "description": "Your Bitmovin account organization", "name": "X-Tenant-Org-Id", "in": "header" } }, "schemas": { "BitmovinResponse": { "title": "BitmovinResponse", "required": [ "id" ], "properties": { "id": { "type": "string", "readOnly": true, "description": "Id of the resource", "example": "cb90b80c-8867-4e3b-8479-174aa2843f62" } } }, "BasicMediaInfo": { "title": "BasicMediaInfo", "required": [ "groupId", "name" ], "allOf": [ { "$ref": "#/components/schemas/BitmovinResponse" }, { "properties": { "groupId": { "type": "string", "description": "The value is a quoted-string which specifies the group to which the Rendition belongs.", "example": "audio_group" }, "language": { "type": "string", "description": "Primary language in the rendition.", "example": "en" }, "assocLanguage": { "type": "string", "description": "Identifies a language that is associated with the Rendition.", "example": "de" }, "name": { "type": "string", "description": "Human readable description of the rendition.", "example": "Rendition description" }, "isDefault": { "type": "boolean", "description": "If set to true, the client SHOULD play this Rendition of the content in the absence of information from the user.", "example": false }, "autoselect": { "type": "boolean", "description": "If set to true, the client MAY choose to play this Rendition in the absence of explicit user preference.", "example": false }, "characteristics": { "type": "array", "items": { "type": "string" }, "description": "Contains Uniform Type Identifiers", "example": [ "public.accessibility.describes-video" ] } } } ] }, "Link": { "title": "Link", "required": [ "href" ], "properties": { "href": { "type": "string", "description": "webpage target URL", "example": "https://bitmovin.com/encoding-documentation/bitmovin-api/#/reference/encoding/manifests/add-period" }, "title": { "type": "string", "description": "Short description of the linked page", "example": "how to add a period to a manifest" } } }, "Message": { "title": "Message", "required": [ "type", "text" ], "allOf": [ { "$ref": "#/components/schemas/BitmovinResponse" }, { "properties": { "type": { "description": "Message type giving a hint on the importance of the message (log level)", "allOf": [ { "$ref": "#/components/schemas/MessageType" } ] }, "text": { "type": "string", "description": "Message text", "example": "field must not be empty" }, "field": { "type": "string", "description": "Name of the field to which the message is referring to", "example": "manifestId" }, "links": { "type": "array", "items": { "$ref": "#/components/schemas/Link" }, "description": "collection of links to webpages containing further information on the topic" }, "more": { "type": "object", "description": "Service-specific information" }, "date": { "type": "string", "format": "date-time", "description": "Timestamp when the message occurred", "example": "2016-06-25T20:09:23.69Z" } } } ] }, "MessageType": { "title": "MessageType", "type": "string", "enum": [ "ERROR", "WARNING", "INFO", "DEBUG", "TRACE" ] }, "PaginationResponse": { "title": "PaginationResponse", "properties": { "totalCount": { "type": "integer", "format": "int64", "readOnly": true }, "offset": { "type": "integer", "format": "int32", "readOnly": true }, "limit": { "type": "integer", "format": "int32", "readOnly": true }, "previous": { "type": "string", "readOnly": true }, "next": { "type": "string", "readOnly": true }, "items": { "type": "array", "readOnly": true, "items": { "type": "object" } } } }, "ResponseEnvelope": { "title": "ResponseEnvelope", "required": [ "requestId", "status", "data" ], "properties": { "requestId": { "type": "string", "readOnly": true, "description": "Unique correlation id", "example": "6d84e126-d10c-4e52-bbfb-bd4c92bc8333" }, "status": { "description": "Response status information", "readOnly": true, "example": "SUCCESS", "allOf": [ { "$ref": "#/components/schemas/ResponseStatus" } ] }, "data": { "description": "Response information", "readOnly": true, "allOf": [ { "$ref": "#/components/schemas/ResultWrapper" } ] }, "more": { "type": "object", "description": "Additional endpoint specific information" } } }, "ResponseError": { "title": "ResponseError", "required": [ "requestId", "status", "data" ], "properties": { "requestId": { "type": "string", "readOnly": true, "description": "Unique correlation id", "example": "6d84e126-d10c-4e52-bbfb-bd4c92bc8333" }, "status": { "description": "Response status information", "readOnly": true, "example": "ERROR", "allOf": [ { "$ref": "#/components/schemas/ResponseStatus" } ] }, "data": { "description": "Response information", "readOnly": true, "allOf": [ { "$ref": "#/components/schemas/ResponseErrorData" } ] } } }, "ResponseErrorData": { "title": "ResponseErrorData", "required": [ "code", "message", "developerMessage" ], "properties": { "code": { "type": "integer", "format": "int32", "readOnly": true, "description": "Contains an error code as defined in https://bitmovin.com/encoding-documentation/bitmovin-api/#/introduction/api-error-codes\n", "example": 1005 }, "message": { "type": "string", "readOnly": true, "description": "General error message" }, "developerMessage": { "type": "string", "readOnly": true, "description": "More detailed message meant for developers" }, "links": { "type": "array", "readOnly": true, "items": { "$ref": "#/components/schemas/Link" }, "description": "collection of links to webpages containing further information on the topic" }, "details": { "type": "array", "readOnly": true, "items": { "$ref": "#/components/schemas/Message" }, "description": "collection of messages containing more detailed information on the cause of the error" } } }, "ResponseStatus": { "title": "ResponseStatus", "type": "string", "enum": [ "SUCCESS", "ERROR" ] }, "ResultWrapper": { "title": "ResultWrapper", "properties": { "result": { "type": "object", "readOnly": true } } }, "VttMediaInfo": { "title": "VttMediaInfo", "required": [ "vttUrl", "uri" ], "allOf": [ { "$ref": "#/components/schemas/BasicMediaInfo" }, { "properties": { "vttUrl": { "type": "string", "description": "The URL of the referenced VTT file", "example": "https://yourhost.com/path/mysubtitles.vtt" }, "uri": { "type": "string", "description": "The URI of the Rendition", "example": "mysubtitles.m3u8" }, "forced": { "type": "boolean", "description": "A value of true indicates that the Rendition contains content which is considered essential to play.", "example": false } } } ] } } }, "tags": [ { "name": "HLS Media" } ] } ```