Edit File | extend

import { ExtendClient } from "extend-ai";
const client = new ExtendClient({ token: "YOUR_TOKEN" });
await client.edit({
    file: {
        url: "https://example.com/form.pdf"
    },
    config: {
        instructions: "Fill out the form with the provided data",
        advancedOptions: {
            flattenPdf: true
        }
    }
});

{
  "object": "edit_run",
  "id": "edit_run_xK9mLPqRtN3vS8wF5hB2cQ",
  "fileId": "file_Zk9mNP12Qw4yTv8BdR3H",
  "status": {
    "object": "edit_run_status",
    "id": "edit_run_xK9mLPqRtN3vS8wF5hB2cQ",
    "status": "PROCESSING",
    "failureReason": "string"
  },
  "config": {
    "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
        ]
      }
    },
    "instructions": "string",
    "schemaGenerationInstructions": "string",
    "advancedOptions": {
      "flattenPdf": true,
      "tableParsingEnabled": true,
      "radioEnumsEnabled": true,
      "nativeFieldsOnly": true
    }
  },
  "metrics": {
    "processingTimeMs": 1.1,
    "fieldCount": 1,
    "pageCount": 1,
    "fieldFillingTimeMs": 1.1,
    "fieldDetectionTimeMs": 1.1,
    "fieldAnnotationTimeMs": 1.1
  },
  "editedFile": {
    "fileId": "file_Ab3cDE45Fg6hIj7KlM8nO",
    "downloadUrl": "https://extend-ai-files.s3.amazonaws.com/..."
  },
  "failureReason": "string",
  "output": {},
  "usage": {
    "credits": 1.1
  }
}

Edit and manipulate PDF documents by detecting and filling form fields. This is a synchronous endpoint that will wait for the edit operation to complete (up to 5 minutes) before returning results. For longer operations, use the Edit File Async endpoint.

Authentication

AuthorizationBearer

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

Request

This endpoint expects an object.

fileobjectRequired

A file object containing either a URL or a fileId.

configobjectOptional

Configuration for the edit operation. Field values should be specified using extend_edit:value on each field in the schema.

Response

Successfully edited file

objectenum

The type of object. Will always be "edit_run".

Allowed values:

idstring

A unique identifier for the edit run. Will always start with "edit_run_"

Example: "edit_run_xK9mLPqRtN3vS8wF5hB2cQ"

fileIdstring

The identifier of the input file that was edited.

statusobject

Minimal edit run status object without edit results.

configobject

The configuration used for this edit run.

metricsobject

Metrics about the editing process.

editedFileobject

Information about the edited output file. Only present when status is "PROCESSED".

failureReasonstring

The reason for failure if status is "FAILED".

outputmap from strings to any

The extracted/detected field values from the edited document.

usageobject

Usage credits consumed by this edit run.

Errors

400

Bad Request Error

401

Unauthorized Error

402

Payment Required Error

404

Not Found Error

422

Unprocessable Entity Error

500

Internal Server Error

Authentication

Headers

Request

Response

Errors