Important!
The 3D print API is shutting down on January 15, 2017. See our end of life notice for more information.
Print Jobs¶a>
Users create Forge print jobs by calling the POST printers/:printer_id/jobs endpoint. New jobs return a job_id, which is used when calling other job endpoints. The new jobs are automatically sent to the printer if they include a valid printer_id and printable_id (or printable_url). Jobs without a printable ID or a printer ID have their status set to created until the missing information is added.
Note that the printable_id is usually generated by the POST trays/prepare endpoint.
Job Status¶
A print job can have any of the following job statuses.
Status |
Description |
|---|---|
| sent | Job has been sent to the printer but is not yet acknowledged as received. |
| received | Printer received the job (does not mean the print job is running). Certain printers may require user action on the hardware to start the print job. Note that Forge removes received printable files, so the printer must complete the file download before sending the received status. |
| printing | Printer processing this print job. |
| paused | Printer in paused state. |
| canceled | Print job is canceled. |
| completed | Print job is completed. |
| failed | Job failed. Additional information may be provided with
error_id and error_message. |
| successful | This status will never be reported by the printer. This status will be set by the application to indicate that the user is satisfied with this job. |
Queued Print Jobs¶
Forge queues new print jobs if there is another job already executing or if there are other queued jobs waiting to be printed. Queued jobs can be started automatically by calling the PUT printers/:printer_id/jobs endpoint.
Set Job Details¶
After creating a job you can change the job’s printer ID and printable file ID by calling the POST jobs/:job_id/printable and POST jobs/:job_id/printer endpoints.
Non-Forge Print Jobs¶
Print jobs that were not initiated by Forge are integrated into the Forge job queue and assigned to the Forge printer owner who can manage them through Forge.
Printer Simulator¶
Use Forge’s printer simulator to test the print job endpoints without physically printing 3D models.
