Detect PDF form fields / generate an edit schema
detect_form_fieldsDetect the fillable fields in a PDF form and return an edit schema (edit group): each property is a detected field with its type (text/checkbox/radio/dropdown/signature/table), page index, and bounding box. Use it to see what a form asks for, or as the scaffold for a structured fill — set extend_edit:value on each field and pass the populated schema to edit_pdf. Pass inputSchema to re-run detection against an existing schema (mapping mode) — for the edit-schema rules, call get_documentation with https://docs.extend.ai/editing/configuration.md first. Inspect runs with get_form_detection_run. Follow any llmContext guidance included in results.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| file | Yes | The form PDF. Exactly one of id/url — e.g. { "url": "https://..." } or { "id": "file_..." }, never a bare string. | |
| environment | Yes | "TEST" = the Test (development) environment, "PRODUCTION" = live. Must match a granted target from get_me (an API key pins one environment). | |
| inputSchema | No | Existing edit schema to map against. | |
| waitSeconds | No | Max seconds to block waiting on the run (clamped to the server wait budget). | |
| workspaceId | Yes | Target workspace (ws_...). Must be a granted workspace — get_me lists the accepted values. | |
| instructions | No | Guidance for schema generation. | |
| advancedOptions | No | { tableParsingEnabled?, radioEnumsEnabled?, nativeFieldsOnly?, conditionalGenerationEnabled? } |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| runId | Yes | ||
| output | No | Detected edit schema (PROCESSED only). | |
| status | Yes | PROCESSING | PROCESSED | FAILED, or "running" (resume via the get tool). | |
| metrics | No | ||
| runType | No | ||
| llmContext | No | ||
| failureReason | No | ||
| failureMessage | No |