latestOpenAPI 3.0.02026-08-10380208.8 KB

806c6d31631b

Dataset

Update Image Caption

Update the caption of a specific image. Two mutually exclusive options:

  1. Provide a new caption: Use the caption parameter (sets caption_source to "manual"). The caption must be a string containing a valid JSON structure.
  2. Regenerate automatically: Set regenerate_caption to true (sets caption_source to "automatic").

Constraints:

  • Cannot update captions in a completed dataset
  • Cannot provide both caption and regenerate_caption
put/tailored-gen/datasets/{dataset_id}/images/{image_id}

Path parameters

dataset_idinteger required
image_idinteger required

Headers

api_tokenstring required

Request body

captionstring

New caption text as a string containing valid JSON structure.

regenerate_captionboolean

When true, generates new caption automatically.

Response

Caption successfully updated

idinteger
dataset_idinteger
captionstring
caption_source'automatic' | 'manual'
image_namestring
image_urlstring
thumbnail_urlstring
created_atstring date-time
updated_atstring date-time