Common workflows

Combine the implemented APIs into product imagery, document packets and event labels. Track resource IDs, response types and retention deliberately.

On this page

Product thumbnails and responsive variants

  1. Download the original field notebook sample PNG, or use a small image you own.
  2. Upload it once with the exact file byte length. Keep the returned image _id.
  3. Submit one transformation per desired size: a 600 × 600 cover thumbnail and a width-1200 inside-fit detail image are separate requests.
  4. Choose CACHE for reusable derivatives, PERSIST for explicitly retained derivatives, or EPHEMERAL when you only need immediate bytes. Handle their retention rules before choosing.
  5. Store returned transformation IDs where present, and keep content type and ETag with downloaded bytes. Deliver through your own authenticated application.
Thumbnail request body
{
  "imageId": "REPLACE_WITH_IMAGE_ID",
  "mode": "CACHE",
  "transform": {
    "width": 600,
    "height": 600,
    "fit": "cover",
    "format": "webp",
    "quality": 80
  }
}

A filename is not an image ID. Do not expose the project key in a browser img URL. See the product thumbnail use case and mode semantics.

Build a delivery document packet

  1. Use delivery-note.pdf and care-guide.pdf. These are original fictional samples without personal data.
  2. Inspect each PDF if you need page counts. Info consumes one credit per document.
  3. Merge by appending both as repeated multipart file fields in the desired order. Do not JSON-encode PDFs.
  4. Render selected pages for previews. One selected page returns image bytes; multiple selected pages return JSON containing base64 page data.
  5. Retain the merged bytes yourself or upload them separately as a pdf_merge artifact. Download saved files with authentication.

Merge costs two credits; rendering costs one per selected page. Inspection does not make a later merge exempt from validation or quotas. Check the PDF limits and test forms/bookmarks before distributing complex documents.

Event check-in and stock labels

Create a QR code for an event URL and a Code 128 shelf label. They are independent JSON requests and independent one-credit outputs. Save only the assets you actually need later.

Keep the event link stable in your application, restrict check-in access there and scan-test printed output. A generated code does not add redirect hosting, analytics or authorization to the encoded destination.

The request builder prepares commands without collecting a key or executing API calls.

Documentation reviewed 2026-10-03 against development backend e298ec7. Verify your deployment’s API origin and limits before integrating.