Sign in
Recipes

Media Captioning

Changed on

Generates a descriptive caption for a single media item using the JoyCaption model.

post/v2/consumer/recipes/mediaCaptioning

Request

  • The document declares no server URL.
  • Auth: none required

Query parameters

experimentalboolean
allowMatureContentboolean
whatifboolean
ephemeralboolean
tier'paid' | 'free'

How a workflow is paid for.

Request body

model'joy-caption' | 'ideogram4'

Captioning model and output contract. Use ideogram4 for structured Ideogram 4 JSON captions with normalized bounding boxes.

mediaUrlstring uri required

The URL of the media to caption (single image or video).

temperaturenumber double

Sampling temperature for caption generation. Ideogram 4 uses the Qwen model's fixed sampling defaults to match AI Toolkit.

maxNewTokensinteger

Maximum number of tokens to generate. Ideogram 4 enforces a 3072-token floor.

customInstructionsstring nullable

Optional extra instructions appended to the captioning prompt to steer tone, structure, or formatting. Leave unset for the default caption.

Response

OK

captionstring required

Changes