> ## Documentation Index
> Fetch the complete documentation index at: https://composio-preview.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# DocRaptor

> The best and easiest HTML-to-PDF API

![DocRaptor logo](https://mintcdn.com/composio-preview/VNLruGH5mLZqXdPH/images/toolkits/docraptor.svg?fit=max\&auto=format\&n=VNLruGH5mLZqXdPH\&q=85\&s=fd1e6a51574860740b6560e0d51ee560)

* **Category:** developer tools
* **Auth:** API\_KEY
* **Composio-managed OAuth available?** N/A
* **Tools:** 10
* **Triggers:** 0
* **Slug:** `DOCRAPTOR`
* **Version:** 20261101\_00

## Tools

> [accordion] Create Async Document
>
> **Slug:** `DOCRAPTOR_CREATE_ASYNC_DOC`
>
> Create a PDF, XLS, or XLSX document asynchronously from supplied content or a URL, with test mode enabled by default. Returns a status\_id for polling completion; an optional callback can notify you when creation succeeds.
>
> #### Input Parameters
>
> **tag** `string`
>
> Custom metadata for storage and tracking.
>
> **help** `boolean`
>
> Request support assistance with this document.
>
> **name** `string` *required*
>
> Identifier for the document.
>
> **test** `boolean`
>
> Enable test mode which adds a watermark to the document.
>
> **strict** `string ("html" | "none")`
>
> Validation mode - must be one of: html, none.
>
> **pipeline** `string`
>
> Specific DocRaptor Pipeline version to use.
>
> **referrer** `string`
>
> HTTP referrer header value to use when fetching assets.
>
> **javascript** `boolean`
>
> Enable DocRaptor JavaScript parsing.
>
> **callback\_url** `string`
>
> POST endpoint URL for completion notification.
>
> **document\_url** `string`
>
> URL to fetch HTML content from. Alternative to document\_content.
>
> **document\_type** `string ("pdf" | "xls" | "xlsx")` *required*
>
> Document format - must be one of: pdf, xls, xlsx.
>
> **prince\_options** `object`
>
> Advanced rendering configuration options for PrinceXML.
>
> **document\_content** `string`
>
> HTML content to transform. Required unless document\_url is provided. Mutually exclusive with `document_url` — supplying both causes a validation failure.
>
> **hosted\_expires\_at** `string`
>
> ISO 8601 datetime when hosted document expires.
>
> **hosted\_download\_limit** `integer`
>
> Maximum number of downloads allowed for hosted document.
>
> **ignore\_resource\_errors** `boolean`
>
> Continue processing if asset loading fails.
>
> **ignore\_console\_messages** `boolean`
>
> Prevent console.log from interrupting rendering.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Document
>
> **Slug:** `DOCRAPTOR_CREATE_DOC`
>
> Create a PDF or Excel document synchronously from supplied content or a URL, returning a downloadable file. Provide one content source; test mode is enabled by default.
>
> #### Input Parameters
>
> **tag** `string`
>
> A field for storing a small amount of metadata with this document.
>
> **help** `boolean`
>
> Request support help with this request if it succeeds (default: false).
>
> **name** `string` *required*
>
> A name for identifying your document.
>
> **test** `boolean`
>
> Enable test mode for this document (adds watermark). Set to false for production documents.
>
> **strict** `string ("html" | "none")`
>
> HTML validation mode - none or html.
>
> **pipeline** `string`
>
> Specify a specific version of the DocRaptor Pipeline.
>
> **referrer** `string`
>
> Set HTTP referrer when generating this document.
>
> **javascript** `boolean`
>
> Enable DocRaptor JavaScript parsing (default: false).
>
> **callback\_url** `string`
>
> POST URL for async completion notifications.
>
> **document\_url** `string`
>
> The URL to fetch the HTML data to be transformed. Required if document\_content is not provided. Mutually exclusive with document\_content.
>
> **document\_type** `string ("pdf" | "xls" | "xlsx")` *required*
>
> Output format - pdf for PDF documents, xls for Excel 97-2003, or xlsx for modern Excel.
>
> **prince\_options** `object`
>
> Advanced rendering configuration options for PrinceXML engine.
>
> **document\_content** `string`
>
> The HTML data to be transformed into a document. Required if document\_url is not provided. Mutually exclusive with document\_url.
>
> **hosted\_expires\_at** `string`
>
> ISO 8601 datetime when hosted document becomes unavailable.
>
> **hosted\_download\_limit** `integer`
>
> Number of times a hosted document can be downloaded.
>
> **ignore\_resource\_errors** `boolean`
>
> Failed loading of images/javascripts/stylesheets/etc will not cause rendering to stop (default: true).
>
> **ignore\_console\_messages** `boolean`
>
> Prevent console.log from stopping document rendering (default: false).
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Document from Referrer
>
> **Slug:** `DOCRAPTOR_CREATE_DOCUMENT_FROM_REFERRER`
>
> Request a PDF or XLS document from DocRaptor's referrer-based creation endpoint and return the resulting file. The configured connection supplies API-key authentication; the request uses a default DocRaptor referer if none is present in its headers.
>
> #### Input Parameters
>
> **name** `string`
>
> Document filename to use for the generated file.
>
> **type** `string ("pdf" | "xls")`
>
> Output format for the document. Choose 'pdf' for PDF documents or 'xls' for Excel spreadsheets.
>
> **javascript** `boolean`
>
> Enable JavaScript processing on the page before conversion. Set to true to execute JavaScript on the page.
>
> **prince\_option\_media** `string`
>
> CSS media type to use for rendering, such as 'screen' or 'print'. This affects which stylesheets are applied.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Hosted Async Document
>
> **Slug:** `DOCRAPTOR_CREATE_HOSTED_ASYNC_DOC`
>
> Tool to create a hosted document asynchronously. Use when you need to generate a PDF, XLS, or XLSX document and track its completion status via callback\_url or the status API.
>
> #### Input Parameters
>
> **tag** `string`
>
> Small metadata storage field.
>
> **help** `boolean`
>
> Requests support assistance; defaults to false.
>
> **name** `string` *required*
>
> Identifier for the document.
>
> **test** `boolean`
>
> Enables test mode with watermark; defaults to true.
>
> **strict** `string ("html" | "none")`
>
> HTML validation - 'none' or 'html'.
>
> **pipeline** `string`
>
> Specifies DocRaptor pipeline version.
>
> **referrer** `string`
>
> Sets HTTP referrer header.
>
> **javascript** `boolean`
>
> Enables DocRaptor JavaScript parsing; defaults to false.
>
> **callback\_url** `string`
>
> POST endpoint for async completion notifications.
>
> **document\_url** `string`
>
> URL to fetch HTML content. Alternative to document\_content.
>
> **document\_type** `string ("pdf" | "xls" | "xlsx")` *required*
>
> Type of output document - pdf, xls, or xlsx.
>
> **prince\_options** `object`
>
> Advanced rendering configuration options for PrinceXML.
>
> **document\_content** `string`
>
> HTML data for transformation. Required if document\_url is not provided.
>
> **hosted\_expires\_at** `string`
>
> ISO 8601 datetime for document expiration.
>
> **hosted\_download\_limit** `integer`
>
> Maximum download count for hosted docs.
>
> **ignore\_resource\_errors** `boolean`
>
> Continues rendering if assets fail; defaults to true.
>
> **ignore\_console\_messages** `boolean`
>
> Prevents console.log interruptions; defaults to false.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Download Async Document
>
> **Slug:** `DOCRAPTOR_GET_ASYNC_DOC`
>
> Download a completed asynchronous document using its download ID. The returned file is labeled as a PDF regardless of the original document format.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> The download\_id returned from an async status request or callback. Same id value returned by DOCRAPTOR\_CREATE\_ASYNC\_DOC; use DOCRAPTOR\_GET\_ASYNC\_DOC\_STATUS to poll until complete before calling this tool.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Async Document Status
>
> **Slug:** `DOCRAPTOR_GET_ASYNC_DOC_STATUS`
>
> Tool to check the status of an asynchronously created document. Use when monitoring progress of async documents by polling for completion status.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> The status\_id returned when creating an asynchronous document. Returned by DOCRAPTOR\_CREATE\_ASYNC\_DOC; store immediately as the same id is also required by DOCRAPTOR\_GET\_ASYNC\_DOC to download the completed document.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Documents (JSON)
>
> **Slug:** `DOCRAPTOR_LIST_DOCUMENTS_JSON`
>
> Tool to retrieve a paginated list of previously created documents with metadata in JSON format. Use when you need to see document creation history or query past documents.
>
> #### Input Parameters
>
> **page** `integer`
>
> Specifies which page of results to return for pagination. Default is 1.
>
> **per\_page** `integer`
>
> Number of documents per page to return. Default is 100.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Documents (XML)
>
> **Slug:** `DOCRAPTOR_LIST_DOCUMENTS_XML`
>
> Retrieve a paginated list of previously created documents and their metadata from DocRaptor's XML listing endpoint. The XML response is parsed into structured document records.
>
> #### Input Parameters
>
> **page** `integer`
>
> Specifies which page of results to return for pagination. Default is 1.
>
> **per\_page** `integer`
>
> Number of documents per page to return. Default is 100. Maximum is 100.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List IPs (JSON)
>
> **Slug:** `DOCRAPTOR_LIST_IPS_JSON`
>
> Tool to get list of IP addresses that DocRaptor uses to download assets. Use when you need to know which IPs DocRaptor uses for asset downloading. Note: Using IPs for securing assets is not recommended as they can change without notice.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List IPs (Text)
>
> **Slug:** `DOCRAPTOR_LIST_IPS_TEXT`
>
> Tool to retrieve a list of IP addresses that DocRaptor uses to download assets in plain text format. Use when you need to identify DocRaptor's IP addresses for network configuration or security purposes.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not
