Get a render job

GET

/v1/render-jobs/{jobId}

curl --request GET \
  --url https://api.presscloud.example/v1/render-jobs/example \
  --header 'Authorization: Bearer <token>'

Returns the current state of a render job.

Authorizations

• bearerAuth

Parameters

Path Parameters

jobId

required

string

>= 1 characters

Responses

200

Render job detail.

Media type application/json

object

job

required

object

id

required

string

>= 1 characters

deployId

required

string

deployVersionId

required

string

deployVersionNo

integer

deployVersionRoute

string

deployVersionTitle

string

businessKey

required

string

payloadHash

required

string

status

required

string

Allowed values: queued rendering succeeded retry_scheduled failed canceled

attempt

required

integer

requestedAt

required

integer

startedAt

integer

finishedAt

integer

errorCode

string

errorMessage

string

outputMode

required

string

Allowed values: transient managed

output

object

id

required

string

renderJobId

required

string

pdfBlobHash

string

pdfR2Key

string

bytes

required

integer

pageCount

integer

>= 1

timingJson

string

createdAt

required

integer

state

required

string

Allowed values: available deleted

accessGuaranteedUntil

integer

deleteAfter

integer

deleteReason

string

Allowed values: manual automatic_cleanup

deletedAt

integer

pdf

object

id

required

string

state

required

string

Allowed values: available deleting deleted

fileName

required

string

>= 1 characters

bytes

required

integer

pageCount

integer

>= 1

createdAt

required

integer

Example

{
  "job": {
    "status": "queued",
    "outputMode": "transient"
  },
  "output": {
    "state": "available",
    "deleteReason": "manual"
  },
  "pdf": {
    "state": "available"
  }
}

404

Requested resource was not found.

Media type application/json

object

error

required

string

message

required

string

Example ^generated

{
  "error": "example",
  "message": "example"
}

501

Route is defined but not implemented yet.

Media type application/json

object

error

required

string

message

required

string

Example ^generated

{
  "error": "example",
  "message": "example"
}