Bulk jobs

Dry-run a bulk generation

POST
/bulk-jobs/preview

Simulates a bulk run, returns validation blockers for each batch and previews credit usage. Never mutates.

Authorization

token_auth
headerAuthorizationBearer <token>

Token-based authentication using access tokens.

Request Body

application/json
  1. body

Bulk generation request, selected by job_type without a wrapper field.

ai_retouch?Ai Retouch

auto: once the AI reviewer has checked the outputs, the AI retoucher fixes what it flagged on each image, once, without being asked. Each fixed image costs the AI retouch price, charged only when an image is fixed. Enterprise only for now, and not with review_config (images in a review round are retouched from the review screen); otherwise ignored. quality_summary.settled on GET /jobs//results, or the job_quality notification, tells when it is done.

Default"off"
Value in"off""auto"
tag_ids*array<string>

Unique tag IDs identifying the image groups to process.

Items1 <= items <= 100
image_selections?

Optional input image UUIDs per selected tag, keyed by tag ID.

options?

Job-type-specific generation options applied to all jobs.

post_process?Post Process

Enable post-processing for generated images.

Defaultfalse
review_config?|

Optional review settings applied to all jobs.

Defaultnull
project_id?|

Destination project ID; required for creation, optional for preview.

Defaultnull
job_type*Job Type

Selects flat-to-model generation.

identity_code*Identity Code

Model identity code used for all jobs.

Length1 <= length
instructions*array<>

Flat-to-model generation instructions applied to each selected tag.

Items1 <= items <= 10

Response Body

Successful Response

application/json
  1. response
tags*array<>
eligible_count*Eligible Count
credits*
blockers*array<>
curl -X POST "https://example.com/bulk-jobs/preview" \  -H "Content-Type: application/json" \  -d '{    "tag_ids": [      "string"    ],    "job_type": "flat_2_model",    "identity_code": "string",    "instructions": [      {}    ]  }'
{  "tags": [    {      "tag_id": "string",      "name": "string",      "image_count": 0,      "selected_count": 0,      "eligible": true,      "reason": "string",      "noted_count": 0    }  ],  "eligible_count": 0,  "credits": {    "per_job": 0,    "total": 0,    "in_progress": 0,    "available": 0  },  "blockers": [    {      "code": "images_need_picking",      "message": "string"    }  ]}