Generate Edit Schema

from extend_ai import Extend, EditSchemaGenerationConfig, EditSchemaGenerationConfigAdvancedOptions
client = Extend(
    token="YOUR_TOKEN_HERE",
    extend_api_version="2025-04-21",
)
client.edit_schemas.generate(
    config=EditSchemaGenerationConfig(
        instructions="Detect the form fields and use human-readable field names.",
        advanced_options=EditSchemaGenerationConfigAdvancedOptions(
            radio_enums_enabled=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 EditRootJSONSchema 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.

Authentication

AuthorizationBearer

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

Headers

x-extend-api-version"2025-04-21"OptionalDefaults to 2025-04-21

API version to use for the request. If you do not specify a version, you will either receive a 400 Bad Request or be set to a previous legacy version. See API Versioning for more details.

API version to use for the request. If you do not specify a version, you will either receive a `400 Bad Request` or be set to a previous legacy version. See [API Versioning](https://docs.extend.ai/2025-04-21/developers/api-versioning) for more details.

Request

This endpoint expects an object.

fileobjectRequired

A file object containing either a URL or a fileId.

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

404

Not Found Error

422

Unprocessable Entity Error

500

Internal Server Error