Thumbnails

Set the video poster

Replaces the library video's primary poster (posterUrl on GET video) with a customer image. JSON imageUrl (https) is the MCP-friendly path. Multipart file (or image) also works. JPEG, PNG, or WebP, 8MB max. This is not an AI generation job. Required scope: thumbnails:write.

post/videos/{videoId}/poster

Request

  • Base URL
    https://api.braiv.co/v1
  • Auth
    • HTTP bearer
    • or API key in header X-Api-Key

Path parameters

videoIdstring required

Braiv library video document ID.

Headers

Idempotency-Keystring

Caller-generated key for safe POST retries. The API retains the first JSON response for 24 hours. Reusing a key with another path or body returns 409 IDEMPOTENCY_REPLAY.

Request body

imageUrlstring uri required

https URL of a JPEG

Response

Poster replaced.

videoIdstring required

Library video id.

posterUrlstring uri required

New primary poster URL.

Changes

No recorded changes to this operation across all 1 revision of this API.