Important!
The 3D print API is shutting down on January 15, 2017. See our end of life notice for more information.
HTTP Specification¶a>
The 3D Print API provides the following app development functionalities:
Printer Definitions | List Forge-supported printer types and materials and define slicing parameters. |
Print Preparation | Import, analyze, and repair meshes; slice meshes and create printable files. |
Printer Registration | Register Forge members as owners or users of Forge-connected 3D printers and retreive lists of registered printers. |
Printer Management | Manage Forge registered printers by sending commands or queueing and submiting jobs to the printers. |
Firmware | Connect firmware to Forge over the internet to enable printer owners to use the 3D Print API to control their printers, print jobs, and share their printers with other online users. |
Printer Definition¶
There are three types of printer definition endpoints:
- printer type endpoints, which retreive the Forge supported printer models
- material endpoints, which retreive the Forge supported print materials and their associated printer models
- profile endpoints, which create, retreive, and view a set of slicing parameters and their associated printer models
Endpoint |
Description |
---|---|
GET materials | Get a list of materials |
GET materials/ |
Get a material by ID |
GET printerTypes | Get a list of printer types |
GET printerTypes/ |
Get a printer type by ID |
GET profiles | Get a list of profiles |
GET profiles/ |
Get a profile by ID |
Print Preparation¶
These endpoints enable you to import a mesh, analyze it, repair it, slice it, and generate a printable file that you can submit to a 3D printer.
There are three types of print preparation endpoints:
- mesh endpoints, which import meshes, analyze them, and repair them
Meshes are collections of vertices, edges, and faces that represent a 3D model created from geometry files, such as OBJ and STL.
- tray endpoints, which set the mesh arrangement, printing material, and slicing parameters for a specific 3D printer
Data is taken from the printer type, print profile, and meshes. See the “Printer Definitions” section for print profiles and printer types.
- tasks, which are asynchronous running processes generated by print preparation endpoints when an instant response is not possible
Endpoint |
Description |
---|---|
GET tasks/ |
Get a task by ID |
POST meshes/ |
Import a mesh from a URN |
GET meshes/ |
Get a mesh by ID |
POST meshes/ |
Analyze a mesh object |
POST meshes/ |
Repair a mesh object |
POST meshes/ |
Rename a mesh object |
POST meshes/ |
Transform a mesh object |
POST meshes/ |
Export a mesh into a file |
POST trays | Create a new tray |
GET trays/ |
Get a tray |
POST trays/ |
Prepare a tray |
POST trays/ |
Generate a printable file from a tray |
POST trays/ |
Export supports for a tray |
Printer Registration¶
Use these endpoints to register Forge members as owners or users of Forge-connected 3D printers and retreive a list of registered printers.
Endpoint |
Description |
---|---|
GET printers | List printers registered to a member |
GET printers/ |
List members registered to a printer |
POST printers/ |
Register a printer |
DELETE printers/ |
Delete a printer |
POST printers/ |
Give permissions to a printer user |
POST printers/ |
Register a printer user |
Printer Management¶
Use these endpoints to manage Forge registered printers by sending commands or queueing and submiting jobs to the printers.
Endpoint |
Description |
---|---|
GET printers/ |
Get a registered printer |
GET printers/ |
Check printer status |
POST printers/ |
Send a command to a printer |
GET printers/ |
Get command status |
GET jobs | List jobs for a member |
POST printers/ |
Create a job |
GET jobs/ |
Get the status of a job |
PUT jobs/ |
Set status comments and custom data for a job |
POST jobs/ |
Set the ID or URL of a printable file for job |
POST jobs/ |
Set the printer ID for a job |
POST jobs/ |
Set a callback for a job. |
GET printers/ |
Get a list of jobs for a printer |
PUT printers/ |
Start a queued job |
Firmware¶
Connect firmware to Forge over the cloud to enable printer-owners to use Forge endpoints to control their printers and print jobs, and to share their printer with other online users.
Endpoint |
Description |
---|---|
POST printers/ |
Register printer |
POST printers/ |
Update printer status |
GET printers/ |
Get a list of queued jobs |
POST printers/ |
Initiate next queued print job |
DELETE printers/ |
Delete queued print job |
POST printers/ |
Acknowledge printer command |