MCP server for Api2Pdf — generate PDFs & images from HTML, URLs or office files; merge, barcodes.
Maintain this server? Claim it
Call this server's tools from your browser. Nothing to install.
Requests go through mcptry because browsers can't call most MCP servers directly. Header values are sent to the server for that request only and are never stored or logged.
Tool list from our last check. Connect live to refresh it.
Encrypt an existing PDF (given as a URL) with a user password (required to open) and an optional owner password (controls permissions). Returns a { FileUrl } (valid ~24h). BILLED. Api2Pdf API: POST /pdfsharp/password.
URL of the PDF to protect.
Password required to OPEN the resulting PDF.
If true (Api2Pdf default), the generated file is served inline; if false, as an attachment.
Engine-specific render options (page size, margins, orientation, headers/footers, etc.). Passed through verbatim to Api2Pdf.
Custom storage target, used when useCustomStorage is true.
A name for the generated file, e.g. 'invoice.pdf'.
If true, return the raw file bytes as base64 instead of a FileUrl. Default false (recommended for agents — returns a short-lived link).
Optional owner password controlling permissions (printing, editing, etc.).
Extra HTTP headers Api2Pdf forwards when it fetches a source URL (e.g. auth for a protected page/file).
If true, Api2Pdf uploads the result to your own storage (see `storage`) instead of hosting it.
The server marks this tool as destructive. Running it may delete or overwrite data on the server or in any account you connected with your headers.
Encrypt an existing PDF (given as a URL) with a user password (required to open) and an optional owner password (controls permissions). Returns a { FileUrl } (valid ~24h). BILLED. Api2Pdf API: POST /pdfsharp/password.
| Argument | Type | Description |
|---|---|---|
| url* | string | URL of the PDF to protect. |
| inline | boolean | If true (Api2Pdf default), the generated file is served inline; if false, as an attachment. |
| options | object | Engine-specific render options (page size, margins, orientation, headers/footers, etc.). Passed through verbatim to Api2Pdf. |
| storage | object | Custom storage target, used when useCustomStorage is true. |
| fileName | string | A name for the generated file, e.g. 'invoice.pdf'. |
| userpassword* | string | Password required to OPEN the resulting PDF. |
| output_binary | boolean | If true, return the raw file bytes as base64 instead of a FileUrl. Default false (recommended for agents — returns a short-lived link). |
| ownerpassword | string | Optional owner password controlling permissions (printing, editing, etc.). |
| extraHTTPHeaders | object | Extra HTTP headers Api2Pdf forwards when it fetches a source URL (e.g. auth for a protected page/file). |
| useCustomStorage | boolean | If true, Api2Pdf uploads the result to your own storage (see `storage`) instead of hosting it. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"url",
"userpassword"
],
"properties": {
"url": {
"type": "string",
"description": "URL of the PDF to protect."
},
"inline": {
"type": "boolean",
"description": "If true (Api2Pdf default), the generated file is served inline; if false, as an attachment."
},
"options": {
"type": "object",
"description": "Engine-specific render options (page size, margins, orientation, headers/footers, etc.). Passed through verbatim to Api2Pdf.",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
"storage": {
"type": "object",
"properties": {
"url": {
"type": "string",
"description": "Pre-signed destination URL for the upload."
},
"method": {
"type": "string",
"description": "HTTP method Api2Pdf uses to upload (e.g. 'PUT')."
}
},
"description": "Custom storage target, used when useCustomStorage is true."
},
"fileName": {
"type": "string",
"description": "A name for the generated file, e.g. 'invoice.pdf'."
},
"userpassword": {
"type": "string",
"description": "Password required to OPEN the resulting PDF."
},
"output_binary": {
"type": "boolean",
"description": "If true, return the raw file bytes as base64 instead of a FileUrl. Default false (recommended for agents — returns a short-lived link)."
},
"ownerpassword": {
"type": "string",
"description": "Optional owner password controlling permissions (printing, editing, etc.)."
},
"extraHTTPHeaders": {
"type": "object",
"description": "Extra HTTP headers Api2Pdf forwards when it fetches a source URL (e.g. auth for a protected page/file).",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"type": "string"
}
},
"useCustomStorage": {
"type": "boolean",
"description": "If true, Api2Pdf uploads the result to your own storage (see `storage`) instead of hosting it."
}
}
}Compress an existing PDF (given as a URL) to reduce its file size. Returns a { FileUrl } (valid ~24h). BILLED. Api2Pdf API: POST /pdfsharp/compress.
| Argument | Type | Description |
|---|---|---|
| url* | string | URL of the PDF to compress. |
| inline | boolean | If true (Api2Pdf default), the generated file is served inline; if false, as an attachment. |
| options | object | Engine-specific render options (page size, margins, orientation, headers/footers, etc.). Passed through verbatim to Api2Pdf. |
| storage | object | Custom storage target, used when useCustomStorage is true. |
| fileName | string | A name for the generated file, e.g. 'invoice.pdf'. |
| output_binary | boolean | If true, return the raw file bytes as base64 instead of a FileUrl. Default false (recommended for agents — returns a short-lived link). |
| extraHTTPHeaders | object | Extra HTTP headers Api2Pdf forwards when it fetches a source URL (e.g. auth for a protected page/file). |
| useCustomStorage |
Convert a document or file (given as a URL — PDF, Office docs, and more) to Markdown text via MarkItDown. Great for feeding a document's contents back to an agent. Returns a { FileUrl } (valid ~24h). BILLED. Api2Pdf API: POST /markitdown.
| Argument | Type | Description |
|---|---|---|
| url* | string | URL of the document/file to convert to Markdown. |
| inline | boolean | If true (Api2Pdf default), the generated file is served inline; if false, as an attachment. |
| options | object | Engine-specific render options (page size, margins, orientation, headers/footers, etc.). Passed through verbatim to Api2Pdf. |
| storage | object | Custom storage target, used when useCustomStorage is true. |
| fileName | string | A name for the generated file, e.g. 'invoice.pdf'. |
| output_binary | boolean | If true, return the raw file bytes as base64 instead of a FileUrl. Default false (recommended for agents — returns a short-lived link). |
| extraHTTPHeaders | object | Extra HTTP headers Api2Pdf forwards when it fetches a source URL (e.g. auth for a protected page/file). |
Delete a previously generated file by its ResponseId (the `ResponseId` returned in a generation response). Api2Pdf API: DELETE /file/{ResponseId}.
| Argument | Type | Description |
|---|---|---|
| responseId* | string | The ResponseId of the generated file to delete (from a prior generation response). |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"responseId"
],
"properties": {
"responseId": {
"type": "string",
"description": "The ResponseId of the generated file to delete (from a prior generation response)."
}
}
}Extract a range of pages from an existing PDF (given as a URL) into a new PDF. `start`/`end` are 0-based page indices; omit `end` to extract a single page. Returns a { FileUrl } (valid ~24h). BILLED. Api2Pdf API: POST /pdfsharp/extract-pages.
| Argument | Type | Description |
|---|---|---|
| end | integer | 0-based index of the last page to extract. Omit for a single page (just `start`). |
| url* | string | URL of the source PDF. |
| start | integer | 0-based index of the first page to extract. Default 0. |
| inline | boolean | If true (Api2Pdf default), the generated file is served inline; if false, as an attachment. |
| options | object | Engine-specific render options (page size, margins, orientation, headers/footers, etc.). Passed through verbatim to Api2Pdf. |
| storage | object | Custom storage target, used when useCustomStorage is true. |
| fileName | string | A name for the generated file, e.g. 'invoice.pdf'. |
| output_binary | boolean | If true, return the raw file bytes as base64 instead of a FileUrl. Default false (recommended for agents — returns a short-lived link). |
Generate a barcode or QR code image. `format` is the symbology (e.g. 'QRCode', 'Code128', 'PDF417', 'DataMatrix') and `value` is the string to encode. Returns a { FileUrl } (valid ~24h) by default, or base64 with output_binary:true. BILLED. Api2Pdf API: GET /zebra.
| Argument | Type | Description |
|---|---|---|
| value* | string | The string to encode in the barcode/QR code. |
| width | integer | Image width in pixels. |
| format* | string | Barcode/QR symbology, e.g. 'QRCode', 'Code128', 'PDF417', 'DataMatrix'. |
| height | integer | Image height in pixels. |
| showlabel | boolean | If true, render the encoded value as a human-readable label under the barcode. |
| output_binary | boolean | If true, return the raw image bytes as base64 instead of a FileUrl. Default false. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"format",
"value"
],
"properties": {
"value": {
"type": "string",
"description": "The string to encode in the barcode/QR code."
},
"width": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Image width in pixels.",
"exclusiveMinimum": 0
},
"format": {
"type": "string",
"description": "Barcode/QR symbology, e.g. 'QRCode', 'Code128', 'PDF417', 'DataMatrix'."
},
"height": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Image height in pixels.",
"exclusiveMinimum": 0
},
"showlabel": {
"type": "boolean",
"description": "If true, render the encoded value as a human-readable label under the barcode."
},
"output_binary": {
"type": "boolean",
"description": "If true, return the raw image bytes as base64 instead of a FileUrl. Default false."
}
}
}Return the remaining balance / usage for the configured Api2Pdf account. Api2Pdf API: GET /balance.
No arguments.
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {}
}Return the current Api2Pdf service / health status. Api2Pdf API: GET /status.
No arguments.
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {}
}Render an HTML string to an image using headless Chrome. Returns a { FileUrl } (valid ~24h) by default, or base64 bytes with output_binary:true. BILLED. Api2Pdf API: POST /chrome/image/html.
| Argument | Type | Description |
|---|---|---|
| html* | string | The HTML source to render into an image. |
| inline | boolean | If true (Api2Pdf default), the generated file is served inline; if false, as an attachment. |
| options | object | Engine-specific render options (page size, margins, orientation, headers/footers, etc.). Passed through verbatim to Api2Pdf. |
| storage | object | Custom storage target, used when useCustomStorage is true. |
| fileName | string | A name for the generated file, e.g. 'invoice.pdf'. |
| output_binary | boolean | If true, return the raw file bytes as base64 instead of a FileUrl. Default false (recommended for agents — returns a short-lived link). |
| extraHTTPHeaders | object | Extra HTTP headers Api2Pdf forwards when it fetches a source URL (e.g. auth for a protected page/file). |
Render an HTML string to a PDF using the headless-Chrome engine. Returns a { FileUrl } link (valid ~24h) by default. Great for invoices, reports, and letters produced as HTML. BILLED per document. Api2Pdf API: POST /chrome/pdf/html.
| Argument | Type | Description |
|---|---|---|
| html* | string | The HTML source to render into a PDF. |
| inline | boolean | If true (Api2Pdf default), the generated file is served inline; if false, as an attachment. |
| options | object | Engine-specific render options (page size, margins, orientation, headers/footers, etc.). Passed through verbatim to Api2Pdf. |
| storage | object | Custom storage target, used when useCustomStorage is true. |
| fileName | string | A name for the generated file, e.g. 'invoice.pdf'. |
| output_binary | boolean | If true, return the raw file bytes as base64 instead of a FileUrl. Default false (recommended for agents — returns a short-lived link). |
| extraHTTPHeaders | object | Extra HTTP headers Api2Pdf forwards when it fetches a source URL (e.g. auth for a protected page/file). |
Render a Markdown string to a PDF using headless Chrome. Returns a { FileUrl } (valid ~24h). BILLED. Api2Pdf API: POST /chrome/pdf/markdown.
| Argument | Type | Description |
|---|---|---|
| inline | boolean | If true (Api2Pdf default), the generated file is served inline; if false, as an attachment. |
| options | object | Engine-specific render options (page size, margins, orientation, headers/footers, etc.). Passed through verbatim to Api2Pdf. |
| storage | object | Custom storage target, used when useCustomStorage is true. |
| fileName | string | A name for the generated file, e.g. 'invoice.pdf'. |
| markdown* | string | The Markdown source to render into a PDF. |
| output_binary | boolean | If true, return the raw file bytes as base64 instead of a FileUrl. Default false (recommended for agents — returns a short-lived link). |
| extraHTTPHeaders | object | Extra HTTP headers Api2Pdf forwards when it fetches a source URL (e.g. auth for a protected page/file). |
| useCustomStorage |
Merge several existing PDFs (given as URLs, in order) into a single PDF. Returns a { FileUrl } (valid ~24h). BILLED. Api2Pdf API: POST /pdfsharp/merge.
| Argument | Type | Description |
|---|---|---|
| urls* | array | URLs of the PDFs to merge, in the order they should appear (at least two). |
| inline | boolean | If true (Api2Pdf default), the generated file is served inline; if false, as an attachment. |
| options | object | Engine-specific render options (page size, margins, orientation, headers/footers, etc.). Passed through verbatim to Api2Pdf. |
| storage | object | Custom storage target, used when useCustomStorage is true. |
| fileName | string | A name for the generated file, e.g. 'invoice.pdf'. |
| output_binary | boolean | If true, return the raw file bytes as base64 instead of a FileUrl. Default false (recommended for agents — returns a short-lived link). |
| extraHTTPHeaders | object | Extra HTTP headers Api2Pdf forwards when it fetches a source URL (e.g. auth for a protected page/file). |
| useCustomStorage |
Convert an office document (Word, Excel, PowerPoint, ODT, and many more) at a URL to a PDF using LibreOffice. Returns a { FileUrl } (valid ~24h). BILLED. Api2Pdf API: POST /libreoffice/any-to-pdf.
| Argument | Type | Description |
|---|---|---|
| url* | string | URL of the source document to convert to PDF. |
| inline | boolean | If true (Api2Pdf default), the generated file is served inline; if false, as an attachment. |
| options | object | Engine-specific render options (page size, margins, orientation, headers/footers, etc.). Passed through verbatim to Api2Pdf. |
| storage | object | Custom storage target, used when useCustomStorage is true. |
| fileName | string | A name for the generated file, e.g. 'invoice.pdf'. |
| output_binary | boolean | If true, return the raw file bytes as base64 instead of a FileUrl. Default false (recommended for agents — returns a short-lived link). |
| extraHTTPHeaders | object | Extra HTTP headers Api2Pdf forwards when it fetches a source URL (e.g. auth for a protected page/file). |
Take a screenshot of a live web page by URL using headless Chrome. Returns a { FileUrl } (valid ~24h). BILLED. Api2Pdf API: POST /chrome/image/url.
| Argument | Type | Description |
|---|---|---|
| url* | string | The URL of the web page to screenshot. |
| inline | boolean | If true (Api2Pdf default), the generated file is served inline; if false, as an attachment. |
| options | object | Engine-specific render options (page size, margins, orientation, headers/footers, etc.). Passed through verbatim to Api2Pdf. |
| storage | object | Custom storage target, used when useCustomStorage is true. |
| fileName | string | A name for the generated file, e.g. 'invoice.pdf'. |
| output_binary | boolean | If true, return the raw file bytes as base64 instead of a FileUrl. Default false (recommended for agents — returns a short-lived link). |
| extraHTTPHeaders | object | Extra HTTP headers Api2Pdf forwards when it fetches a source URL (e.g. auth for a protected page/file). |
| useCustomStorage |
Fetch a web page by URL and render it to a PDF using headless Chrome. Returns a { FileUrl } (valid ~24h). Use extraHTTPHeaders to pass auth for a protected page. BILLED. Api2Pdf API: POST /chrome/pdf/url.
| Argument | Type | Description |
|---|---|---|
| url* | string | The URL of the web page Api2Pdf will fetch and render to PDF. |
| inline | boolean | If true (Api2Pdf default), the generated file is served inline; if false, as an attachment. |
| options | object | Engine-specific render options (page size, margins, orientation, headers/footers, etc.). Passed through verbatim to Api2Pdf. |
| storage | object | Custom storage target, used when useCustomStorage is true. |
| fileName | string | A name for the generated file, e.g. 'invoice.pdf'. |
| output_binary | boolean | If true, return the raw file bytes as base64 instead of a FileUrl. Default false (recommended for agents — returns a short-lived link). |
| extraHTTPHeaders | object | Extra HTTP headers Api2Pdf forwards when it fetches a source URL (e.g. auth for a protected page/file). |
Render an HTML string to a PDF using the wkhtmltopdf engine — an alternate to Chrome that supports a table of contents (pass enableToc / tocOptions inside `options`). Returns a { FileUrl } (valid ~24h). BILLED. Api2Pdf API: POST /wkhtml/pdf/html.
| Argument | Type | Description |
|---|---|---|
| html* | string | The HTML source to render into a PDF. |
| inline | boolean | If true (Api2Pdf default), the generated file is served inline; if false, as an attachment. |
| options | object | Engine-specific render options (page size, margins, orientation, headers/footers, etc.). Passed through verbatim to Api2Pdf. |
| storage | object | Custom storage target, used when useCustomStorage is true. |
| fileName | string | A name for the generated file, e.g. 'invoice.pdf'. |
| output_binary | boolean | If true, return the raw file bytes as base64 instead of a FileUrl. Default false (recommended for agents — returns a short-lived link). |
| extraHTTPHeaders | object | Extra HTTP headers Api2Pdf forwards when it fetches a source URL (e.g. auth for a protected page/file). |
| boolean |
| If true, Api2Pdf uploads the result to your own storage (see `storage`) instead of hosting it. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"url"
],
"properties": {
"url": {
"type": "string",
"description": "URL of the PDF to compress."
},
"inline": {
"type": "boolean",
"description": "If true (Api2Pdf default), the generated file is served inline; if false, as an attachment."
},
"options": {
"type": "object",
"description": "Engine-specific render options (page size, margins, orientation, headers/footers, etc.). Passed through verbatim to Api2Pdf.",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
"storage": {
"type": "object",
"properties": {
"url": {
"type": "string",
"description": "Pre-signed destination URL for the upload."
},
"method": {
"type": "string",
"description": "HTTP method Api2Pdf uses to upload (e.g. 'PUT')."
}
},
"description": "Custom storage target, used when useCustomStorage is true."
},
"fileName": {
"type": "string",
"description": "A name for the generated file, e.g. 'invoice.pdf'."
},
"output_binary": {
"type": "boolean",
"description": "If true, return the raw file bytes as base64 instead of a FileUrl. Default false (recommended for agents — returns a short-lived link)."
},
"extraHTTPHeaders": {
"type": "object",
"description": "Extra HTTP headers Api2Pdf forwards when it fetches a source URL (e.g. auth for a protected page/file).",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"type": "string"
}
},
"useCustomStorage": {
"type": "boolean",
"description": "If true, Api2Pdf uploads the result to your own storage (see `storage`) instead of hosting it."
}
}
}| useCustomStorage | boolean | If true, Api2Pdf uploads the result to your own storage (see `storage`) instead of hosting it. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"url"
],
"properties": {
"url": {
"type": "string",
"description": "URL of the document/file to convert to Markdown."
},
"inline": {
"type": "boolean",
"description": "If true (Api2Pdf default), the generated file is served inline; if false, as an attachment."
},
"options": {
"type": "object",
"description": "Engine-specific render options (page size, margins, orientation, headers/footers, etc.). Passed through verbatim to Api2Pdf.",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
"storage": {
"type": "object",
"properties": {
"url": {
"type": "string",
"description": "Pre-signed destination URL for the upload."
},
"method": {
"type": "string",
"description": "HTTP method Api2Pdf uses to upload (e.g. 'PUT')."
}
},
"description": "Custom storage target, used when useCustomStorage is true."
},
"fileName": {
"type": "string",
"description": "A name for the generated file, e.g. 'invoice.pdf'."
},
"output_binary": {
"type": "boolean",
"description": "If true, return the raw file bytes as base64 instead of a FileUrl. Default false (recommended for agents — returns a short-lived link)."
},
"extraHTTPHeaders": {
"type": "object",
"description": "Extra HTTP headers Api2Pdf forwards when it fetches a source URL (e.g. auth for a protected page/file).",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"type": "string"
}
},
"useCustomStorage": {
"type": "boolean",
"description": "If true, Api2Pdf uploads the result to your own storage (see `storage`) instead of hosting it."
}
}
}| extraHTTPHeaders | object | Extra HTTP headers Api2Pdf forwards when it fetches a source URL (e.g. auth for a protected page/file). |
| useCustomStorage | boolean | If true, Api2Pdf uploads the result to your own storage (see `storage`) instead of hosting it. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"url"
],
"properties": {
"end": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0,
"description": "0-based index of the last page to extract. Omit for a single page (just `start`)."
},
"url": {
"type": "string",
"description": "URL of the source PDF."
},
"start": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0,
"description": "0-based index of the first page to extract. Default 0."
},
"inline": {
"type": "boolean",
"description": "If true (Api2Pdf default), the generated file is served inline; if false, as an attachment."
},
"options": {
"type": "object",
"description": "Engine-specific render options (page size, margins, orientation, headers/footers, etc.). Passed through verbatim to Api2Pdf.",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
"storage": {
"type": "object",
"properties": {
"url": {
"type": "string",
"description": "Pre-signed destination URL for the upload."
},
"method": {
"type": "string",
"description": "HTTP method Api2Pdf uses to upload (e.g. 'PUT')."
}
},
"description": "Custom storage target, used when useCustomStorage is true."
},
"fileName": {
"type": "string",
"description": "A name for the generated file, e.g. 'invoice.pdf'."
},
"output_binary": {
"type": "boolean",
"description": "If true, return the raw file bytes as base64 instead of a FileUrl. Default false (recommended for agents — returns a short-lived link)."
},
"extraHTTPHeaders": {
"type": "object",
"description": "Extra HTTP headers Api2Pdf forwards when it fetches a source URL (e.g. auth for a protected page/file).",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"type": "string"
}
},
"useCustomStorage": {
"type": "boolean",
"description": "If true, Api2Pdf uploads the result to your own storage (see `storage`) instead of hosting it."
}
}
}| useCustomStorage |
| boolean |
| If true, Api2Pdf uploads the result to your own storage (see `storage`) instead of hosting it. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"html"
],
"properties": {
"html": {
"type": "string",
"description": "The HTML source to render into an image."
},
"inline": {
"type": "boolean",
"description": "If true (Api2Pdf default), the generated file is served inline; if false, as an attachment."
},
"options": {
"type": "object",
"description": "Engine-specific render options (page size, margins, orientation, headers/footers, etc.). Passed through verbatim to Api2Pdf.",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
"storage": {
"type": "object",
"properties": {
"url": {
"type": "string",
"description": "Pre-signed destination URL for the upload."
},
"method": {
"type": "string",
"description": "HTTP method Api2Pdf uses to upload (e.g. 'PUT')."
}
},
"description": "Custom storage target, used when useCustomStorage is true."
},
"fileName": {
"type": "string",
"description": "A name for the generated file, e.g. 'invoice.pdf'."
},
"output_binary": {
"type": "boolean",
"description": "If true, return the raw file bytes as base64 instead of a FileUrl. Default false (recommended for agents — returns a short-lived link)."
},
"extraHTTPHeaders": {
"type": "object",
"description": "Extra HTTP headers Api2Pdf forwards when it fetches a source URL (e.g. auth for a protected page/file).",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"type": "string"
}
},
"useCustomStorage": {
"type": "boolean",
"description": "If true, Api2Pdf uploads the result to your own storage (see `storage`) instead of hosting it."
}
}
}| useCustomStorage |
| boolean |
| If true, Api2Pdf uploads the result to your own storage (see `storage`) instead of hosting it. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"html"
],
"properties": {
"html": {
"type": "string",
"description": "The HTML source to render into a PDF."
},
"inline": {
"type": "boolean",
"description": "If true (Api2Pdf default), the generated file is served inline; if false, as an attachment."
},
"options": {
"type": "object",
"description": "Engine-specific render options (page size, margins, orientation, headers/footers, etc.). Passed through verbatim to Api2Pdf.",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
"storage": {
"type": "object",
"properties": {
"url": {
"type": "string",
"description": "Pre-signed destination URL for the upload."
},
"method": {
"type": "string",
"description": "HTTP method Api2Pdf uses to upload (e.g. 'PUT')."
}
},
"description": "Custom storage target, used when useCustomStorage is true."
},
"fileName": {
"type": "string",
"description": "A name for the generated file, e.g. 'invoice.pdf'."
},
"output_binary": {
"type": "boolean",
"description": "If true, return the raw file bytes as base64 instead of a FileUrl. Default false (recommended for agents — returns a short-lived link)."
},
"extraHTTPHeaders": {
"type": "object",
"description": "Extra HTTP headers Api2Pdf forwards when it fetches a source URL (e.g. auth for a protected page/file).",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"type": "string"
}
},
"useCustomStorage": {
"type": "boolean",
"description": "If true, Api2Pdf uploads the result to your own storage (see `storage`) instead of hosting it."
}
}
}| boolean |
| If true, Api2Pdf uploads the result to your own storage (see `storage`) instead of hosting it. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"markdown"
],
"properties": {
"inline": {
"type": "boolean",
"description": "If true (Api2Pdf default), the generated file is served inline; if false, as an attachment."
},
"options": {
"type": "object",
"description": "Engine-specific render options (page size, margins, orientation, headers/footers, etc.). Passed through verbatim to Api2Pdf.",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
"storage": {
"type": "object",
"properties": {
"url": {
"type": "string",
"description": "Pre-signed destination URL for the upload."
},
"method": {
"type": "string",
"description": "HTTP method Api2Pdf uses to upload (e.g. 'PUT')."
}
},
"description": "Custom storage target, used when useCustomStorage is true."
},
"fileName": {
"type": "string",
"description": "A name for the generated file, e.g. 'invoice.pdf'."
},
"markdown": {
"type": "string",
"description": "The Markdown source to render into a PDF."
},
"output_binary": {
"type": "boolean",
"description": "If true, return the raw file bytes as base64 instead of a FileUrl. Default false (recommended for agents — returns a short-lived link)."
},
"extraHTTPHeaders": {
"type": "object",
"description": "Extra HTTP headers Api2Pdf forwards when it fetches a source URL (e.g. auth for a protected page/file).",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"type": "string"
}
},
"useCustomStorage": {
"type": "boolean",
"description": "If true, Api2Pdf uploads the result to your own storage (see `storage`) instead of hosting it."
}
}
}| boolean |
| If true, Api2Pdf uploads the result to your own storage (see `storage`) instead of hosting it. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"urls"
],
"properties": {
"urls": {
"type": "array",
"items": {
"type": "string"
},
"minItems": 2,
"description": "URLs of the PDFs to merge, in the order they should appear (at least two)."
},
"inline": {
"type": "boolean",
"description": "If true (Api2Pdf default), the generated file is served inline; if false, as an attachment."
},
"options": {
"type": "object",
"description": "Engine-specific render options (page size, margins, orientation, headers/footers, etc.). Passed through verbatim to Api2Pdf.",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
"storage": {
"type": "object",
"properties": {
"url": {
"type": "string",
"description": "Pre-signed destination URL for the upload."
},
"method": {
"type": "string",
"description": "HTTP method Api2Pdf uses to upload (e.g. 'PUT')."
}
},
"description": "Custom storage target, used when useCustomStorage is true."
},
"fileName": {
"type": "string",
"description": "A name for the generated file, e.g. 'invoice.pdf'."
},
"output_binary": {
"type": "boolean",
"description": "If true, return the raw file bytes as base64 instead of a FileUrl. Default false (recommended for agents — returns a short-lived link)."
},
"extraHTTPHeaders": {
"type": "object",
"description": "Extra HTTP headers Api2Pdf forwards when it fetches a source URL (e.g. auth for a protected page/file).",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"type": "string"
}
},
"useCustomStorage": {
"type": "boolean",
"description": "If true, Api2Pdf uploads the result to your own storage (see `storage`) instead of hosting it."
}
}
}| useCustomStorage |
| boolean |
| If true, Api2Pdf uploads the result to your own storage (see `storage`) instead of hosting it. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"url"
],
"properties": {
"url": {
"type": "string",
"description": "URL of the source document to convert to PDF."
},
"inline": {
"type": "boolean",
"description": "If true (Api2Pdf default), the generated file is served inline; if false, as an attachment."
},
"options": {
"type": "object",
"description": "Engine-specific render options (page size, margins, orientation, headers/footers, etc.). Passed through verbatim to Api2Pdf.",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
"storage": {
"type": "object",
"properties": {
"url": {
"type": "string",
"description": "Pre-signed destination URL for the upload."
},
"method": {
"type": "string",
"description": "HTTP method Api2Pdf uses to upload (e.g. 'PUT')."
}
},
"description": "Custom storage target, used when useCustomStorage is true."
},
"fileName": {
"type": "string",
"description": "A name for the generated file, e.g. 'invoice.pdf'."
},
"output_binary": {
"type": "boolean",
"description": "If true, return the raw file bytes as base64 instead of a FileUrl. Default false (recommended for agents — returns a short-lived link)."
},
"extraHTTPHeaders": {
"type": "object",
"description": "Extra HTTP headers Api2Pdf forwards when it fetches a source URL (e.g. auth for a protected page/file).",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"type": "string"
}
},
"useCustomStorage": {
"type": "boolean",
"description": "If true, Api2Pdf uploads the result to your own storage (see `storage`) instead of hosting it."
}
}
}| boolean |
| If true, Api2Pdf uploads the result to your own storage (see `storage`) instead of hosting it. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"url"
],
"properties": {
"url": {
"type": "string",
"description": "The URL of the web page to screenshot."
},
"inline": {
"type": "boolean",
"description": "If true (Api2Pdf default), the generated file is served inline; if false, as an attachment."
},
"options": {
"type": "object",
"description": "Engine-specific render options (page size, margins, orientation, headers/footers, etc.). Passed through verbatim to Api2Pdf.",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
"storage": {
"type": "object",
"properties": {
"url": {
"type": "string",
"description": "Pre-signed destination URL for the upload."
},
"method": {
"type": "string",
"description": "HTTP method Api2Pdf uses to upload (e.g. 'PUT')."
}
},
"description": "Custom storage target, used when useCustomStorage is true."
},
"fileName": {
"type": "string",
"description": "A name for the generated file, e.g. 'invoice.pdf'."
},
"output_binary": {
"type": "boolean",
"description": "If true, return the raw file bytes as base64 instead of a FileUrl. Default false (recommended for agents — returns a short-lived link)."
},
"extraHTTPHeaders": {
"type": "object",
"description": "Extra HTTP headers Api2Pdf forwards when it fetches a source URL (e.g. auth for a protected page/file).",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"type": "string"
}
},
"useCustomStorage": {
"type": "boolean",
"description": "If true, Api2Pdf uploads the result to your own storage (see `storage`) instead of hosting it."
}
}
}| useCustomStorage |
| boolean |
| If true, Api2Pdf uploads the result to your own storage (see `storage`) instead of hosting it. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"url"
],
"properties": {
"url": {
"type": "string",
"description": "The URL of the web page Api2Pdf will fetch and render to PDF."
},
"inline": {
"type": "boolean",
"description": "If true (Api2Pdf default), the generated file is served inline; if false, as an attachment."
},
"options": {
"type": "object",
"description": "Engine-specific render options (page size, margins, orientation, headers/footers, etc.). Passed through verbatim to Api2Pdf.",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
"storage": {
"type": "object",
"properties": {
"url": {
"type": "string",
"description": "Pre-signed destination URL for the upload."
},
"method": {
"type": "string",
"description": "HTTP method Api2Pdf uses to upload (e.g. 'PUT')."
}
},
"description": "Custom storage target, used when useCustomStorage is true."
},
"fileName": {
"type": "string",
"description": "A name for the generated file, e.g. 'invoice.pdf'."
},
"output_binary": {
"type": "boolean",
"description": "If true, return the raw file bytes as base64 instead of a FileUrl. Default false (recommended for agents — returns a short-lived link)."
},
"extraHTTPHeaders": {
"type": "object",
"description": "Extra HTTP headers Api2Pdf forwards when it fetches a source URL (e.g. auth for a protected page/file).",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"type": "string"
}
},
"useCustomStorage": {
"type": "boolean",
"description": "If true, Api2Pdf uploads the result to your own storage (see `storage`) instead of hosting it."
}
}
}| useCustomStorage |
| boolean |
| If true, Api2Pdf uploads the result to your own storage (see `storage`) instead of hosting it. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"html"
],
"properties": {
"html": {
"type": "string",
"description": "The HTML source to render into a PDF."
},
"inline": {
"type": "boolean",
"description": "If true (Api2Pdf default), the generated file is served inline; if false, as an attachment."
},
"options": {
"type": "object",
"description": "Engine-specific render options (page size, margins, orientation, headers/footers, etc.). Passed through verbatim to Api2Pdf.",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
"storage": {
"type": "object",
"properties": {
"url": {
"type": "string",
"description": "Pre-signed destination URL for the upload."
},
"method": {
"type": "string",
"description": "HTTP method Api2Pdf uses to upload (e.g. 'PUT')."
}
},
"description": "Custom storage target, used when useCustomStorage is true."
},
"fileName": {
"type": "string",
"description": "A name for the generated file, e.g. 'invoice.pdf'."
},
"output_binary": {
"type": "boolean",
"description": "If true, return the raw file bytes as base64 instead of a FileUrl. Default false (recommended for agents — returns a short-lived link)."
},
"extraHTTPHeaders": {
"type": "object",
"description": "Extra HTTP headers Api2Pdf forwards when it fetches a source URL (e.g. auth for a protected page/file).",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"type": "string"
}
},
"useCustomStorage": {
"type": "boolean",
"description": "If true, Api2Pdf uploads the result to your own storage (see `storage`) instead of hosting it."
}
}
}