API Reference

Notes

Overview

What are notes?

Notes pieces of additional plain text you can add to a job. In the UI these notes will show up at the bottom of your job view. In the API you can retrieve them using these endpoints.

Why would I use these?

These endpoints are useful if you use notes to capture additional details about your job.

How can I use these?

Notes can be written to a Job by using the Job ID. If a Job contains a note, the Job Details will include the note's ID. This Note ID can be used to update and delete notes. The architecture is similar to how Images work.