CloudPrint API v1 reference
Build a CloudPrint integration with versioned, indexable documentation for authentication, printers, documents, print jobs, errors and retries.
Choose the right documentation
Use the quickstart and workflow guides to understand the complete business flow. Use this versioned API reference while implementing exact requests, fields, responses and errors. The interactive Explorer is a secondary inspection tool; every public operation is documented in static HTML and Markdown.
Base URL and core flow
Production requests use https://public-api.cloudprint.me. A standard integration obtains a token, lists printers, uploads a document, creates an idempotent print job and polls it to a terminal status.
Compatibility
The major version is part of every stable API path. Compatible additions may appear in v1; removing or renaming operations, required fields or response fields requires a new major API version.
What CloudPrint does
CloudPrint delivers print-ready PDF or explicit RAW printer-language data to a selected local printer through an outbound agent connection. It does not generate carrier labels, convert Office documents through Public API or expose the private agent protocol.
All API v1 operations
| Type | Description | Endpoint |
|---|---|---|
POST | Get an access token | /oauth/token |
POST | Installation access token | /developer-api/v1/app-installations/{installationId}/access-tokens |
GET | Agent releases | /agent-download-api/v1/releases |
GET | Download Agent installer | /agent-download-api/v1/installers/{filename} |
GET | List managed accounts | /partner-api/v1/accounts |
POST | Provision an account | /partner-api/v1/accounts |
GET | Get a managed account | /partner-api/v1/accounts/{relationshipId} |
GET | List Agent Enrollments | /partner-api/v1/accounts/{relationshipId}/agent-enrollments |
POST | Create Agent Enrollment | /partner-api/v1/accounts/{relationshipId}/agent-enrollments |
GET | Get Agent Enrollment | /partner-api/v1/accounts/{relationshipId}/agent-enrollments/{enrollmentId} |
DELETE | Revoke Agent Enrollment | /partner-api/v1/accounts/{relationshipId}/agent-enrollments/{enrollmentId} |
GET | List managed Agents | /partner-api/v1/accounts/{relationshipId}/agents |
DELETE | Revoke managed Agent | /partner-api/v1/accounts/{relationshipId}/agents/{agentId} |
GET | Managed-account usage | /partner-api/v1/usage |
POST | Change account state | /partner-api/v1/accounts/{relationshipId}/{action} |
GET | Client context | /api/v1/me |
GET | List agents | /api/v1/agents |
GET | List printers | /api/v1/printers |
POST | Upload a document | /api/v1/documents |
GET | List print jobs | /api/v1/print-jobs |
POST | Create a print job | /api/v1/print-jobs |
POST | Create from URL | /api/v1/print-jobs/from-url |
POST | Create from Base64 | /api/v1/print-jobs/from-base64 |
GET | Get job status | /api/v1/print-jobs/{printJobId} |