Pdf-generator-api Python API Docs | dltHub
Build a Pdf-generator-api-to-database pipeline in Python using dlt with AI Workbench support for Claude Code, Cursor, and Codex.
Last updated:
Pdf-generator-api is a cloud PDF document generation service and REST API for creating, editing and managing PDF templates and generating PDFs from JSON data. The REST API base URL is https://us1.pdfgeneratorapi.com and all requests require a Bearer token (Authorization header) for authentication.
dlt is an open-source Python library that handles authentication, pagination, and schema evolution automatically. dlthub provides AI context files that enable code assistants to generate production-ready pipelines. Install with uv pip install "dlt[workspace]" and start loading Pdf-generator-api data in under 10 minutes.
What data can I load from Pdf-generator-api?
Here are some of the endpoints you can load from Pdf-generator-api:
| Resource | Endpoint | Method | Data selector | Description |
|---|---|---|---|---|
| templates | api/v4/templates | GET | data | Returns list of templates for account/workspace |
| workspaces | api/v4/workspaces | GET | data | Returns list of workspaces |
| documents_generate | api/v4/documents/generate | POST | (response contains URL) | Generate a PDF from a template (POST primary) |
| templates_editor | api/v3/templates/{id}/editor | GET | (endpoint used for editor/preview via query params) | Open editor/preview for a template (interactive preview) |
| templates_output | api/v3/templates/{id}/output | GET | (binary/pdf or redirect) | Preview/Download output of template with sample data |
How do I authenticate with the Pdf-generator-api API?
The API uses a bearer token placed in the Authorization header: Authorization: Bearer . Example cURL in docs shows header 'Authorization: Bearer REPLACE_BEARER_TOKEN'.
1. Get your credentials
- Sign up / log in at https://app.pdfgeneratorapi.com/signup or the dashboard. 2) Open Account / API Credentials or Settings > API Credentials. 3) Create or copy your API Key / Secret (bearer token) shown in the dashboard. 4) Use that token in Authorization header for API calls.
2. Add them to .dlt/secrets.toml
[sources.pdf_generator_api_source] api_key = "your_bearer_token_here"
dlt reads this automatically at runtime — never hardcode tokens in your pipeline script. For production environments, see setting up credentials with dlt for environment variable and vault-based options.
How do I set up and run the pipeline?
Set up a virtual environment and install dlt:
uv venv && source .venv/bin/activate uv pip install "dlt[workspace]"
1. Install the dlt AI Workbench:
dlt ai init --agent <your-agent> # <agent>: claude | cursor | codex
This installs project rules, a secrets management skill, appropriate ignore files, and configures the dlt MCP server for your agent. Learn more →
2. Install the rest-api-pipeline toolkit:
dlt ai toolkit rest-api-pipeline install
This loads the skills and context about dlt the agent uses to build the pipeline iteratively, efficiently, and safely. The agent uses MCP tools to inspect credentials — it never needs to read your secrets.toml directly. Learn more →
3. Start LLM-assisted coding:
Use /find-source to load data from the Pdf-generator-api API into DuckDB.
The rest-api-pipeline toolkit takes over from here — it reads relevant API documentation, presents you with options for which endpoints to load, and follows a structured workflow to scaffold, debug, and validate the pipeline step by step.
4. Run the pipeline:
python pdf_generator_api_pipeline.py
If everything is configured correctly, you'll see output like this:
Pipeline pdf_generator_api_pipeline load step completed in 0.26 seconds 1 load package(s) were loaded to destination duckdb and into dataset pdf_generator_api_data The duckdb destination used duckdb:/pdf_generator_api.duckdb location to store data Load package 1749667187.541553 is LOADED and contains no failed jobs
Inspect your pipeline and data:
dlt pipeline pdf_generator_api_pipeline show
This opens the Pipeline Dashboard where you can verify pipeline state, load metrics, schema (tables, columns, types), and query the loaded data directly.
Python pipeline example
This example loads templates and workspaces from the Pdf-generator-api API into DuckDB. It mirrors the endpoint and data selector configuration from the table above:
import dlt from dlt.sources.rest_api import RESTAPIConfig, rest_api_resources @dlt.source def pdf_generator_api_source(api_key=dlt.secrets.value): config: RESTAPIConfig = { "client": { "base_url": "https://us1.pdfgeneratorapi.com", "auth": { "type": "bearer", "token": api_key, }, }, "resources": [ {"name": "templates", "endpoint": {"path": "api/v4/templates", "data_selector": "data"}}, {"name": "workspaces", "endpoint": {"path": "api/v4/workspaces", "data_selector": "data"}} ], } yield from rest_api_resources(config) def get_data() -> None: pipeline = dlt.pipeline( pipeline_name="pdf_generator_api_pipeline", destination="duckdb", dataset_name="pdf_generator_api_data", ) load_info = pipeline.run(pdf_generator_api_source()) print(load_info)
To add more endpoints, append entries from the resource table to the "resources" list using the same name, path, and data_selector pattern.
How do I query the loaded data?
Once the pipeline runs, dlt creates one table per resource. You can query with Python or SQL.
Python (pandas DataFrame):
import dlt data = dlt.pipeline("pdf_generator_api_pipeline").dataset() sessions_df = data.templates.df() print(sessions_df.head())
SQL (DuckDB example):
SELECT * FROM pdf_generator_api_data.templates LIMIT 10;
In a marimo or Jupyter notebook:
import dlt data = dlt.pipeline("pdf_generator_api_pipeline").dataset() data.templates.df().head()
See how to explore your data in marimo Notebooks and how to query your data in Python with dataset.
What destinations can I load Pdf-generator-api data to?
dlt supports loading into any of these destinations — only the destination parameter changes:
| Destination | Example value |
|---|---|
| DuckDB (local, default) | "duckdb" |
| PostgreSQL | "postgres" |
| BigQuery | "bigquery" |
| Snowflake | "snowflake" |
| Redshift | "redshift" |
| Databricks | "databricks" |
| Filesystem (S3, GCS, Azure) | "filesystem" |
Change the destination in dlt.pipeline(destination="snowflake") and add credentials in .dlt/secrets.toml. See the full destinations list.
Troubleshooting
Authentication failures
If you receive 401 Unauthorized, verify the Authorization header is set to 'Bearer ' and that the token is active in your account dashboard. Ensure you are using the regional endpoint that matches your account.
Rate limiting and quotas
The public docs reference enterprise and regional deployments; if you encounter 429 Too Many Requests, retry with exponential backoff and contact support to increase limits.
Template / data mapping errors
When generating PDFs, ensure the JSON you send contains the template field names (and arrays for table fields). Table components expect arrays (e.g. "line_items": [{...}, {...}]).
Ensure that the API key is valid to avoid 401 Unauthorized errors. Also, verify endpoint paths and parameters to avoid 404 Not Found errors.
Next steps
Continue your data engineering journey with the other toolkits of the dltHub AI Workbench:
data-exploration— Build custom notebooks, charts, and dashboards for deeper analysis with marimo notebooks.dlthub-runtime— Deploy, schedule, and monitor your pipeline in production.
dlt ai toolkit data-exploration install dlt ai toolkit dlthub-runtime install
Was this page helpful?
Community Hub
Need more dlt context for Pdf-generator-api?
Request dlt skills, commands, AGENT.md files, and AI-native context.