Set a custom thumbnail
Set a custom thumbnail
/v1/videos/{id}/thumbnailThis operation supports dashboard session-cookie authentication. Call it only from trusted server code; browsers must not manufacture or expose the session cookie.
Replaces the video's thumbnail with a custom image. The request body
is the raw image bytes (JPEG, PNG, or WebP; at most 5 MB) and the
Content-Type header must match the payload's actual format.
Requires an API key with write scope, or session-cookie auth plus
projectId. Rate limit: 30 requests per 60 s per caller.
The custom image survives encode retries; delete it with
DELETE /v1/videos/{id}/thumbnail to return to the automatic
poster frame.
Error codes: unauthorized (401), insufficient_scope (403),
account_not_approved (403), invalid_project_id (400),
invalid_image (400), invalid_body (400), not_found (404),
video_not_found (404). Unsupported content types return 415;
oversize bodies return 413.
Authentication
- apiKey — Project API key:
Authorization: Bearer vh_live_...(live mode) orAuthorization: Bearer vh_test_...(test mode). Keys carryreadand/orwritescopes. - sessionCookie — Dashboard session cookie set by
POST /v1/auth/login. Video and playback endpoints additionally require theprojectIdquery parameter under cookie auth.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
id | path | string (Ulid) | Yes | — |
projectId | query | string (Ulid) | No | Required when authenticating with the session cookie; ignored under API-key auth (the key is already project-scoped). |
Request body
required
Content type: image/jpeg
Content type: image/png
Content type: image/webp
Responses
| Status | Meaning |
|---|---|
200 | The new public thumbnail URL. |
400 | The request body or query failed validation. The per-operation description lists the exact error.code values. |
401 | No valid credential was presented. |
403 | The credential is valid but does not permit this action. The per-operation description lists the exact error.code values. |
404 | The resource does not exist or is not visible to this caller. |
429 | Rate limit exceeded. |
Try it
/v1/videos/{id}/thumbnailAPI playground
Send a live request to api.videohati.com with a test-mode key.
The key is stored in your browser on docs.videohati.com only.
Required when authenticating with the session cookie; ignored under API-key auth (the key is already project-scoped).
https://api.staging.videohati.com/v1/videos/{id}/thumbnail