BRbraiv
Thumbnails

Create an AI thumbnail

Creates a prompt-directed thumbnail (mode: prompt) or a zero-prompt thumbnail (mode: zero_prompt) derived from transcript and visual context. Pipeline thumbnail-v2 is Creative (character subjects). thumbnail-precision uses one or two content plates and rejects characters. Auto-detect (autoDetectCharacters or autoDetectContentReferences) is zero-prompt only and returns 202 with a packaging job id. Prompt Precision requires explicit content image URLs. Required scope: thumbnails:write.

post/videos/{videoId}/thumbnails

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

OR

Example request

{
  "prompt": "A confident presenter beside a dramatic before-and-after split screen, high contrast, clean composition."
}

Response

Request created; synchronous setup may already return generated URLs.

thumbnailRequestIdstring

Created thumbnail request ID when generation starts synchronously.

jobIdstring required

Pollable thumbnail job ID, or packaging job ID when detect is queued (202).

statusstring

queued when a detect-backed automation was registered.

registeredboolean

Whether a new automation run was created for a 202 response.

thumbnailUrlstring uri

Zero-prompt result when returned synchronously.

outputImageUrlsstring[]

Prompt-mode generated images.

balancenumber

Remaining account credit balance.

Changes

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