Special offer. See more information about Outbyte and uninstall instructions. Please review EULA and Privacy policy.

Install DocRaptor’s Python client, authenticate with your API key, and call create_doc to generate a PDF from HTML or a URL. Save the response as bytes, use test mode while developing, and switch to asynchronous generation for jobs that may run beyond the documented synchronous window.

Install the DocRaptor Python client

Install or upgrade the official package in the Python environment that will run your integration:

python -m pip install --upgrade docraptor

Keep your API key out of source control. In a deployed application, load it from an environment variable or a secret manager rather than embedding it in the script.

Generate a PDF from inline HTML

This example follows DocRaptor’s Python client pattern. Set the DOCRAPTOR_API_KEY environment variable to your account’s API key before running it. Test mode generates a watermarked document.

Special offer. See more information about Outbyte and uninstall instructions. Please review EULA and Privacy policy.
#1 Best Overall
Elebase USB to USB C Adapter for iPhone 18 Pro Max,USBC Car Charger Adapter
  • Read Before You Buy — No Video Output: These adapters support charging and USB 2.0 data transfer, but cannot transmit video signals. Except for standard USB webcams (which use USB data only), they are not compatible with HDMI/DisplayPort cables, video-capable USB-C hubs, or docking stations with video output.
  • Convert USB-A Ports to USB-C: Designed to connect USB-C earphones, cables, flash drives, card readers, and other USB-C accessories to standard USB-A ports. Plug-and-play with no drivers or software required.
  • Aluminum Alloy Housing: Built with a sturdy aluminum alloy shell that aids in heat dissipation and protects against daily wear and scratches. Designed to maintain a stable and secure connection.
  • Compact & Travel-Friendly: The ultra-compact design allows the adapter to stay plugged into your device without blocking adjacent ports or adding bulk, reducing wear and tear on your original USB ports.
  • 12-Month Warranty: Backed by a 12-month manufacturer warranty for peace of mind. Designed to meet strict quality control standards for reliable everyday performance.
import os
import docraptor

api_key = os.environ["DOCRAPTOR_API_KEY"]
client = docraptor.DocApi()
client.api_client.configuration.username = api_key

html = """<html>
<body>
  <h1>Hello from DocRaptor</h1>
  <p>This PDF was generated from inline HTML.</p>
</body>
</html>"""

try:
    response = client.create_doc({
        "test": True,
        "document_type": "pdf",
        "document_content": html,
    })
    with open("document.pdf", "wb") as pdf_file:
        pdf_file.write(bytearray(response))
except docraptor.rest.ApiException as error:
    print("HTTP status:", error.status)
    print("Reason:", error.reason)
    print("Response body:", error.body)

For a production document, set test to False or omit it according to the client’s current defaults. The test output is watermarked, so do not mistake it for an unmarked production PDF.

Choose HTML content or a source URL

For inline input, pass the HTML string in document_content. To have DocRaptor retrieve a page, pass its publicly reachable address in document_url instead. The API reference says one of these inputs is required. For PDF output, specify the document type as pdf.

response = client.create_doc({
    "test": True,
    "document_type": "pdf",
    "document_url": "https://example.com/report",
})

A URL-based request requires the document to be accessible to the service; a URL that only works inside your local network or behind an unprovided login will not serve as a usable source. The request returns PDF bytes directly in the basic synchronous flow.

Rank #2
Anker USB-C Hub, 5-in-1 USB Hub for Laptops, 4K HDMI Multiport Adapter
  • 5-in-1 USB-C Hub: Experience comprehensive connectivity featuring a Power Delivery input, two USB-A 2.0 ports, a USB-A 3.0 port, and an HDMI port. (Note: The USB-C power delivery input port is only for connecting an external wall charger to power your laptop and cannot power peripheral devices.)
  • 90W Pass-Through Charging: Achieve optimal charging with 90W pass-through power to your laptop, supported by a total input of 100W, with the hub reserving 10W for operational efficiency. (Note: Wall charger not included.)
  • Quick Data Transfers: Accelerate your productivity with rapid data transfers using a high-speed 5Gbps USB 3.0 port and two 480Mbps USB 2.0 ports.
  • 4K HDMI Display: Enhance your visual experience with a hub capable of delivering 4K resolution at 30Hz in both mirror and extend modes. Please note that this hub is compatible with MacBook (macOS 12 and newer), Windows 10 and 11, ChromeOS, and laptops equipped with DP Alt Mode and Power Delivery. Note: This device is not compatible with Linux.
  • What You Get: Anker USB-C Hub (5-in-1, 4K HDMI), welcome guide, 18-month warranty, and our friendly customer service.

Use direct REST requests when needed

