NAiOS IconNAiOS Logo
Contacto
Volver al catálogo

DocRaptor

docraptor

The best and easiest HTML-to-PDF API

Developer ToolsWeb del proveedor
Acciones
10
Triggers
0
Autenticación
—
OAuth gestionado
No
Información técnica: el detalle de parámetros, schemas y triggers de esta página está pensado para equipos de integración. Si solo necesitas saber si tu herramienta favorita está disponible, basta con ver la lista de acciones.

Acciones disponibles (10)

Cada acción es una operación que el agente puede ejecutar contra este conector. Haz clic en una acción para ver sus parámetros.

Create Async DocumentDOCRAPTOR_CREATE_ASYNC_DOCAcción

Tool to create documents asynchronously from HTML content. Use when generating PDF, XLS, or XLSX documents and you need to poll for completion status or use a callback URL for notification.

Parámetros de entrada

  • tagstring

    Custom metadata for storage and tracking.

  • helpboolean

    Request support assistance with this document.

  • namestringObligatorio

    Identifier for the document.

  • testboolean

    Enable test mode which adds a watermark to the document.

  • strictstringenum

    Validation mode - must be one of: html, none.

    htmlnone
  • pipelinestring

    Specific DocRaptor Pipeline version to use.

  • referrerstring

    HTTP referrer header value to use when fetching assets.

  • javascriptboolean

    Enable DocRaptor JavaScript parsing.

  • callback_urlstring

    POST endpoint URL for completion notification.

  • document_urlstring

    URL to fetch HTML content from. Alternative to document_content.

  • document_typestringObligatorioenum

    Document format - must be one of: pdf, xls, xlsx.

    pdfxlsxlsx
  • prince_optionsobject

    Advanced rendering configuration options for PrinceXML.

  • document_contentstring

    HTML content to transform. Required unless document_url is provided.

  • hosted_expires_atstring

    ISO 8601 datetime when hosted document expires.

  • hosted_download_limitinteger

    Maximum number of downloads allowed for hosted document.

  • ignore_resource_errorsboolean

    Continue processing if asset loading fails.

  • ignore_console_messagesboolean

    Prevent console.log from interrupting rendering.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Create DocumentDOCRAPTOR_CREATE_DOCAcción

Tool to create a PDF or Excel document synchronously from HTML content or URL. Use when you need to generate a document file from HTML data. The document is returned immediately as a downloadable file. Either document_content or document_url must be provided, but not both.

Parámetros de entrada

  • tagstring

    A field for storing a small amount of metadata with this document.

  • helpboolean

    Request support help with this request if it succeeds (default: false).

  • namestringObligatorio

    A name for identifying your document.

  • testboolean

    Enable test mode for this document (adds watermark). Set to false for production documents.

  • strictstringenum

    HTML validation mode - none or html.

    htmlnone
  • pipelinestring

    Specify a specific version of the DocRaptor Pipeline.

  • referrerstring

    Set HTTP referrer when generating this document.

  • javascriptboolean

    Enable DocRaptor JavaScript parsing (default: false).

  • callback_urlstring

    POST URL for async completion notifications.

  • document_urlstring

    The URL to fetch the HTML data to be transformed. Required if document_content is not provided. Mutually exclusive with document_content.

  • document_typestringObligatorioenum

    Output format - pdf for PDF documents, xls for Excel 97-2003, or xlsx for modern Excel.

    pdfxlsxlsx
  • prince_optionsobject

    Advanced rendering configuration options for PrinceXML engine.

  • document_contentstring

    The HTML data to be transformed into a document. Required if document_url is not provided. Mutually exclusive with document_url.

  • hosted_expires_atstring

    ISO 8601 datetime when hosted document becomes unavailable.

  • hosted_download_limitinteger

    Number of times a hosted document can be downloaded.

  • ignore_resource_errorsboolean

    Failed loading of images/javascripts/stylesheets/etc will not cause rendering to stop (default: true).

  • ignore_console_messagesboolean

    Prevent console.log from stopping document rendering (default: false).

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Create Document from ReferrerDOCRAPTOR_CREATE_DOCUMENT_FROM_REFERRERAcción

Tool to convert webpages into documents using referrer-based authentication without an API key. Use when you need to generate PDFs or Excel files from registered domains without explicit API credentials.

Parámetros de entrada

  • namestring

    Document filename to use for the generated file.

  • typestringenum

    Output format for the document. Choose 'pdf' for PDF documents or 'xls' for Excel spreadsheets.

    pdfxls
  • javascriptboolean

    Enable JavaScript processing on the page before conversion. Set to true to execute JavaScript on the page.

  • prince_option_mediastring

    CSS media type to use for rendering, such as 'screen' or 'print'. This affects which stylesheets are applied.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Create Hosted Async DocumentDOCRAPTOR_CREATE_HOSTED_ASYNC_DOCAcción

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.

Parámetros de entrada

  • tagstring

    Small metadata storage field.

  • helpboolean

    Requests support assistance; defaults to false.

  • namestringObligatorio

    Identifier for the document.

  • testboolean

    Enables test mode with watermark; defaults to true.

  • strictstringenum

    HTML validation - 'none' or 'html'.

    htmlnone
  • pipelinestring

    Specifies DocRaptor pipeline version.

  • referrerstring

    Sets HTTP referrer header.

  • javascriptboolean

    Enables DocRaptor JavaScript parsing; defaults to false.

  • callback_urlstring

    POST endpoint for async completion notifications.

  • document_urlstring

    URL to fetch HTML content. Alternative to document_content.

  • document_typestringObligatorioenum

    Type of output document - pdf, xls, or xlsx.

    pdfxlsxlsx
  • prince_optionsobject

    Advanced rendering configuration options for PrinceXML.

  • document_contentstring

    HTML data for transformation. Required if document_url is not provided.

  • hosted_expires_atstring

    ISO 8601 datetime for document expiration.

  • hosted_download_limitinteger

    Maximum download count for hosted docs.

  • ignore_resource_errorsboolean

    Continues rendering if assets fail; defaults to true.

  • ignore_console_messagesboolean

    Prevents console.log interruptions; defaults to false.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Download Async DocumentDOCRAPTOR_GET_ASYNC_DOCAcción

Tool to download a completed asynchronous document using the download URL from status response. Use when you have a download_id and need to retrieve the generated document file.

Parámetros de entrada

  • idstringObligatorio

    The download_id returned from an async status request or callback.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get Async Document StatusDOCRAPTOR_GET_ASYNC_DOC_STATUSAcción

Tool to check the status of an asynchronously created document. Use when monitoring progress of async documents by polling for completion status.

Parámetros de entrada

  • idstringObligatorio

    The status_id returned when creating an asynchronous document.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List Documents (JSON)DOCRAPTOR_LIST_DOCUMENTS_JSONAcción

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.

Parámetros de entrada

  • pageinteger

    Specifies which page of results to return for pagination. Default is 1.

  • per_pageinteger

    Number of documents per page to return. Default is 100.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List Documents (XML)DOCRAPTOR_LIST_DOCUMENTS_XMLAcción

Tool to retrieve a paginated list of previously created documents with metadata in XML format. Use when you need to see document creation history or query past documents in XML format.

Parámetros de entrada

  • pageinteger

    Specifies which page of results to return for pagination. Default is 1.

  • per_pageinteger

    Number of documents per page to return. Default is 100. Maximum is 100.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List IPs (JSON)DOCRAPTOR_LIST_IPS_JSONAcción

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.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List IPs (Text)DOCRAPTOR_LIST_IPS_TEXTAcción

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.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not