Back to Home
API DOCUMENTATION

Build with PyPaper.

Integrate professional Jupyter Notebook conversion into your apps, scripts, and CI/CD pipelines with our simple yet powerful REST API.

The Endpoint

Send a POST request to our conversion engine. The API accepts multipart form data and returns a production-ready PDF file.

POSThttp://localhost:3000/api/convert

Authentication

All API requests must include your private API key in the headers. API access is exclusive to Pro Plan subscribers.

Required HeaderSecure
x-api-keyYour pp_... key

Parameters

Customize your output by passing additional form fields.

fileRequired
The .ipynb file to convert (Required)
File
theme
"light" (default) or "dark"
string
autoFormat
Auto-format code with Ruff (default: true)
boolean

Shell Example

The fastest way to test. On Windows, use curl.exe to avoid shell issues.

curl.exe -X POST http://localhost:3000/api/convert \
  -H "x-api-key: pp_your_key_here" \
  -F "file=@analysis.ipynb" \
  --output result.pdf

Ready to automate?

Upgrade to Pro to unlock unlimited API access today.

View Pro Pricing