Sign in
manufacturing-v1

Get Design Resource

get/v1/designs/{design_id}

Path parameters

design_idstring required

Query parameters

include_review_linkboolean

Include a website review link. Upload polling can skip this work.

Include a website review link. Upload polling can skip this work.

Response

Successful Response

idstring required
object'design'
status'queued' | 'processing' | 'ready' | 'failed' required
status_urlstring required
namestring required
model_urlstring nullable
image_urlstring nullable

Rendered picture of the whole design (all part instances in place). Accepts the same view, format, and width parameters as part images; labels are per part, so use each part's image_url to identify holes and bends.

review_urlstring nullable

Website page where a person can look at this design in the 3D configurator, add or change hole operations, material, and finish, and save the result. Read the saved choices back with GET /v1/review-links/{id}; the link id is review_link_id.

review_link_idstring nullable
models_status'queued' | 'processing' | 'ready' | 'failed' required
weld_candidates_urlstring nullable

Discover located contact paths and joined part-instance IDs for configuring welds.

models_errorstring nullable
preview_status'queued' | 'processing' | 'ready' | 'failed'
preview_urlstring nullable

Owner-authorized whole-model preview, available before analysis and production models finish.

preview_errorstring nullable
created_atstring date-time nullable
updated_atstring date-time nullable

Changes

Changed in 5 of the 11 revisions of this API.9

  • d104f57cc9851See the full diff
    • ○

      added the new optional query request parameter include_review_link

      new-optional-request-parameter

  • 5810b934dd3b1See the full diff
    • ○

      added the optional property // to the response with the status

      response-optional-property-added

  • 88467239cf6a2See the full diff
    • ○

      added the optional property // to the response with the status

      response-optional-property-added

    • ○

      added the optional property //// to the response with the status

      response-optional-property-added

  • 35a1cd3bea644See the full diff
    • ○

      added the optional property to the response with the status

      response-optional-property-added

    • ○

      added the optional property to the response with the status

      response-optional-property-added

    • ○

      added the optional property to the response with the status

      response-optional-property-added

    • ○

      added the optional property to the response with the status

      response-optional-property-added

    This revision also has 21 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • b7e901150c5c1See the full diff
    • ○

      endpoint added

      endpoint-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog