apyhub
Back
▣ DATA EXTRACTION · DEVELOPER TOOLS

Extract PDF Form Fields API

What it does

PDF Form Fields lists the fillable fields in a PDF form. Send a PDF file in the file body field, and get back a structured response describing the form fields the document contains.

Use PDF Form Fields when you need to inspect a form before mapping it into your own workflow. For example, you can check whether a contract, onboarding packet, or application form includes the fields your app expects before you build a submission flow.

The service accepts a single PDF form up to 20 MB. It is designed for documents with interactive form controls, so you can programmatically discover the form structure instead of parsing the file yourself.

If you work with document ingestion, form automation, or PDF processing, PDF Form Fields gives you a lightweight way to identify fillable inputs in uploaded PDFs.

POST
List the fillable fields in a PDF form
https://api.eu.apyhub.com/freedailypro/extract-pdf-form-fields/form-fields

QUICKSTART

GUIDE

Quickstart

Upload a PDF form to retrieve its fillable fields and available options.

curl -X POST "https://api.eu.apyhub.com/freedailypro/extract-pdf-form-fields/form-fields" \
  -H "apy-token: $APY_TOKEN" \
  -F "file=@/path/to/form.pdf"

What you'll get back

Returns a JSON object containing the total field count and the details of each detected field, including its name, type, and available options when applicable.

{
  "fieldCount": 3,
  "fields": [
    {
      "name": "first_name",
      "kind": "text"
    },
    {
      "name": "gender",
      "kind": "radio",
      "options": ["female", "male", "other"]
    },
    {
      "name": "department",
      "kind": "dropdown",
      "options": ["Operations", "Finance", "Engineering"]
    }
  ]
}
TRY ITLIVE · 10 ATOMS
Loading your default key…
The full key is used to call the gateway and stays in this tab — never sent to orbit or saved.
Max 100MB total per request (all files combined). Larger? Use this API's URL-based endpoint instead, if it has one.
body*
The PDF form. Up to 20 MB.

About this endpoint

What it does

Lists the fillable fields found in a PDF form. The request uploads a PDF file, and the response schema is currently not defined beyond a successful JSON object.

Request Body

ParameterTypeMandatoryDescription
fileStringYesThe PDF form file, provided as binary upload. Up to 20 MB.

Response

Returns a JSON object containing the total number of detected fields and an array of field details.

ParameterTypeDescription
fieldCountIntegerTotal number of detected form fields.
fieldsArrayList of detected form fields.
fields[].nameStringName of the form field.
fields[].kindStringField type, such as text, radio, dropdown, checkbox, or unsupported.
fields[].optionsArray of stringsAvailable options for selectable fields, such as radio buttons and dropdowns. Included when applicable.

Max 100MB total per request (all files combined). Larger? Use this API's URL-based endpoint instead, if it has one.

▣ COMMON ERRORS

Errors any endpoint can return

400bad_request

Required parameter missing or malformed body.

401unauthorized

API key missing, revoked, or not authorized for this service.

429rate_limited

Your plan's per-second rate exceeded. Retry with exponential backoff.

503upstream_busy

Backend temporarily unavailable. Try again in a few seconds.

Similar APIs

Closest matches in the catalog based on this service.

CALLFill PDF Form Fields APIFreeDailyProCALLExtract Text from PDF Document APIDosvak LLCCALLExtract Text from PDF APIApyHubCALLExtract Table from PDF Document APIDosvak LLC

From the blog

Reads that touch this API.

Top 5 Use Cases: Extract Text from PDF for your applications and workflowsJul 9, 2026HTML to PDF API: What It Does and Why Teams Use OneAug 19, 2026PDF Automation API Guide 2026: Generate, Merge, Watermark and Extract PDFsSep 22, 2026Automate Invoice Processing with SharpAPI’s Invoice Parsing API on ApyHubJul 9, 2026