> ## Documentation Index
> Fetch the complete documentation index at: https://docs.autoprintfarm.com/llms.txt
> Use this file to discover all available pages before exploring further.

# API Reference

> Endpoint-by-endpoint reference for the AutoPrintFarm public API.

The tabs below this page cover each endpoint in detail, generated from the
[OpenAPI spec](/api-reference/openapi.json). You can also fetch the spec
directly from the API itself:

```bash theme={null}
curl https://api.autoprintfarm.com/public/v1/openapi.json
```

## Summary

Authorization uses three scopes:

| Scope     | Covers                                                                                                                         |
| --------- | ------------------------------------------------------------------------------------------------------------------------------ |
| `read`    | All `GET` endpoints (printers, jobs, inventory, orders, products, files, hubs, assembly, materials, wiki, worklist, analytics) |
| `write`   | Data mutations — create/update/delete, uploads, BOM, inventory adjustments, fulfillment, job enqueue/patch/retry/complete      |
| `control` | Physical printer commands — start, pause, resume, stop, heaters, light, filament, cancel a running print                       |

All endpoints are scoped to your account — the API key determines which data
you see.

## Conventions

* **Successful responses** wrap payloads in `{ success: true, data: ... }`.
* **Errors** use `{ success: false, code, error }` with the HTTP status codes
  from [Authentication → Error codes](/authentication#error-codes).
* **Pagination** on `/jobs` uses `?limit=` (1–100, default 50) and `?offset=`.