Skip to content
Press.js Press.js Press.js Docs

Create a render job

POST
/v1/render-jobs
 
curl --request POST \
  --url https://api.presscloud.example/v1/render-jobs \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "deployId": "example", "deployVersionId": "example", "businessKey": "example", "payload": "example", "payloadMime": "example", "payloadBase64": "example", "outputMode": "transient" }'

Accepts a JSON request envelope and enqueues asynchronous rendering. Render metadata and payload settings are passed in the request body. payloadMime defaults to application/json; charset=utf-8. JSON payloads are serialized as canonical JSON and exposed at https://p.press.internal/__payload. Non-JSON payloads must explicitly set payloadMime and provide either a UTF-8 string payload or raw bytes through payloadBase64.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Header Parameters

Section titled “Header Parameters ”
Idempotency-Key
string
>= 1 characters

Optional request idempotency key for retry-safe render job creation.

Request Body required

Section titled “Request Body required ”
Media type application/json
object
deployId
required
string
>= 1 characters
deployVersionId
required

A concrete deploy version id or the virtual pointer latest.

string
>= 1 characters
businessKey
string
>= 1 characters
payload

Render payload content. When payloadMime is omitted or resolves to JSON, this value is canonicalized as JSON. When payloadMime is a non-JSON MIME, this field must be a UTF-8 string payload.

payloadMime

Explicit MIME type for the render payload. Defaults to application/json; charset=utf-8.

string
>= 1 characters
payloadBase64

Optional raw payload bytes encoded as base64. Use this instead of payload for non-JSON binary payloads.

string
outputMode
string
Allowed values: transient managed

Responses

Section titled “ Responses ”

202

Section titled “202 ”

Render job accepted and queued.

Media type application/json
object
accepted
required
boolean
queue
required
string
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
Example 
{
  "accepted": true,
  "job": {
    "status": "queued",
    "outputMode": "transient"
  }
}

400

Section titled “400 ”

Invalid request payload or parameters.

Media type application/json
object
error
required
string
message
required
string
Example generated
{
  "error": "example",
  "message": "example"
}

404

Section titled “404 ”

Requested resource was not found.

Media type application/json
object
error
required
string
message
required
string
Example generated
{
  "error": "example",
  "message": "example"
}

409

Section titled “409 ”

Requested operation conflicts with the current resource state.

Media type application/json
object
error
required
string
message
required
string
Example generated
{
  "error": "example",
  "message": "example"
}