Docraptor | Composio Docs

Overview

SLUG: DOCRAPTOR

Description

The best and easiest HTML-to-PDF API

Authentication Details

API Key

generic_api_key

stringRequired

Connecting to Docraptor

Create an auth config

Use the dashboard to create an auth config for the Docraptor toolkit. This allows you to connect multiple Docraptor accounts to Composio for agents to use.

Select App

Navigate to Docraptor.

Configure Auth Config Settings

Select among the supported auth schemes of and configure them here.

Create and Get auth config ID

Click “Create Docraptor Auth Config”. After creation, copy the displayed ID starting with ac_. This is your auth config ID. This is not a sensitive ID — you can save it in environment variables or a database. This ID will be used to create connections to the toolkit for a given user.

Connect Your Account

Using API Key

1 from composio import Composio
2 
3 # Replace these with your actual values
4 docraptor_auth_config_id = "ac_YOUR_DOCRAPTOR_CONFIG_ID" # Auth config ID created above
5 user_id = "0000-0000-0000"  # UUID from database/app
6 
7 composio = Composio()
8 
9 def authenticate_toolkit(user_id: str, auth_config_id: str):
10     # Replace this with a method to retrieve an API key from the user.
11     # Or supply your own.
12     user_api_key = input("[!] Enter API key")
13 
14     connection_request = composio.connected_accounts.initiate(
15         user_id=user_id,
16         auth_config_id=auth_config_id,
17         config={"auth_scheme": "API_KEY", "val": {"generic_api_key": user_api_key}}
18     )
19 
20     # API Key authentication is immediate - no redirect needed
21     print(f"Successfully connected Docraptor for user {user_id}")
22     print(f"Connection status: {connection_request.status}")
23     
24     return connection_request.id
25 
26 
27 connection_id = authenticate_toolkit(user_id, docraptor_auth_config_id)
28 
29 # You can verify the connection using:
30 connected_account = composio.connected_accounts.get(connection_id)
31 print(f"Connected account: {connected_account}")

Tools

Executing tools

To prototype you can execute some tools to see the responses and working on the Docraptor toolkit’s playground

For code examples, see the Tool calling guide and Provider examples.

Tool List

DOCRAPTOR_CREATE_ASYNC_DOC

Tool Name: Create Async Document

Description

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.

Action Parameters

callback_url

string

document_content

string

document_type

stringRequired

document_url

string

help

boolean

hosted_download_limit

integer

hosted_expires_at

string

ignore_console_messages

boolean

ignore_resource_errors

booleanDefaults to True

javascript

boolean

name

stringRequired

pipeline

string

prince_options

object

referrer

string

strict

string

tag

string

test

booleanDefaults to True

Action Response

data

objectRequired

error

string

successful

booleanRequired

DOCRAPTOR_CREATE_DOC

Tool Name: Create Document

Description

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.

Action Parameters

callback_url

string

document_content

string

document_type

stringRequired

document_url

string

help

boolean

hosted_download_limit

integer

hosted_expires_at

string

ignore_console_messages

boolean

ignore_resource_errors

boolean

javascript

boolean

name

stringRequired

pipeline

string

prince_options

object

referrer

string

strict

string

tag

string

test

booleanDefaults to True

Action Response

data

objectRequired

error

string

successful

booleanRequired

DOCRAPTOR_CREATE_DOCUMENT_FROM_REFERRER

Tool Name: Create Document from Referrer

Description

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.

Action Parameters

javascript

boolean

name

string

prince_option_media

string

type

stringDefaults to pdf

Action Response

data

objectRequired

error

string

successful

booleanRequired

DOCRAPTOR_CREATE_HOSTED_ASYNC_DOC

Tool Name: Create Hosted Async Document

Description

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.

Action Parameters

callback_url

string

document_content

string

document_type

stringRequired

document_url

string

help

boolean

hosted_download_limit

integer

hosted_expires_at

string

ignore_console_messages

boolean

ignore_resource_errors

boolean

javascript

boolean

name

stringRequired

pipeline

string

prince_options

object

referrer

string

strict

string

tag

string

test

boolean

Action Response

data

objectRequired

error

string

successful

booleanRequired

DOCRAPTOR_GET_ASYNC_DOC

Tool Name: Download Async Document

Description

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.

Action Parameters

stringRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

DOCRAPTOR_GET_ASYNC_DOC_STATUS

Tool Name: Get Async Document Status

Description

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

Action Parameters

stringRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

DOCRAPTOR_LIST_DOCUMENTS_JSON

Tool Name: List Documents (JSON)

Description

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.

Action Parameters

page

integerDefaults to 1

per_page

integerDefaults to 100

Action Response

data

objectRequired

error

string

successful

booleanRequired

DOCRAPTOR_LIST_DOCUMENTS_XML

Tool Name: List Documents (XML)

Description

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.

Action Parameters

page

integerDefaults to 1

per_page

integerDefaults to 100

Action Response

data

objectRequired

error

string

successful

booleanRequired

DOCRAPTOR_LIST_IPS_JSON

Tool Name: List IPs (JSON)

Description

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.

Action Parameters

Action Response

data

objectRequired

error

string

successful

booleanRequired

DOCRAPTOR_LIST_IPS_TEXT

Tool Name: List IPs (Text)

Description

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.

Action Parameters

Action Response

data

objectRequired

error

string

successful

booleanRequired