Invoke an operation | Runstamp Docs

POST/api/v2/operations/{domain}/{verb}

Canonical durable managed invocation boundary. Inline JSON request bodies have a 4 MiB (4194304-byte) maximum, measured on the raw request body (base64 inflates binary by about a third, so inline documents are limited to roughly 3 MiB before encoding); larger bodies return 413 ERR_PAYLOAD_TOO_LARGE. Self-hosted deployments allow inline bodies up to 10 MiB (10485760 bytes). The official SDK keeps canonical envelopes through 768 KiB (786432 bytes) inline and automatically stages larger envelopes through the 192 MiB (201326592-byte) staged-input boundary. The final common operation envelope is read from the execution result resource.

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.

Path parameters

domain string required
verb string required: Technical verb plus optional slash-separated qualifier segments.

Body parameters

Supply either an inline invocation request body of at most 4 MiB (4194304 bytes, measured on the raw request body) or a staged_input reference to a canonical envelope through 192 MiB (201326592 bytes). The official SDK automatically stages canonical envelopes larger than 768 KiB (786432 bytes).

input any one of
staged_input object one of: Finalization reference for an already uploaded immutable CanonicalOperationExecutionEnvelope.
options object optional: Descriptor-defined operation options. Native PPTX, DOCX, XLSX, and PDF render operations also accept preflightPolicy as a managed execution option.
options.preflightPolicy object optional: Caller render-score floor. The managed worker applies the stricter of this value and the execution's frozen delivery-policy value.

Response

202 Accepted Operation accepted for durable asynchronous execution.

Headers

Location string required: Relative execution status URL.

Body

id string (uuid) required
status enum required: queued running succeeded failed blocked cancelling cancelled
status_url string required
result_url string required
reused boolean required

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 '{"input":"BASE64_DOCUMENT_BYTES"}' \
https://runstamp.com/api/v2/operations/pdf/validate

import { managed, Runstamp } from "@runstamp/sdk";

const runstamp = new Runstamp({
  transport: managed({ apiKey: process.env.RUNSTAMP_API_KEY! }),
});

const result = await runstamp.run("pdf.validate", pdfBytes);

Response 202 Accepted

JSON

{
  "id": "8f4fa0a3-f907-41f5-babe-5762f974cb83",
  "status": "queued",
  "status_url": "/api/v2/executions/8f4fa0a3-f907-41f5-babe-5762f974cb83",
  "result_url": "/api/v2/executions/8f4fa0a3-f907-41f5-babe-5762f974cb83/result",
  "reused": false
}

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

input any one of

staged_input object one of

Finalization reference for an already uploaded immutable CanonicalOperationExecutionEnvelope.

options object optional

Descriptor-defined operation options. Native PPTX, DOCX, XLSX, and PDF render operations also accept preflightPolicy as a managed execution option.

options.preflightPolicy object optional

Caller render-score floor. The managed worker applies the stricter of this value and the execution's frozen delivery-policy value.

Response

202 Accepted Operation accepted for durable asynchronous execution.

Headers

Location string required

Relative execution status URL.

Body

id string (uuid) required

status enum required

queued running succeeded failed blocked cancelling cancelled

status_url string required

result_url string required

reused boolean required

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 '{"input":"BASE64_DOCUMENT_BYTES"}' \ https://runstamp.com/api/v2/operations/pdf/validate

import { managed, Runstamp } from "@runstamp/sdk"; const runstamp = new Runstamp({ transport: managed({ apiKey: process.env.RUNSTAMP_API_KEY! }), }); const result = await runstamp.run("pdf.validate", pdfBytes);

{ "id": "8f4fa0a3-f907-41f5-babe-5762f974cb83", "status": "queued", "status_url": "/api/v2/executions/8f4fa0a3-f907-41f5-babe-5762f974cb83", "result_url": "/api/v2/executions/8f4fa0a3-f907-41f5-babe-5762f974cb83/result", "reused": false }