v1

latestOpenAPI 3.0.02026-07-13650400.5 KB
Tailored Generation

Regenerate All Captions

Regenerate captions for all images in dataset. This action is crucial after the user updates the caption_prefix, and then it's recommended to regenerate all the captions of all images, to have full compatibility with the new caption_prefix.

This is an asynchronous operation. Once this endpoint is called, Get Dataset by ID should be sampled until the captions_update_status changes to 'completed'.

put/tailored-gen/datasets/{dataset_id}/images

Path parameters

dataset_idstring required

Dataset ID

Headers

api_tokenstring required

Response

Caption regeneration process started

idinteger

Unique identifier for the dataset

project_idinteger

Associated project ID

namestring

Dataset name

caption_prefixstring

Text automatically prepended to all image captions in the dataset. Each image caption should naturally continues this prefix. A default prefix is automatically created but can be modified, and this same prefix is later used as the default generation prefix during image generation.

status'draft' | 'completed'

Status of the dataset

captions_update_status'empty' | 'in_progress' | 'completed'

Status of captions update process

created_atstring date-time

Timestamp when the dataset was created

updated_atstring date-time

Timestamp when the dataset was last updated