---
title: "Extract Fields"
method: POST
path: "/api/pdf/extract-fields"
tags: ["PDF Form Processing"]
---

# Extract Fields

`POST /api/pdf/extract-fields`

Extract form field schema from a PDF file.

Args:
    file: PDF file

Returns:
    ExtractFieldsResponse with detected form fields

## Response `200`

Successful Response

- ExtractFieldsResponse — Response model for field extraction
  - `success` boolean, required
  - `fields` PDFFormField[], required
    - `name` string, required
    - `type` string, required
    - `value` string, nullable
    - `default_value` string, nullable
    - `tooltip` string, nullable
    - `required` boolean
    - `readonly` boolean
    - `multiline` boolean
    - `options` object[], nullable
  - `page_count` integer, required
  - `is_fillable` boolean, required
  - `error` string, nullable

## Other responses

- `422` — Validation Error

---

[API](https://skmtc.net/qomplement/apis/fastapi.md) · [All operations](https://skmtc.net/qomplement/apis/fastapi/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/qomplement/fastapi/versions/718de1c0d866/schema)