latestOpenAPI 3.0.02026-08-10380208.8 KB

806c6d31631b

Dataset

Advanced Image Upload

Efficiently upload a large volume of images (up to 5000) from a ZIP file to an advanced dataset.

Upload without Schema: You can initiate a bulk upload even if visual_schema is null. Images will be uploaded but caption generation will be skipped. You must call Regenerate All Captions after defining the schema.

General:

  • Asynchronous operation; status can be retrieved via {dataset_id}/bulk-upload/status.
  • Supported for 'advanced' upload type datasets only.
  • If the dataset is not empty, if another bulk upload is in progress, or if any previous bulk upload attempt took place, the request will fail.

Image Requirements:

  • Supported formats: jpg, jpeg, png, webp.
  • Minimum dimensions: 1024 x 1024 pixels.
  • Total size limit: 5 GB zip file.
post/tailored-gen/datasets/{dataset_id}/images/bulk-upload

Path parameters

dataset_idinteger required

Headers

api_tokenstring required

Request body

zip_urlstring uri

The publicly accessible URL of the ZIP file to upload.

content_moderationboolean

When enabled, applies content moderation to input visuals.

Response

Bulk upload job started successfully.