Calculate toolpaths
POST/v1/parts/:id/toolpaths
Creates a plan and calculates its toolpaths in one step, returning a job. Wait for the job with Stream job updates (GET /v1/jobs/{id}/events), then read the result with Get toolpaths (GET /v1/plans/{planId}/toolpaths) and Get machining time (GET /v1/plans/{planId}/machining-time).
Experimental. Available now and still gaining functionality. It may change in breaking ways in a minor API release; each such change is listed in the release notes, so check them before upgrading.
Request
Responses
- 202
- 400
- 401
- 402
- 403
- 404
- 409
- 500
- 503
The toolpath job was accepted; wait for it on GET /v1/jobs/{id}/events, then read /v1/plans/{planId}/toolpaths for the calculated result. The plan is readable at planned (GET /v1/plans/{planId}) as soon as the job has planned the part, with jobId naming this job; it becomes toolpathed when the cuts are done. A failed job leaves it planned under the failed job.
The request is invalid.
The API key is missing or invalid.
The organization has used its included quota for this operation and is out of usage credits or over its monthly spend limit.
The API key may not perform this operation: it has no access to this part of the API, it may only read it, or its creator has not met the organization’s two-factor requirement.
The part does not exist.
The part source has not been uploaded, it changed after work began on the part (part_source_changed), or the Idempotency-Key was already used for a different operation.
The toolpath job could not be created.
Authentication is temporarily unavailable, or the job could not be sent to the processing queue (job_dispatch_failed) and was not created. Retry the request; reusing its Idempotency-Key is safe.