Skip to main content

Tasks - get result in a specific format

GET 

/api/v1/tasks/:taskId/result/:format

Returns a download URL for the requested output format (e.g. glb, step, stpz).

Request

Responses

Result download link

Reference

GET /api/v1/tasks/{taskId}/result/{format}

Returns a download URL for the requested output format (e.g. glb, step, stpz).

Parameters

ParameterInTypeRequiredDescription
taskIdpathstringyesTask ID
formatpathstringyesResult format (e.g. glb, step, stpz, metadata, decomposed-mesh)

Responses

StatusDescription
200Result download link
404Not found
409Task is not yet completed

Example request

curl -X GET "https://api.bitbybit.dev/api/v1/tasks/{taskId}/result/{format}" \
-H "x-api-key: YOUR_API_KEY"

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