Skip to main content

Models - generate a batch

POST 

/api/v1/models/:modelName/batch

Creates a compound task with one sub-task per item. Each item can have different parameters but shares the same output config.

Request

Responses

Compound task accepted

Reference

POST /api/v1/models/{modelName}/batch

Creates a compound task with one sub-task per item. Each item can have different parameters but shares the same output config.

Parameters

ParameterInTypeRequiredDescription
modelNamepathstringyesModel slug (e.g. dragon-cup, phone-nest)

Request body

Content type: application/json (required)

FieldTypeRequiredDescription
itemsarray of objectyesArray of parameter variations. Each item produces a separate output with the same model.
items[].paramsobjectno
outputsobjectyesControls which output formats are generated and their quality settings
outputs.formatsarray of objectyesOutput formats to generate. Multiple formats can be requested (e.g. ['gltf', 'stpz']) - each produces a separate downloadable result. Do not include both 'step' and 'stpz' - only one STEP variant is supported per request.
outputs.meshPrecisionnumbernoMesh tessellation precision (lower = finer). Range: [0.0001, 10]
outputs.gltfMeshPrecisionnumbernoMesh tessellation precision (lower = finer). Range: [0.0001, 10]
outputs.adjustYtoZbooleannoConvert from Y-up to Z-up coordinate system in the output. Useful for software that expects Z-up.

Responses

StatusDescription
202Compound task accepted
400Validation error
404Not found
500Server error

Example request

curl -X POST "https://api.bitbybit.dev/api/v1/models/{modelName}/batch" \
-H "x-api-key: YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{ ... }'

Authentication: send your key in the x-api-key header. The full machine-readable specification is at openapi.json.