The REST endpoint is https://api.docraptor.com/docs. Direct REST integrations send a JSON POST. DocRaptor documents HTTP Basic Authentication with the API key as the username and a blank password; use that documented method rather than putting the key in a URL.

Special offer. See more information about Outbyte and uninstall instructions. Please review EULA and Privacy policy.

The API’s current field name for the output format is type. The reference retains document_type for applications that already use it. A minimal PDF request with inline content looks like this:

import os
import requests

api_key = os.environ["DOCRAPTOR_API_KEY"]
response = requests.post(
    "https://api.docraptor.com/docs",
    auth=(api_key, ""),
    json={
        "type": "pdf",
        "document_content": "<html><body><h1>Hello</h1></body></html>",
        "test": True,
    },
    timeout=90,
)

if response.ok:
    with open("document.pdf", "wb") as pdf_file:
        pdf_file.write(response.content)
else:
    print("HTTP status:", response.status_code)
    print("Response body:", response.text)

Check the current API reference for all request fields and options before extending a direct integration. Direct successful PDF responses are binary, so preserve them as bytes rather than decoding them as text.

Rank #3
Sale
Anker USB C Hub, 7in1 Multi-Port USB Adapter, 4K@60Hz USBC to HDMI Splitter
  • Sleek 7-in-1 USB-C Hub: Features an HDMI port, two USB-A 3.0 ports, and a USB-C data port, each providing 5Gbps transfer speeds. It also includes a USB-C PD input port for charging up to 100W and dual SD and TF card slots, all in a compact design.
  • Flawless 4K@60Hz Video with HDMI: Delivers exceptional clarity and smoothness with its 4K@60Hz HDMI port, making it ideal for high-definition presentations and entertainment. (Note: Only the HDMI port supports video projection; the USB-C port is for data transfer only.)
  • Double Up on Efficiency: The two USB-A 3.0 ports and a USB-C port support a fast 5Gbps data rate, significantly boosting your transfer speeds and improving productivity.
  • Fast and Reliable 85W Charging: Offers high-capacity, speedy charging for laptops up to 85W, so you spend less time tethered to an outlet and more time being productive.
  • What You Get: Anker USB-C Hub (7-in-1), welcome guide, 18-month warranty, and our friendly customer service.

Handle output and errors safely

Write PDFs in binary mode

Use wb when writing the client response to a file. Opening the destination in text mode can corrupt the PDF. If your application returns the PDF to a caller, stream or send the bytes as a file response instead of converting them to a string.

Inspect API exceptions

The client raises docraptor.rest.ApiException for API errors. Capture its HTTP status, reason, and response body in diagnostic logs so you can distinguish authentication, request, and rendering failures. Do not log the API key or sensitive source document content.

Special offer. See more information about Outbyte and uninstall instructions. Please review EULA and Privacy policy.

For direct REST calls, check the HTTP status before treating the body as a PDF. DocRaptor says errors may include an XML error body. PDF responses can include an X-DocRaptor-Num-Pages header; this can help identify the number of pages returned by a successful PDF request.

Rank #4
Sale
UGREEN USB to USB C Adapter Combo 4-Pack, 10Gbps USB C Converter Space Gray
  • Dual Converters, Infinite Potential:Includes 2× USB C male to USB A female adapters and 2× USB A male to USB C female adapters. Perfect for a wide range of uses—tablets with Bluetooth keyboards, expand USB ports on macbook, and more. Two different converters for all your daily needs
  • Next-Level 10Gbps & 3A Charging: No more slow 480Mbps, this usb to usb c adapter has a transfer speed of up to 10Gbps, allowing you to do more transferring in less time. This usb adapter fits both USB A and USB C charger, supporting up to 3A fast charging
  • Upgraded Exquisite Craftsmanship: With an aluminum alloy housing and metal connector, the usbc to usb adapter is extremely durable and sturdy. Rigorously tested to withstand more than 10,000 times of plugging and unplugging, ensuring long-lasting performance
  • Broad Compatible: The usb c to usb adapter widely supports all USB C/ USB A devices like laptops, tablets, cellphones, car chargers, and phone chargers. Such as compatible with MacBook Pro/Air 2023/2022, Thunderbolt 4/3 Devices,Apple MagSafe Watch 9/8/7/SE/Ultra, iPad Pro 2022/2021, Samsung Galaxy S23/S20/S10, and iPhone 17/16/15 Pro. Plug and play
  • Please Note: To reach 10Gbps speed, keep the cable under 3.3 ft. For USB A Male to USB C adapters, try flipping the USB C connector. USB C Male to USB A adapters support bidirectional 10Gbps transfer within 3.3 ft

Use asynchronous generation for long jobs

