Skip to main content

Models - execute a parametric model

POST 

/api/v1/models/:modelName

Generic endpoint - works for any registered model. See model-specific endpoints for fully typed parameters. Always returns 202 with a task ID for polling.

Request​

Responses​

Task accepted

Reference​

POST /api/v1/models/{modelName}

Generic endpoint - works for any registered model. See model-specific endpoints for fully typed parameters. Always returns 202 with a task ID for polling.

Parameters​

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

Request body​

Content type: application/json (required)

FieldTypeRequiredDescription
paramsobjectnoModel-specific parameters. Omitted params use their defaults. See model definition for available options.
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.adjustYtoZbooleannoTurns a decomposed-mesh output from Y-up, as the server models, to Z-up. It applies to decomposed-mesh only: a STEP output is always written Z-up, so a STEP sent in comes back as it went in, and a glTF output is always Y-up, as glTF asks.

Responses​

StatusDescription
202Task accepted
400Validation error
404Not found
500Server error

Example request​

curl -X POST "https://api.bitbybit.dev/api/v1/models/{modelName}" \
-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.