Rendering

Synchronously renders a watermarked PDF preview

POST/api/renderings/preview

Synchronously renders a watermarked PDF preview

curl --request POST \
  --url 'https://app.output.rocks/api/renderings/preview' \
  --header 'X-AUTH-TOKEN: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '{
  "template": "my-invoice",
  "data": {
    "invoiceNumber": "123456"
  },
  "metadata": {
    "reference": "my-reference-123"
  },
  "externalId": "external-id",
  "comment": "Preview before sending",
  "staticAttachments": [
    {
      "fileName": "terms.pdf",
      "content": "JVBERi0x..."
    }
  ]
}'

200

application/pdf

"string"

Authorizations

X-AUTH-TOKEN

stringheaderrequired

Value for the X-AUTH-TOKEN header parameter.

Request Body

application/json

required

The new RenderingPreview resource

{
  "template": "my-invoice",
  "data": {
    "invoiceNumber": "123456"
  },
  "metadata": {
    "reference": "my-reference-123"
  },
  "externalId": "external-id",
  "comment": "Preview before sending",
  "staticAttachments": [
    {
      "fileName": "terms.pdf",
      "content": "JVBERi0x..."
    }
  ]
}

Response

200application/pdf

Watermarked PDF preview.