Submit a render | Runstamp Docs

POST/api/v2/render

A requested mode of sync is recorded but does not make the response synchronous.

Headers

Authorization string required

Bearer pj_live_… Raw keys are shown only when created. The x-api-key header is an alternative transport.

Key scope: execution:submit.

Idempotency-Key string required

1-255 visible ASCII characters. Reuse with an identical immutable request returns the original execution with reused=true; reuse with a different request hash returns 409 IDEMPOTENCY_CONFLICT.

Body parameters

format enum required: pptx docx xlsx pdf
document any required
mode enum optional: sync async
holdUntilRelease boolean optional: Hold produced artifacts until exact release authority exists.
requiredVerificationStages array of enum optional: valid preserved intendedChangeVerified deliveryReady
maximumLossSeverity enum optional: none substituted degraded dropped
approvalRequired boolean optional deprecated: Compatibility alias for holdUntilRelease.
preflightPolicy object optional
sourceSchema const "protocol_v2" optional: Accepted only when format is pptx.
brandPackId string (uuid) optional
brandPackVersionId string (uuid) optional

Response

202 Accepted Accepted for asynchronous execution.

Headers

Location string required: Relative execution status URL.

Body

execution_id string (uuid) required
execution_url string required
status enum required: queued running succeeded failed blocked cancelling cancelled
request_hash string (sha256) required
reused boolean required
mode_requested enum required: sync async
artifact_count integer optional
brand_compliance object optional
brand_pack_application array of object optional

Errors

Status	When
`400`	Invalid request.
`401`	Missing, invalid, unentitled, or no-longer-accepted API key.
`403`	The key lacks the required execution scope.
`404`	The organization/environment-scoped resource was not found.
`409`	The same environment-bound idempotency key was previously used for a different immutable request hash.
`413`	The request exceeds its published byte boundary.
`429`	Finite rate limit or durable hosted quota refused the request.
`503`	Launch control is held or execution authority is unavailable.

curl -X POST \
  -H "Authorization: Bearer pj_live_YOUR_KEY" \
  -H "Idempotency-Key: YOUR_UNIQUE_REQUEST_KEY" \
  -H "Content-Type: application/json" \
  -d '{"format":"pptx","document":{"version":"2.0","title":"Customer deliverable","slides":[]}}' \
https://runstamp.com/api/v2/render

Response 202 Accepted

JSON

{
  "execution_id": "8f4fa0a3-f907-41f5-babe-5762f974cb83",
  "execution_url": "/api/v2/executions/8f4fa0a3-f907-41f5-babe-5762f974cb83",
  "status": "queued",
  "request_hash": "9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08",
  "reused": false,
  "mode_requested": "sync"
}

Headers

Authorization string required

Bearer pj_live_… Raw keys are shown only when created. The x-api-key header is an alternative transport.

Key scope: execution:submit.

Idempotency-Key string required

1-255 visible ASCII characters. Reuse with an identical immutable request returns the original execution with reused=true; reuse with a different request hash returns 409 IDEMPOTENCY_CONFLICT.

Body parameters

format enum required

pptx docx xlsx pdf

document any required

mode enum optional

sync async

holdUntilRelease boolean optional

Hold produced artifacts until exact release authority exists.

requiredVerificationStages array of enum optional

valid preserved intendedChangeVerified deliveryReady

maximumLossSeverity enum optional

none substituted degraded dropped

approvalRequired boolean optional deprecated

Compatibility alias for holdUntilRelease.

preflightPolicy object optional

sourceSchema const "protocol_v2" optional

Accepted only when format is pptx.

brandPackId string (uuid) optional

brandPackVersionId string (uuid) optional

Response

202 Accepted Accepted for asynchronous execution.

Headers

Location string required

Relative execution status URL.

Body

execution_id string (uuid) required

execution_url string required

status enum required

queued running succeeded failed blocked cancelling cancelled

request_hash string (sha256) required

reused boolean required

mode_requested enum required

sync async

artifact_count integer optional

brand_compliance object optional

brand_pack_application array of object optional

Errors

Status	When
`400`	Invalid request.
`401`	Missing, invalid, unentitled, or no-longer-accepted API key.
`403`	The key lacks the required execution scope.
`404`	The organization/environment-scoped resource was not found.
`409`	The same environment-bound idempotency key was previously used for a different immutable request hash.
`413`	The request exceeds its published byte boundary.
`429`	Finite rate limit or durable hosted quota refused the request.
`503`	Launch control is held or execution authority is unavailable.

curl -X POST \ -H "Authorization: Bearer pj_live_YOUR_KEY" \ -H "Idempotency-Key: YOUR_UNIQUE_REQUEST_KEY" \ -H "Content-Type: application/json" \ -d '{"format":"pptx","document":{"version":"2.0","title":"Customer deliverable","slides":[]}}' \ https://runstamp.com/api/v2/render

{ "execution_id": "8f4fa0a3-f907-41f5-babe-5762f974cb83", "execution_url": "/api/v2/executions/8f4fa0a3-f907-41f5-babe-5762f974cb83", "status": "queued", "request_hash": "9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08", "reused": false, "mode_requested": "sync" }