Generate Edit Schema

curl -X POST https://api.extend.ai/edit_schemas/generate \
     -H "x-extend-api-version: 2026-02-09" \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "file": {
    "url": "https://example.com/form.pdf"
  },
  "config": {
    "instructions": "Detect the form fields and use human-readable field names.",
    "advancedOptions": {
      "radioEnumsEnabled": true
    }
  }
}'

{
  "schema": {
    "type": "object",
    "properties": {},
    "required": [
      "string"
    ],
    "additionalProperties": true,
    "dependentRequired": {},
    "if": {
      "properties": {},
      "required": [
        "string"
      ],
      "dependentRequired": {},
      "allOf": [
        null
      ],
      "oneOf": [
        null
      ],
      "anyOf": [
        null
      ]
    },
    "then": {
      "properties": {},
      "required": [
        "string"
      ],
      "dependentRequired": {},
      "allOf": [
        null
      ],
      "oneOf": [
        null
      ],
      "anyOf": [
        null
      ]
    },
    "else": {
      "properties": {},
      "required": [
        "string"
      ],
      "dependentRequired": {},
      "allOf": [
        null
      ],
      "oneOf": [
        null
      ],
      "anyOf": [
        null
      ]
    },
    "allOf": [
      {
        "properties": {},
        "required": [
          "string"
        ],
        "dependentRequired": {},
        "allOf": [
          null
        ],
        "oneOf": [
          null
        ],
        "anyOf": [
          null
        ]
      }
    ],
    "oneOf": [
      {
        "properties": {},
        "required": [
          "string"
        ],
        "dependentRequired": {},
        "allOf": [
          null
        ],
        "oneOf": [
          null
        ],
        "anyOf": [
          null
        ]
      }
    ],
    "anyOf": [
      {
        "properties": {},
        "required": [
          "string"
        ],
        "dependentRequired": {},
        "allOf": [
          null
        ],
        "oneOf": [
          null
        ],
        "anyOf": [
          null
        ]
      }
    ],
    "not": {
      "properties": {},
      "required": [
        "string"
      ],
      "dependentRequired": {},
      "allOf": [
        null
      ],
      "oneOf": [
        null
      ],
      "anyOf": [
        null
      ]
    }
  },
  "annotatedSchema": {
    "type": "object",
    "properties": {},
    "required": [
      "string"
    ],
    "additionalProperties": true,
    "dependentRequired": {},
    "if": {
      "properties": {},
      "required": [
        "string"
      ],
      "dependentRequired": {},
      "allOf": [
        null
      ],
      "oneOf": [
        null
      ],
      "anyOf": [
        null
      ]
    },
    "then": {
      "properties": {},
      "required": [
        "string"
      ],
      "dependentRequired": {},
      "allOf": [
        null
      ],
      "oneOf": [
        null
      ],
      "anyOf": [
        null
      ]
    },
    "else": {
      "properties": {},
      "required": [
        "string"
      ],
      "dependentRequired": {},
      "allOf": [
        null
      ],
      "oneOf": [
        null
      ],
      "anyOf": [
        null
      ]
    },
    "allOf": [
      {
        "properties": {},
        "required": [
          "string"
        ],
        "dependentRequired": {},
        "allOf": [
          null
        ],
        "oneOf": [
          null
        ],
        "anyOf": [
          null
        ]
      }
    ],
    "oneOf": [
      {
        "properties": {},
        "required": [
          "string"
        ],
        "dependentRequired": {},
        "allOf": [
          null
        ],
        "oneOf": [
          null
        ],
        "anyOf": [
          null
        ]
      }
    ],
    "anyOf": [
      {
        "properties": {},
        "required": [
          "string"
        ],
        "dependentRequired": {},
        "allOf": [
          null
        ],
        "oneOf": [
          null
        ],
        "anyOf": [
          null
        ]
      }
    ],
    "not": {
      "properties": {},
      "required": [
        "string"
      ],
      "dependentRequired": {},
      "allOf": [
        null
      ],
      "oneOf": [
        null
      ],
      "anyOf": [
        null
      ]
    }
  },
  "mappingResult": {
    "matches": [
      {
        "inputPath": "applicant.address.street",
        "formFieldKey": "applicant_address_street"
      }
    ],
    "unmatchedInputPaths": [
      "string"
    ],
    "unusedFormFieldKeys": [
      "string"
    ]
  }
}

Detect fields in a PDF form and synchronously return an edit schema payload.

Use this endpoint when you want Extend to bootstrap an EditRootJSON schema from an existing form, optionally mapping an existing schema onto the detected fields.

This endpoint returns the generated schema directly. There are no schema generation run resources to poll or delete.

For more details, see the Generate Edit Schema guide and the Edit File guide.

Detect fields in a PDF form and synchronously return an edit schema payload. Use this endpoint when you want Extend to bootstrap an `EditRootJSON` schema from an existing form, optionally mapping an existing schema onto the detected fields. This endpoint returns the generated schema directly. There are no schema generation run resources to poll or delete. For more details, see the [Generate Edit Schema guide](https://docs.extend.ai/2026-02-09/product/editing/generate-edit-schema) and the [Edit File guide](https://docs.extend.ai/2026-02-09/product/editing/edit).

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.

fileobjectRequired

The file to analyze. Files can be provided as a URL or an Extend file ID.

configobjectOptional

Configuration options for edit schema generation.

Response

Successfully generated edit schema

schemaobject

The final generated schema after mapping. If no input schema was provided this will be the same as the annotatedSchema.

annotatedSchemaobject or null

The original schema that was detected and annotated from the file.

mappingResultobject or null

Mapping information between inputSchema paths and detected form fields when an input schema was provided.

Errors

400

Bad Request Error

401

Unauthorized Error

402

Payment Required Error

403

Forbidden Error

404

Not Found Error

422

Unprocessable Entity Error

429

Too Many Requests Error

500

Internal Server Error

Authentication

Headers

Request

Response

Errors