Skip to content
PaprikaPaprikaPaprika

A batch's status, counts and combined output

GET
/v1/batches/{batch}
curl --request GET \
  --url https://example.com/v1/batches/example \
  --header 'Authorization: Bearer <token>'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
batch
required
string
/^bat_[A-Za-z0-9]{20}$/

Responses

Section titled “Responses”

200

Section titled “200”

The answer.

Media typeapplication/json
object
id
required
string
status
required
string
queue
object
ahead
required
integer
template
required
string
version
required
integer
format
required
string
combine
required
string
records
required
integer
counts
required
object
queued
required
integer
running
required
integer
done
required
integer
failed
required
integer
cancelled
required
integer
remaining
required
integer
createdAt
required
string
finishedAt
required
null | string
output
object
id
required
string
batch
required
string
template
required
string
version
required
integer
format
required
string
engine
required
object
version
required
string
build
required
string
fileCreatedAt
required
string
records
required
integer
printStatus
required
string
pages
required
Array<object>
object
filename
required
string
size
required
integer
sha256
required
string
createdAt
required
string
expiresAt
required
string
download
required
string
signedDownload
required
string

Example generated

{
  "id": "example",
  "status": "example",
  "queue": {
    "ahead": 1
  },
  "template": "example",
  "version": 1,
  "format": "example",
  "combine": "example",
  "records": 1,
  "counts": {
    "queued": 1,
    "running": 1,
    "done": 1,
    "failed": 1,
    "cancelled": 1,
    "remaining": 1
  },
  "createdAt": "example",
  "finishedAt": "example",
  "output": {
    "id": "example",
    "batch": "example",
    "template": "example",
    "version": 1,
    "format": "example",
    "engine": {
      "version": "example",
      "build": "example"
    },
    "fileCreatedAt": "example",
    "records": 1,
    "printStatus": "example",
    "pages": [
      {}
    ],
    "filename": "example",
    "size": 1,
    "sha256": "example",
    "createdAt": "example",
    "expiresAt": "example",
    "download": "example",
    "signedDownload": "example"
  }
}

401

Section titled “401”

No key, or not a valid one.

Media typeapplication/json
object
code
required
string
Allowed values: field-unknown field-missing field-not-text glyph-missing font-missing text-overflow max-below-start min-above-start frame-id-duplicate anchor-target-missing anchor-cycle dependency-failed word-broken image-missing image-unsupported frame-size-invalid image-empty frame-off-page component-unknown component-part-outside spot-unused slug-characters-missing image-low-resolution frame-hidden mask-image-svg mask-image-low-resolution stroke-thin stroke-pattern-too-long image-profile-unreadable image-cmyk-profile paper-colours-unreachable paper-image-unreachable font-no-embed image-no-size image-format blobs-unknown blob-kind profile-missing font-rights request-too-large not-found bad-request internal-error busy render-timeout unauthorized scope-missing tenant-unavailable admin-unauthorized admin-disabled tenant-exists values-invalid value-type value-too-long value-characters value-empty value-range template-filename-taken template-invalid font-not-embeddable font-in-use render-too-slow resources-unknown layout-errors preflight-failed api-unreachable queue-full idempotency-conflict job-finished job-abandoned signing-off link-invalid link-expired batch-queue-full batch-too-large records-invalid records-unreadable batch-finished rate-limited combine-too-large image-invalid schema font-rejected blob-rejected layout-failed package-rejected resource-rejected tracking-ignored font-in-kit kit-exists kit-invalid kit-in-use kit-item-in-use kit-item-missing
message
required
string
requestId
string

Example 

{
  "code": "field-unknown"
}

403

Section titled “403”

The key lacks the scope, or its tenant is suspended or deleted.

Media typeapplication/json
object
code
required
string
Allowed values: field-unknown field-missing field-not-text glyph-missing font-missing text-overflow max-below-start min-above-start frame-id-duplicate anchor-target-missing anchor-cycle dependency-failed word-broken image-missing image-unsupported frame-size-invalid image-empty frame-off-page component-unknown component-part-outside spot-unused slug-characters-missing image-low-resolution frame-hidden mask-image-svg mask-image-low-resolution stroke-thin stroke-pattern-too-long image-profile-unreadable image-cmyk-profile paper-colours-unreachable paper-image-unreachable font-no-embed image-no-size image-format blobs-unknown blob-kind profile-missing font-rights request-too-large not-found bad-request internal-error busy render-timeout unauthorized scope-missing tenant-unavailable admin-unauthorized admin-disabled tenant-exists values-invalid value-type value-too-long value-characters value-empty value-range template-filename-taken template-invalid font-not-embeddable font-in-use render-too-slow resources-unknown layout-errors preflight-failed api-unreachable queue-full idempotency-conflict job-finished job-abandoned signing-off link-invalid link-expired batch-queue-full batch-too-large records-invalid records-unreadable batch-finished rate-limited combine-too-large image-invalid schema font-rejected blob-rejected layout-failed package-rejected resource-rejected tracking-ignored font-in-kit kit-exists kit-invalid kit-in-use kit-item-in-use kit-item-missing
message
required
string
requestId
string

Example 

{
  "code": "field-unknown"
}