canonical: https://jentic.com/apis/ifillpdf.com/ifillpdf

# iFillPDF API

The iFillPDF API uploads PDF forms, runs AI field detection on them, stores the values a user enters, and generates the filled PDF. A document can be created from a multipart upload, a pdf_url, or a pending_upload_id, analysed asynchronously or synchronously, then filled with POST `/api/v1/documents/{document_id}/fill`, which returns the PDF directly or a signed URL when format=url. Analysed documents can be saved as reusable templates and cloned into new working documents without re-running analysis, and a per-user vault holds ID or financial documents for later pre-filling.

## For AI agents

Upload a PDF form, let iFillPDF detect its fields, write values into them, and download the filled PDF or reuse it as a template.

## Scope

Does not collect e-signatures, convert office files, or edit PDF page layout. Use for detecting and filling PDF form fields only.

## Capabilities

- Upload a PDF by file, pdf_url, or pending_upload_id and start AI field detection on it
- Analyse a PDF synchronously with POST `/api/v1/documents/analyze` when the caller needs fields back at once
- Fill an analysed document with values and get the PDF back, or a signed URL with format=url
- Save an analysed document as a template and clone it into a new working document without debiting page quota
- Search documents by name and filter by status such as completed, filling, or analysis_failed
- Store an ID or financial document in the per-user vault so it can pre-fill later forms

## Use cases

### AI agent completing PDF forms through Jentic

A developer wants their agent to complete administrative PDF forms from data it already has. Through Jentic the agent searches for 'fill a PDF form', loads the iFillPDF document creation operation with its input schema, uploads the form, waits for analysis to finish, and then calls the fill operation with the values, all with the API key injected at call time. The agent returns a signed URL to the filled PDF.

Example prompt: POST `/api/v1/documents` with a pdf_url, poll GET `/api/v1/documents/{document_id}` until analysis completes, then POST `/api/v1/documents/{document_id}/fill` with values and format=url

### Reusable form templates

Teams that file the same form repeatedly analyse it once and reuse it. POST `/api/v1/templates` creates a template from a source_document_id, and POST `/api/v1/templates/{template_id}/use` clones it into a new working document pre-filled with its frozen defaults. The spec notes the clone does not re-run analysis and does not debit the page quota.

Example prompt: POST `/api/v1/templates` with source_document_id and a name, then POST `/api/v1/templates/{template_id}/use` and fill the new document

### Document status review

Operations staff track which uploaded forms are ready and which need attention. GET `/api/v1/documents` lists the team's documents newest first, with q to search by name, status to filter by states such as completed or analysis_failed, and cursor pagination. A failed document can be retried with the reanalyze operation.

Example prompt: Call GET `/api/v1/documents` with status=analysis_failed, then POST `/api/v1/documents/{document_id}/reanalyze` for each result

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| POST | `/api/v1/documents` | Create and analyse a document asynchronously |
| POST | `/api/v1/documents/analyze` | Create and analyse a document synchronously |
| GET | `/api/v1/documents/{document_id}` | Get a document |
| POST | `/api/v1/documents/{document_id}/fill` | Fill a document |
| GET | `/api/v1/documents` | List documents |
| POST | `/api/v1/templates` | Create a template from a document |
| POST | `/api/v1/templates/{template_id}/use` | Instantiate a template |

## Key resources

- **Documents** — Create and analyse PDFs, read and update values, re-run analysis, fill, and delete
- **Templates** — Create templates from documents, list and update them, resolve public ones by slug, and clone them into new documents
- **Uploads** — Pending uploads and signed upload URLs for large PDFs
- **Vault** — Per-user store of ID and financial documents reused for pre-filling

## AI readiness

This API is usable in Jentic One now. Its AI-readiness score against Jentic's framework shows where it stands today and where improvements would make it even easier for agents to use.

- **Score:** 48 / 100
- **Maturity:** Foundational
- **Dimensions:**
  - Foundational Compliance: 81 / 100
  - Developer Experience & Jentic Compatibility: 63 / 100
  - AI-Readiness & Agent Experience: 22 / 100
  - Agent Usability: 94 / 100
  - Security: 60 / 100
  - AI Discoverability: 85 / 100
- **View full report:** https://jentic.com/apis/ifillpdf.com/ifillpdf/scorecard
- **How the score is calculated:** https://docs.jentic.com/reference/api-readiness-framework/overview/
- **More about the dimensions:** https://docs.jentic.com/reference/api-readiness-framework/specification/#dimensional-model-overview

### Score it yourself

Every API in the directory is allowlisted, so you can re-score it with no key required.

- **Score your own API:** https://jentic.com/scorecard.md
- **Scoring CLI agent skill:** https://github.com/jentic/jentic-api-scorecard/blob/main/skills/jentic-api-scorecard/SKILL.md

```sh
npx @jentic/api-scorecard-cli score <openapi-url>
```

## Why Jentic

- **Setup:** Wiring iFillPDF by hand means sending a bearer API key, choosing between multipart, pdf_url, and signed-upload paths, and polling an asynchronous analysis before you can fill. Through Jentic you install once, import iFillPDF from the API Directory, store the key once, and your agent calls it.
- **Permission scoping:** iFillPDF puts the document id in the URL path (`/api/v1/documents/{document_id}/...`), so a rule can pin your agent to one document and the operations you pick for it. You choose the operations it may call, so destructive ones like document or template deletion are not included unless you add them.
- **Credential handling:** Your iFillPDF API key is stored once, encrypted, by your own Jentic One instance and injected at execution time. It never enters the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'fill a PDF form' or 'create a template from a document', and Jentic returns the matching iFillPDF operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **Anvil API** — PDF generation, PDF filling, and e-signature workflows
- **PDF.co API** — Broad PDF processing including conversion, parsing, and form filling
- **iLovePDF** — PDF compression, merging, and signature tasks

## FAQ

### What authentication does the iFillPDF API use?

The iFillPDF API authenticates with an API key sent as a bearer token in the Authorization header, per its OpenAPI spec. Two operations are declared with no auth requirement: creating a pending upload and resolving a public template by slug. Through Jentic the key is stored encrypted by your own Jentic One instance and injected at call time.

### Can I get the filled PDF as a link instead of a file with the iFillPDF API?

Yes. POST `/api/v1/documents/{document_id}/fill` takes the values and returns the filled PDF by default. Pass format=url to get a signed URL instead; the spec also says a signed URL is returned when the PDF is too large for a direct response. An optional watermark field rides in the same body.

### What are the rate limits for the iFillPDF API?

The OpenAPI spec does not specify rate limits, though it notes that creating a document debits your page quota. Check https://www.ifillpdf.com for current limits and quota by plan.

### Is there an iFillPDF MCP server?

You don't need an MCP server to give your agent iFillPDF. Jentic connects it directly from the API Directory: import it, store your API key once, and your agent calls the upload, analysis, and fill operations it needs, discovered on demand.

### Can I limit what my agent is allowed to do with the iFillPDF API?

Yes. As a worked example, allow GET and the fill operation only under `/api/v1/documents/{document_id}` for one document id, and the agent can read that form and produce its filled PDF but cannot delete documents, change templates, or write to the vault. Every call it makes is logged.

### How do I fill a PDF form through Jentic?

Search Jentic for 'fill a PDF form', load the document creation operation, and upload the form or pass a pdf_url. Poll GET `/api/v1/documents/{document_id}` until analysis completes, then call the fill operation with values. To run it on your own infrastructure, install Jentic One from its GitHub repo.