DocRaptor’s Python guide documents synchronous generation up to 60 seconds and asynchronous generation up to 10 minutes. These are vendor-stated service limits, not independent guarantees; verify the current documentation before building a deadline or retry policy around them.

For a job likely to exceed the synchronous window, use the client’s create_async_doc method. The asynchronous flow returns a status identifier; use polling or a callback URL to determine when the document is ready. Keep job status handling separate from the final file download, and account for failures or delays while waiting.

Independent reader supportYour contribution helps us test, update, and keep practical guides available for everyone.Support on Ko-Fi

Choose the document type and rendering options

PDF, XLS, and XLSX

The API reference lists PDF, XLS, and XLSX as supported document types. The examples here target PDF; choose the output type appropriate to the document you need and consult the API reference for the corresponding request and response behavior.

What’s actually slowing this PC down?

Pick the symptom - the matching free tool is one click away.

Special offer. See more information about Outbyte and uninstall instructions. Please review EULA and Privacy policy.
Best Value
Anker USB C Hub, 5-in-1 USBC to HDMI Splitter with 4K Display
  • 5-in-1 Connectivity: Equipped with a 4K HDMI port, a 5 Gbps USB-C data port, two 5 Gbps USB-A ports, and a USB C 100W PD-IN port. Note: The USB C 100W PD-IN port supports only charging and does not support data transfer devices such as headphones or speakers.
  • Powerful Pass-Through Charging: Supports up to 85W pass-through charging so you can power up your laptop while you use the hub. Note: Pass-through charging requires a charger (not included). Note: To achieve full power for iPad, we recommend using a 45W wall charger.
  • Transfer Files in Seconds: Move files to and from your laptop at speeds of up to 5 Gbps via the USB-C and USB-A data ports. Note: The USB C 5Gbps Data port does not support video output.
  • HD Display: Connect to the HDMI port to stream or mirror content to an external monitor in resolutions of up to 4K@30Hz. Note: The USB-C ports do not support video output.
  • What You Get: Anker 332 USB-C Hub (5-in-1), welcome guide, our worry-free 18-month warranty, and friendly customer service.

PDF rendering and Pipeline versions

DocRaptor uses the Prince PDF engine. Its PDF options include Prince-specific rendering features such as mixed layouts, header placements, accessible PDF tagging, and crop marks. Many options in the API reference apply only to PDF output. DocRaptor accounts can use different Pipeline versions, which map to Prince and JavaScript versions, so verify version-specific behavior and test the rendered document with the Pipeline version your account uses.

Troubleshoot common problems

  • Authentication fails: confirm that the API key is the configured username in the Python client, or the HTTP Basic Auth username for direct REST. Check that the deployed environment has the intended key and has not loaded an empty value.
  • The request is rejected for missing input: provide either document_content or document_url, along with the output type.
  • The saved file is unusable: write the client response or REST response body in binary mode, and first confirm the HTTP request succeeded rather than saving an error body as a PDF.
  • The PDF has a test mark: the request was made in test mode. Test documents are watermarked; use production mode for final output.
  • A request runs too long: use the asynchronous creation method for longer-running jobs and check current DocRaptor limits. Do not assume the documented windows are unchanged without verifying the service documentation.
  • Layout differs across environments: check the account’s Pipeline version and the Prince-specific options in use, then validate output against the version configured for that account.

Or skip the browser setup

If you also need clean website screenshots or PDFs from web pages, ScreenshotNeo offers a one-request API and an MCP server for AI agents. This is a separate website-capture service, not a replacement for DocRaptor’s HTML-to-PDF document-generation workflow.

For a website screenshot as WebP, the cURL request is:

curl -G "https://api.screenshotneo.com/v1/shot" -d access_key=YOUR_API_KEY --data-urlencode url=https://stripe.com -o shot.webp

See the ScreenshotNeo API documentation for options and response details. Cookie banners, popups, and chat widgets are removed before capture; bot checks, blank pages, and failed loads are never billed. Its MCP server lets AI agents take screenshots. The free plan includes 1,000 screenshots a month with no card, and paid plans start at $5 for 3,000. Sign up for 1,000 free screenshots a month, with no card required.

Special offer. See more information about Outbyte and uninstall instructions. Please review EULA and Privacy policy.

Frequently Asked Questions

Does the Python client return a PDF as a file or as bytes?

The synchronous client response is PDF data; write it to a file in binary mode or stream the bytes to your caller.

Can DocRaptor convert a webpage URL instead of supplied HTML?

Yes. Use the request’s document_url field instead of document_content, provided DocRaptor can access that URL.

Product prices and availability are accurate as of the date/time indicated and are subject to change. Any price and availability information displayed on Amazon at the time of purchase will apply.