POST
/
api
/
v1
/
renderers
/
pdf
/
async
curl --request POST \
  --url https://vortexpdf.com/api/v1/renderers/pdf/async \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "emulate_media_type": "print",
  "evaluate_js": {
    "expression": "<string>"
  },
  "footer_template": "<string>",
  "header_template": "<string>",
  "include_backgrounds": true,
  "margin": {
    "bottom": 10,
    "left": 10,
    "right": 10,
    "top": 10,
    "unit": "mm"
  },
  "orientation": "portrait",
  "output_format": "pdf/a",
  "pages": "",
  "parts": [
    "https://example.com",
    "<h1>Hello World</h1>",
    {
      "content": "<div>Structured HTML content</div>",
      "type": "html"
    },
    {
      "content": {
        "context": {
          "customer_name": "Acme Inc."
        },
        "template_id": "invoice_template"
      },
      "type": "template"
    }
  ],
  "prefer_css_page_size": false,
  "render_header_footer": false,
  "scale": 1,
  "set_cookie": {
    "domain": "<string>",
    "name": "<string>",
    "value": "<string>"
  },
  "size": "a4",
  "wait_for": {
    "attribute": "<string>",
    "selector": "<string>"
  },
  "callback": {
    "headers": {},
    "url": "<string>"
  },
  "destination": {
    "bucket": "my-bucket",
    "path": "pdfs/document.pdf",
    "provider": "aws_s3"
  }
}'
{
  "status": "success"
}

Authorizations

​
Authorization
string
header
required

Manage your API keys at https://vortexpdf.com/api-keys

Body

application/json

Render async options

Options for asynchronous PDF rendering, where the rendering happens in the background and the result is stored in the specified destination. Common options for configuring PDF rendering behavior, applicable to both synchronous and asynchronous rendering.

Response

200
application/json

Success

Standard success response