Skip to main content
DocRaptor logo
  • Category: developer tools
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 10
  • Triggers: 0
  • Slug: DOCRAPTOR
  • Version: 20261101_00

Tools

Slug: DOCRAPTOR_CREATE_ASYNC_DOCCreate 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

string
Custom metadata for storage and tracking.
boolean
Request support assistance with this document.
string
required
Identifier for the document.
boolean
Enable test mode which adds a watermark to the document.
string ("html" | "none")
Validation mode - must be one of: html, none.
string
Specific DocRaptor Pipeline version to use.
string
HTTP referrer header value to use when fetching assets.
boolean
Enable DocRaptor JavaScript parsing.
string
POST endpoint URL for completion notification.
string
URL to fetch HTML content from. Alternative to document_content.
string ("pdf" | "xls" | "xlsx")
required
Document format - must be one of: pdf, xls, xlsx.
object
Advanced rendering configuration options for PrinceXML.
string
HTML content to transform. Required unless document_url is provided. Mutually exclusive with document_url — supplying both causes a validation failure.
string
ISO 8601 datetime when hosted document expires.
integer
Maximum number of downloads allowed for hosted document.
boolean
Continue processing if asset loading fails.
boolean
Prevent console.log from interrupting rendering.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCRAPTOR_CREATE_DOCCreate 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

string
A field for storing a small amount of metadata with this document.
boolean
Request support help with this request if it succeeds (default: false).
string
required
A name for identifying your document.
boolean
Enable test mode for this document (adds watermark). Set to false for production documents.
string ("html" | "none")
HTML validation mode - none or html.
string
Specify a specific version of the DocRaptor Pipeline.
string
Set HTTP referrer when generating this document.
boolean
Enable DocRaptor JavaScript parsing (default: false).
string
POST URL for async completion notifications.
string
The URL to fetch the HTML data to be transformed. Required if document_content is not provided. Mutually exclusive with document_content.
string ("pdf" | "xls" | "xlsx")
required
Output format - pdf for PDF documents, xls for Excel 97-2003, or xlsx for modern Excel.
object
Advanced rendering configuration options for PrinceXML engine.
string
The HTML data to be transformed into a document. Required if document_url is not provided. Mutually exclusive with document_url.
string
ISO 8601 datetime when hosted document becomes unavailable.
integer
Number of times a hosted document can be downloaded.
boolean
Failed loading of images/javascripts/stylesheets/etc will not cause rendering to stop (default: true).
boolean
Prevent console.log from stopping document rendering (default: false).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCRAPTOR_CREATE_DOCUMENT_FROM_REFERRERRequest 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

string
Document filename to use for the generated file.
string ("pdf" | "xls")
Output format for the document. Choose ‘pdf’ for PDF documents or ‘xls’ for Excel spreadsheets.
boolean
Enable JavaScript processing on the page before conversion. Set to true to execute JavaScript on the page.
string
CSS media type to use for rendering, such as ‘screen’ or ‘print’. This affects which stylesheets are applied.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCRAPTOR_CREATE_HOSTED_ASYNC_DOCTool 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

string
Small metadata storage field.
boolean
Requests support assistance; defaults to false.
string
required
Identifier for the document.
boolean
Enables test mode with watermark; defaults to true.
string ("html" | "none")
HTML validation - ‘none’ or ‘html’.
string
Specifies DocRaptor pipeline version.
string
Sets HTTP referrer header.
boolean
Enables DocRaptor JavaScript parsing; defaults to false.
string
POST endpoint for async completion notifications.
string
URL to fetch HTML content. Alternative to document_content.
string ("pdf" | "xls" | "xlsx")
required
Type of output document - pdf, xls, or xlsx.
object
Advanced rendering configuration options for PrinceXML.
string
HTML data for transformation. Required if document_url is not provided.
string
ISO 8601 datetime for document expiration.
integer
Maximum download count for hosted docs.
boolean
Continues rendering if assets fail; defaults to true.
boolean
Prevents console.log interruptions; defaults to false.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCRAPTOR_GET_ASYNC_DOCDownload a completed asynchronous document using its download ID. The returned file is labeled as a PDF regardless of the original document format.

Input Parameters

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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCRAPTOR_GET_ASYNC_DOC_STATUSTool to check the status of an asynchronously created document. Use when monitoring progress of async documents by polling for completion status.

Input Parameters

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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCRAPTOR_LIST_DOCUMENTS_JSONTool 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

integer
Specifies which page of results to return for pagination. Default is 1.
integer
Number of documents per page to return. Default is 100.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCRAPTOR_LIST_DOCUMENTS_XMLRetrieve 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

integer
Specifies which page of results to return for pagination. Default is 1.
integer
Number of documents per page to return. Default is 100. Maximum is 100.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCRAPTOR_LIST_IPS_JSONTool 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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCRAPTOR_LIST_IPS_TEXTTool 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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not