--- updatedAt: 2026-07-30T09:19:26.000Z agentTools: siteIndex: https://developer.bitmovin.com/llms.txt projectIndex: https://developer.bitmovin.com/encoding/llms.txt --- # Get Thumbnail details # 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/encodings/{encoding_id}/streams/{stream_id}/thumbnails/{thumbnail_id}": { "get": { "tags": [ "Stream" ], "summary": "Get Thumbnail details", "operationId": "GetEncodingEncodingsStreamsThumbnailsByEncodingIdAndStreamIdAndThumbnailId", "x-bitmovin": { "product": "shared" }, "parameters": [ { "name": "encoding_id", "in": "path", "description": "Id of the encoding.", "style": "simple", "required": true, "schema": { "type": "string", "example": "f3177c2e-0000-4ba6-bd20-1dee353d8a72" } }, { "name": "stream_id", "in": "path", "description": "Id of the stream.", "style": "simple", "required": true, "schema": { "type": "string", "example": "a6336204-c929-4a61-b7a0-2cd6665114e9" } }, { "name": "thumbnail_id", "in": "path", "description": "Id of the thumbnail.", "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/Thumbnail" }, { "description": "Thumbnail details" } ] } } } } } ] } } } }, "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": { "BitmovinResource": { "title": "BitmovinResource", "allOf": [ { "$ref": "#/components/schemas/BitmovinResponse" }, { "properties": { "name": { "type": "string", "description": "Name of the resource. Can be freely chosen by the user.", "example": "Name of the resource" }, "description": { "type": "string", "description": "Description of the resource. Can be freely chosen by the user.", "example": "Description of the resource" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true, "description": "Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ", "example": "2016-06-25T20:09:23.69Z" }, "modifiedAt": { "type": "string", "format": "date-time", "readOnly": true, "description": "Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ", "example": "2016-06-25T20:09:23.69Z" }, "customData": { "type": "string", "writeOnly": true, "description": "User-specific meta data. This can hold anything.", "additionalProperties": { "type": "object" } } } } ] }, "BitmovinResponse": { "title": "BitmovinResponse", "required": [ "id" ], "properties": { "id": { "type": "string", "readOnly": true, "description": "Id of the resource", "example": "cb90b80c-8867-4e3b-8479-174aa2843f62" } } }, "AclEntry": { "title": "AclEntry", "required": [ "permission" ], "properties": { "scope": { "description": "Deprecation notice: The value of this property is not being used. It can be chosen arbitrarily or not set at all", "deprecated": true, "type": "string", "example": "public" }, "permission": { "description": "", "allOf": [ { "$ref": "#/components/schemas/AclPermission" } ] } } }, "AclPermission": { "title": "AclPermission", "type": "string", "enum": [ "PUBLIC_READ", "PRIVATE" ] }, "EncodingOutput": { "title": "EncodingOutput", "required": [ "outputId", "outputPath" ], "properties": { "outputId": { "type": "string", "description": "Id of the corresponding output", "example": "55354be6-0237-42bb-ae85-a2d4ef1ed19e" }, "outputPath": { "type": "string", "description": "Subdirectory where to save the files to", "example": "/encodings/movies/movie-1/video_720/" }, "acl": { "description": "Determines accessibility of files written to this output. Only applies to output types that support ACLs. Defaults to PUBLIC_READ if the list is empty. The destination (e.g. cloud storage bucket) needs to allow the configured ACL", "type": "array", "items": { "$ref": "#/components/schemas/AclEntry" } } } }, "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" ] }, "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 } } }, "Thumbnail": { "title": "Thumbnail", "required": [ "pattern", "outputs" ], "allOf": [ { "$ref": "#/components/schemas/BitmovinResource" }, { "properties": { "height": { "type": "integer", "format": "int32", "description": "Height of the thumbnail, either height or width are required fields. If only one is given the encoder will calculate the other way value based on the aspect ratio of the video file. If the encoder version is below 2.83.0 only height is supported and mandatory.\n", "example": 240 }, "width": { "type": "integer", "format": "int32", "description": "Width of the thumbnail, either height or width are required fields. If only one is given the encoder will calculate the other way value based on the aspect ratio of the video file. If the encoder version is below 2.83.0 only height is supported\n", "example": 320 }, "pattern": { "type": "string", "description": " Pattern which describes the thumbnail filenames. For example with thumbnail-%number%.png as pattern and 3 positions: thumbnail-3_0.png, thumbnail-5_0.png and thumbnail-25_5.png. (The number represents the position in the source video in seconds, in the previous example the first filename represents the thumbnail at 3s, the second one at 5s and the third one at 25.5s).", "example": "thumbnail-%number%.png" }, "interval": { "type": "number", "format": "double", "description": "The interval in which to create thumbnails. In seconds (E.g. a value of 4 means create a thumbnail every 4 seconds). Mutually exclusive with positions/unit. Has to be equal to or greater than 1." }, "positions": { "type": "array", "items": { "type": "number", "format": "double" }, "description": "Position in the unit where the thumbnail should be created from. Mutually exclusive with interval." }, "outputs": { "type": "array", "items": { "$ref": "#/components/schemas/EncodingOutput" } }, "unit": { "description": "Unit of the values in the positions array.", "allOf": [ { "$ref": "#/components/schemas/ThumbnailUnit" } ] }, "aspectMode": { "description": "Specifies the aspect mode that is used when both height and width are specified\nOnly supported starting with encoder version `2.85.0`.\n", "allOf": [ { "$ref": "#/components/schemas/ThumbnailAspectMode" } ] } } } ] }, "ThumbnailAspectMode": { "title": "ThumbnailAspectMode", "type": "string", "default": "STRETCH", "enum": [ "PAD", "CROP", "STRETCH" ], "x-enum-elements": [ { "name": "PAD", "description": "Specifies that the Padding aspect mode is used when adapting to configured the width and height.\n\nPadding means that either horiziontally or vertically black boxes are added to make sure that the thumbnail image fits the aspect ratio.\n" }, { "name": "CROP", "description": "Specifies that the Cropping aspect mode is used when adapting to configured the width and height.\n\nCropping means that parts of the image are removed so that the thumbnail fits the aspect ratio.\n" }, { "name": "STRETCH", "description": "Specifies that the Stretching aspect mode is used when adapting to configured the width and height.\n\nStretching means that the image is stretched either vertically or horizontally until it fits the aspect ratio.\n" } ] }, "ThumbnailUnit": { "title": "ThumbnailUnit", "type": "string", "default": "SECONDS", "enum": [ "SECONDS", "PERCENTS" ], "x-enum-elements": [ { "name": "SECONDS", "description": "Unit of positions is in seconds" }, { "name": "PERCENTS", "description": "Unit of positions is in percent" } ] } } }, "tags": [ { "name": "Stream" } ] } ```