Introduction
High-performance parametric CAD model generation API. Supports multi-format output (STEP, GLTF, decomposed mesh), pipeline execution, file-based conversion, and async job processing.
CAD - execute a chained pipeline
Runs multiple operations sequentially. Use '$ref:N' in params to reference step N's result.
CAD - execute a single operation
Runs a single CAD operation by its fully-qualified identifier.
CAD - execute compound (parallel) operations
Runs several independent CAD operations in parallel as one compound task. Each sub-operation is executed on its own and produces its own downloadable result, so use this when the operations do not depend on each other - for a sequence where each step consumes the previous one's output, use the chained pipeline endpoint instead. Returns 202 with a compound task id; poll it and download the per-sub-task manifest when it completes.
Convert - STEP to Draco-compressed glTF (.glb), advanced options
Full-control STEP → glTF conversion with Draco geometry compression. Combines fine-grained mesh, export, and coordinate options with Draco quantization controls. Requires the 'convert' API key scope. Returns 202 with a task ID.
Convert - STEP to Draco-compressed glTF (.glb)
STEP → glTF conversion with Draco geometry compression using a previously uploaded file. Requires the 'convert' API key scope. Returns 202 with a task ID.
Convert - STEP to glTF (.glb), advanced options
Full-control STEP → glTF conversion with fine-grained mesh, export, and coordinate options. Requires the 'convert' API key scope. Returns 202 with a task ID.
Convert - STEP to glTF (.glb)
Simple STEP → glTF conversion using a previously uploaded file. Requires the 'convert' API key scope. Returns 202 with a task ID.
Files - confirm upload
Confirms that the file was successfully uploaded to the pre-signed URL.
Files - delete a file
Permanently deletes an uploaded file and the stored blob behind it. This cannot be undone, and any task result that still points at the blob stops resolving. Files also expire on their own, so call this only when you need the storage released sooner than that.
Files - get file details
Returns metadata and download URL for a single file.
Files - list uploaded files
Returns a paginated list of the files uploaded under your API key, newest first, with each file's id, original name, size, upload status and expiry. Use it to find the file id to pass to a conversion endpoint, and to check that an upload through a pre-signed URL actually completed before you reference it.
Files - request an upload URL
Returns a pre-signed URL for uploading a file via PUT.
Health - status check
Returns the operational status of the Bitbybit CAD Cloud API, including service health and readiness. Requires no authentication, so it is suitable for uptime monitoring, load balancer probes and deployment smoke tests.
Models - batch-fetch definitions
Returns parameter schemas and defaults for the requested model names.
Models - build a Dragon Cup
Parametric dragon-scale textured cup with twisted lofted body, voronoi-like skin cells, and configurable shell thickness. All parameters are optional - defaults produce a ready-to-print model.
Models - build a Phone Nest
Parametric 3D-printable desktop phone holder/stand with a lofted cradle surface, optional ornamental perforations, and a phone mock-up shape. All parameters are optional - defaults produce a ready-to-print model.
Models - execute a parametric model
Generic endpoint - works for any registered model. See model-specific endpoints for fully typed parameters. Always returns 202 with a task ID for polling.
Models - generate a batch
Creates a compound task with one sub-task per item. Each item can have different parameters but shares the same output config.
Models - get parameter definitions
Returns parameter schema, types, defaults, and limits for the specified model.
Models - list available models
Lists every parametric model available for generation, by name. Use the returned names with the definitions and generation endpoints to discover each model's parameter schema and defaults before submitting a job.
Sheet metal - unfold a face, metrics report
Proprietary sheet-metal analysis: computes the unfold metrics report (developability, area, ...) for a single face of an uploaded STEP shape. Requires the 'cad' API key scope. Returns 202 with a task ID; the JSON report is delivered in the task metadata.
Sheet metal - unfold a face to flat geometry
Proprietary sheet-metal unfold: flattens a single developable face (by index) of an uploaded STEP shape. Requires the 'cad' API key scope. Returns 202 with a task ID; the flattened geometry is delivered as the task's output files.
Sheet metal - unfold all solids, geometry + report
Proprietary sheet-metal unfold, full workflow: flattens every solid in an uploaded STEP file AND returns per-solid metrics in one call. Requires the 'cad' API key scope. Returns 202 with a task ID; flats are combined into one compound output per format and the per-solid report array is delivered in the task metadata.
Sheet metal - unfold all solids, metrics report
Proprietary sheet-metal analysis: computes per-solid unfold metrics for every solid in an uploaded STEP file. Requires the 'cad' API key scope. Returns 202 with a task ID; the JSON report array is delivered in the task metadata.
Sheet metal - unfold all solids to flat geometry
Proprietary sheet-metal unfold: loads every solid in an uploaded STEP file and flattens each to a flat pattern. Requires the 'cad' API key scope. Returns 202 with a task ID; all flats are combined into one compound output per format.
Tasks - cancel a task
Cancels a waiting or queued task. Has no effect on completed/failed tasks.
Tasks - get all results
Returns download URLs for every available result format in a single call. Use this instead of making multiple requests to /result/{format}.
Tasks - get result (default format)
Returns a download URL for the task's primary result. For compound tasks, returns a manifest with per-sub-task download links.
Tasks - get result in a specific format
Returns a download URL for the requested output format (e.g. glb, step, stpz).
Tasks - get task status
Returns the current status and metadata of a task.
Tasks - list tasks
Returns a paginated list of your tasks, newest first, each with its id, kind, status, creation time and result link when finished. Filter by status to poll only what is still running, or by kind to separate model generation, STEP conversion, pipelines and compound runs. This is the endpoint to build a job dashboard on rather than polling every task id individually.
Tasks - retry a failed or cancelled task
Re-queues a failed or cancelled task with the same parameters.