Pick a thumbnail

PATCH

/videos/{videoId}/thumbnail

Pick a thumbnail from the given time code. If you'd like to upload an image for your thumbnail, use the Upload a Thumbnail endpoint. There may be a short delay for the thumbnail to update.
Tutorials using Thumbnail picking.

Request

Path Params

Body Params application/json

Examples

Responses

🟢200Success

application/json

Body

🟠404Not Found

Request Example

Shell

JavaScript

Java

Swift

curl --location --request PATCH 'https://ws.api.video/videos/vi4k0jvEUuaTdRAEjQ4Jfrgz/thumbnail' \
--header 'Content-Type: application/json' \
--data-raw '{
    "timecode": 0
}'

Response Example

200 - response

{
    "assets": {
        "hls": "https://cdn.api.video/stream/831a9bd9-9f50-464c-a369-8e9d914371ae/hls/manifest.m3u8",
        "iframe": "<iframe src=\"//embed.api.video/vi4k0jvEUuaTdRAEjQ4Jfrgz?token=831a9bd9-9f50-464c-a369-8e9d914371ae\" width=\"100%\" height=\"100%\" frameborder=\"0\" scrolling=\"no\" allowfullscreen=\"\"></iframe>",
        "mp4": "https://cdn.api.video/vod/vi4k0jvEUuaTdRAEjQ4Jfrgz/token/8fd70443-d9f0-45d2-b01c-12c8cfc707c9/mp4/720/source.mp4",
        "player": "https://embed.api.video/vi4k0jvEUuaTdRAEjQ4Jfrgz?token=831a9bd9-9f50-464c-a369-8e9d914371ae",
        "thumbnail": "https://cdn.api.video/stream/831a9bd9-9f50-464c-a369-8e9d914371ae/thumbnail.jpg"
    },
    "description": "An amazing video explaining string theory",
    "metadata": [
        {
            "key": "Author",
            "value": "John Doe"
        },
        {
            "key": "Format",
            "value": "Tutorial"
        }
    ],
    "mp4Support": true,
    "panoramic": false,
    "playerId": "pl45KFKdlddgk654dspkze",
    "public": false,
    "publishedAt": "4665-07-14T23:36:18.598Z",
    "source": {
        "uri": "/videos/vi4k0jvEUuaTdRAEjQ4Jfrgz/source"
    },
    "tags": [
        "maths",
        "string theory",
        "video"
    ],
    "title": "Maths video",
    "videoId": "vi4k0jvEUuaTdRAEjQ4Jfrgz"
}

Modified at 2023-08-15 05:52:15

Show video status

Upload a thumbnail