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
- 202
- 400
- 404
- 500
Compound task accepted
Validation error
Not found
Server error
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
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
modelName | path | string | yes | Model slug (e.g. dragon-cup, phone-nest) |
Request body
Content type: application/json (required)
| Field | Type | Required | Description |
|---|---|---|---|
items | array of object | yes | Array of parameter variations. Each item produces a separate output with the same model. |
items[].params | object | no | |
outputs | object | yes | Controls which output formats are generated and their quality settings |
outputs.formats | array of object | yes | Output 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.meshPrecision | number | no | Mesh tessellation precision (lower = finer). Range: [0.0001, 10] |
outputs.gltfMeshPrecision | number | no | Mesh tessellation precision (lower = finer). Range: [0.0001, 10] |
outputs.adjustYtoZ | boolean | no | Convert from Y-up to Z-up coordinate system in the output. Useful for software that expects Z-up. |
Responses
| Status | Description |
|---|---|
202 | Compound task accepted |
400 | Validation error |
404 | Not found |
500 | Server 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.