CloudPrint Public API overview
This page covers the account-scoped Print API workflow. The complete OpenAPI reference also contains Developer Platform, Partner Management and public Agent download operations.
Where to send requests
Your backend sends all API requests to https://public-api.cloudprint.me. Account owners connect agents and create client apps at https://my.cloudprint.me. The installed agent uses a private CloudPrint protocol and is not an API for external applications.
Print API methods
| Method | Path | Scope | Purpose |
|---|---|---|---|
POST | /oauth/token | — | Obtain an OAuth2 access token |
GET | /api/v1/me | authenticated | Confirm account, client app and granted scopes |
GET | /api/v1/agents | agents:read | Check agent state and version |
GET | /api/v1/printers | printers:read | Discover printers and capabilities |
POST | /api/v1/documents | documents:write | Upload PDF or RAW data |
POST | /api/v1/print-jobs | print_jobs:write | Create a job for an uploaded document |
POST | /api/v1/print-jobs/from-url | documents:write, print_jobs:write | Fetch a public HTTPS document and create a job |
POST | /api/v1/print-jobs/from-base64 | documents:write, print_jobs:write | Decode inline bytes and create a job |
GET | /api/v1/print-jobs | print_jobs:read | List jobs with cursor pagination |
GET | /api/v1/print-jobs/{printJobId} | print_jobs:read | Read one job and its result |
Implementation order
Start with token acquisition and /me, then add printer selection, document upload, idempotent job creation and status polling. Add the URL and Base64 shortcuts after the two-step flow works. Use GET /api/v1/agents for diagnostics and GET /api/v1/print-jobs to reconcile history.
Pagination
Agents, printers and print-job lists use cursor pagination. Send limit (1–100) and then pass the returned opaque next_cursor as the next request's cursor. Stop when next_cursor is null; do not parse or construct cursor values.
Compatibility
The stable path is /api/v1. Ignore unknown response fields and treat unknown job statuses as non-terminal. Use the exact enum values and validation limits from OpenAPI. Compatible fields may be added to v1; breaking changes require a new major path.
More detailed guides
Read authentication for tokens and scopes, agents and printers for printer selection, documents for PDF and RAW input, print jobs for retries and statuses, and the API v1 reference for exact operations and schemas.