Raw schema
{
"type": "object",
"properties": {
"document_content": {
"description": "The HTML/XML source to render. Use this OR document_url.",
"type": "string"
},
"document_url": {
"description": "A URL DocRaptor will fetch and render. Use this OR document_content.",
"type": "string"
},
"type": {
"description": "Output format: pdf (default), xls, or xlsx.",
"type": "string",
"enum": [
"pdf",
"xls",
"xlsx"
]
},
"name": {
"description": "A name for the document (<=200 chars), shown in the DocRaptor dashboard/listing.",
"type": "string",
"maxLength": 200
},
"test": {
"default": true,
"description": "Default true: generate a FREE test document (watermarked PDF or Excel limited to 20 rows). Set false explicitly for a real, BILLED document.",
"type": "boolean"
},
"hosted": {
"description": "Default true for synchronous requests, false for async. Requires the paid hosted-documents add-on; each download may be billed. Set false for raw base64 output without the add-on.",
"type": "boolean"
},
"async": {
"description": "If true, enqueue the job and return a status_id (poll with docraptor_get_document_status). Best for large/slow documents. Default false.",
"type": "boolean"
},
"hosted_download_limit": {
"description": "For hosted docs: max number of downloads before the link expires.",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"hosted_expires_at": {
"description": "For hosted docs: ISO 8601 datetime when the hosted link expires.",
"type": "string"
},
"pipeline": {
"description": "Rendering pipeline/engine version, e.g. '10'. Omit to use DocRaptor's default.",
"type": "string"
},
"tag": {
"description": "An arbitrary tag string for your own reporting/grouping.",
"type": "string"
},
"javascript": {
"description": "Enable DocRaptor's JavaScript engine (default false), recommended for Typekit and Highcharts. Separate from prince_options.javascript; usually enable only one engine.",
"type": "boolean"
},
"strict": {
"description": "PDF HTML validation: html fails on invalid HTML; none disables strict HTML validation.",
"type": "string",
"enum": [
"none",
"html"
]
},
"help": {
"description": "Enable DocRaptor help mode: emails you and DocRaptor support and retains document contents for review until resolved. Maximum five active help requests.",
"type": "boolean"
},
"referrer": {
"description": "Explicit referrer for JavaScript requests, e.g. Typekit with document_content. Defaults to document_url.",
"type": "string"
},
"callback_url": {
"description": "URL DocRaptor POSTs after a successful async job (requires async:true). Failed jobs do not trigger callbacks.",
"type": "string"
},
"ignore_resource_errors": {
"description": "Ignore errors downloading CSS/images (DocRaptor default true). Set false to fail generation on resource errors.",
"type": "boolean"
},
"ignore_console_messages": {
"description": "Ignore JavaScript console messages instead of failing generation. Defaults to false on Pipelines 1–6, true on Pipeline 7+.",
"type": "boolean"
},
"prince_options": {
"type": "object",
"properties": {
"media": {
"description": "CSS media type. \"print\" (default) vs \"screen\".",
"type": "string",
"enum": [
"print",
"screen"
]
},
"javascript": {
"description": "Enable Prince's JavaScript engine (default false), separate from top-level javascript. Usually enable only one engine to avoid running scripts twice.",
"type": "boolean"
},
"baseurl": {
"description": "Base URL for resolving relative asset paths in document_content.",
"type": "string"
},
"pdf_title": {
"description": "Title metadata embedded in the PDF.",
"type": "string"
},
"max_passes": {
"description": "Max Prince layout passes (for JS-driven layouts).",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"version": {
"description": "Deprecated Prince version selector. Prefer the top-level pipeline parameter.",
"type": "string"
},
"no_xinclude": {
"description": "Disable XInclude processing.",
"type": "boolean"
},
"no_network": {
"description": "Disable network access and HTTP downloads.",
"type": "boolean"
},
"no_parallel_downloads": {
"description": "Fetch assets sequentially, useful for hosts with strict rate limits.",
"type": "boolean"
},
"http_user": {
"description": "Username for HTTP authentication when fetching resources.",
"type": "string"
},
"http_password": {
"description": "Password for HTTP authentication when fetching resources.",
"type": "string"
},
"http_proxy": {
"description": "HTTP proxy server used to fetch resources.",
"type": "string"
},
"http_timeout": {
"description": "External resource request timeout in seconds (1–60; DocRaptor default 10).",
"type": "integer",
"minimum": 1,
"maximum": 60
},
"insecure": {
"description": "Disable SSL verification for resource downloads (not recommended).",
"type": "boolean"
},
"no_author_style": {
"description": "Ignore author style sheets.",
"type": "boolean"
},
"no_default_style": {
"description": "Ignore default style sheets.",
"type": "boolean"
},
"no_embed_fonts": {
"description": "Disable font embedding in PDF output.",
"type": "boolean"
},
"no_subset_fonts": {
"description": "Disable font subsetting in PDF output.",
"type": "boolean"
},
"no_compress": {
"description": "Disable PDF output compression.",
"type": "boolean"
},
"encrypt": {
"description": "Encrypt PDF output.",
"type": "boolean"
},
"key_bits": {
"description": "PDF encryption key size: 40 or 128 bits.",
"anyOf": [
{
"type": "number",
"const": 40
},
{
"type": "number",
"const": 128
}
]
},
"user_password": {
"description": "PDF user password, required to open the encrypted document.",
"type": "string"
},
"owner_password": {
"description": "PDF owner password for controlling document permissions.",
"type": "string"
},
"disallow_print": {
"description": "Disallow printing the PDF.",
"type": "boolean"
},
"disallow_copy": {
"description": "Disallow copying PDF content.",
"type": "boolean"
},
"allow_copy_for_accessibility": {
"description": "Allow accessibility copying even when disallow_copy is true (Pipeline 9+).",
"type": "boolean"
},
"disallow_annotate": {
"description": "Disallow PDF annotations.",
"type": "boolean"
},
"disallow_modify": {
"description": "Disallow PDF modifications.",
"type": "boolean"
},
"allow_assembly": {
"description": "Allow document assembly even when disallow_modify is true (Pipeline 9+).",
"type": "boolean"
},
"input": {
"description": "Input format used by Prince.",
"type": "string",
"enum": [
"html",
"xml",
"auto"
]
},
"css_dpi": {
"description": "CSS pixel resolution in dots per inch (DocRaptor default 96).",
"type": "number",
"exclusiveMinimum": 0
},
"profile": {
"description": "PDF conformance profile (PDF/A, PDF/UA, or PDF/X). Supported profiles depend on the pipeline.",
"type": "string",
"enum": [
"PDF/A-1a",
"PDF/A-1a+PDF/UA-1",
"PDF/A-1b",
"PDF/A-2a",
"PDF/A-2a+PDF/UA-1",
"PDF/A-2b",
"PDF/A-3a",
"PDF/A-3a+PDF/UA-1",
"PDF/A-3b",
"PDF/UA-1",
"PDF/X-1a:2001",
"PDF/X-1a:2003",
"PDF/X-3:2002",
"PDF/X-3:2003",
"PDF/X-4"
]
}
},
"description": "PDF engine (Prince) options. PDF only."
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema"
}