AutoPrintFarm API - AutoPrintFarm Docs

The AutoPrintFarm public API lets external tools, scripts, and dashboards read live data from your print farm. Every request is authenticated with an API key you mint from the dashboard, and every response comes wrapped in a predictable { success, data } envelope.

Printers

Fleet status, firmware versions, and connection health for every printer.

Jobs

The queued, active, and historical print jobs across your farm.

Inventory

Finished-goods stock levels by SKU, color, and material.

Base URL

https://api.autoprintfarm.com/public/v1

Quick start

Create a key

Open Settings → API Keys in the dashboard, click Create API Key, and pick the scopes you need.

Copy it once

The full key is shown exactly once. AutoPrintFarm only stores the SHA-256 hash, so save it to your secret manager immediately.

Make your first request

Send the key as a Bearer token on every request:

curl -H "Authorization: Bearer apf_live_xxx..." \
  https://api.autoprintfarm.com/public/v1/printers

Scopes

Scope	What it grants
`read`	Every `GET` — printers, jobs, inventory, orders, products, files, hubs, assembly, materials, wiki, worklist, analytics
`write`	Data mutations — create, update, delete, uploads, fulfillment, job enqueue/patch/retry/complete
`control`	Physical printer commands — start, pause, resume, stop, heaters, light, filament

See Authentication → Scopes for the per-scope breakdown.

Response envelope

Every successful response is wrapped:

{
  "success": true,
  "data": [ /* ... */ ]
}

Errors use the same shape with success: false plus code and error fields:

{
  "success": false,
  "code": "INSUFFICIENT_SCOPE",
  "error": "API key missing required scope: read"
}

See Authentication → Error codes for the full list of codes and their HTTP statuses.

Next steps

Authentication

How to create, use, and revoke API keys — plus the full error code table.

Rate limits

Per-key request budgets and how to read the X-RateLimit-* headers.

API Reference

Endpoint-by-endpoint reference generated from the OpenAPI spec.

OpenAPI spec

Machine-readable spec you can feed into your own SDK generator.