Skip to main content
POST
Create a print job

Authorizations

Authorization
string
header
default:pe_test_REPLACE_WITH_YOUR_TEST_KEY
required

Send Authorization: Bearer <API key>. Use a pe_test_ key in the playground; it only reaches virtual test printers.

Headers

idempotency-key
string

Any unique string up to 255 characters; retries with it never print twice

Maximum string length: 255
Example:

"invoice-1042-print-1"

Body

application/json

Job to print

Send exactly one of two forms: contentType with content (a new document), or reprintOf alone (print the stored file of an earlier job again). Any other combination is 400 invalid_request.

printerId
string<uuid>
required

Printer to print on

title
string
required

Shown in the dashboard and logs

Required string length: 1 - 255
authentication
object
content
string

Base64 document or https content URL. Required together with contentType; must be omitted with reprintOf.

Minimum string length: 1
contentType
enum<string>

How content is sent. Required together with content; must be omitted with reprintOf.

Available options:
pdf_uri,
pdf_base64,
raw_uri,
raw_base64
expireAfter
integer
default:86400
Required range: 60 <= x <= 604800
options
object
qty
integer
default:1
Required range: 1 <= x <= 100
reprintOf
string<uuid>

Id of an earlier job of this organization and mode whose stored file is printed again. Send it instead of contentType and content, never with them. Its contentType is copied; 410 file_expired once the file is gone.

source
string
default:api
Maximum string length: 255

Response

The queued job

computerId
string
required
contentType
enum<string>
required
Available options:
pdf_uri,
pdf_base64,
raw_uri,
raw_base64
createdAt
string
required
expireAfter
number
required
expiresAt
string
required
fileSha256
string | null
required
fileSize
number | null
required
finishedAt
string | null
required
id
string
required
mode
enum<string>
required
Available options:
live,
test
options
object
required
printerId
string
required
printingAt
string | null
required
qty
number
required
receivedAt
string | null
required
sentAt
string | null
required
source
string
required
state
enum<string>
required
Available options:
queued,
sent,
received,
printing,
done,
error,
cancelled,
expired
stateMessage
string | null
required
title
string
required