Edit Runs Migration

1
// Before (2025-04-21)
2
{
3
  "success": true,
4
  "editRun": {
5
    "object": "edit_run",
6
    "id": "edit_run_xK9mLPqRtN3vS8wF5hB2cQ",
7
    "fileId": "file_Zk9mNP12Qw4yTv8BdR3H",
8
    "editedFile": {
9
      "fileId": "file_Ab3cDE45Fg6hIj7KlM8nO",
10
      "downloadUrl": "https://extend-ai-files.s3.amazonaws.com/..."
11
    },
12
    "status": "PROCESSED",
13
    "failureReason": null,
14
    "config": {
15
      "schema": {
16
        "type": "object",
17
        "properties": {
18
          "fullName": { "type": ["string", "null"], "extend_edit:field_type": "text" }
19
        }
20
      },
21
      "instructions": "Fill form with provided data",
22
      "advancedOptions": {
23
        "flattenPdf": true,
24
        "tableParsingEnabled": false
25
      }
26
    },
27
    "output": {
28
      "fullName": "John Doe"
29
    },
30
    "metrics": {
31
      "processingTimeMs": 1234,
32
      "fieldCount": 10,
33
      "pageCount": 2,
34
      "fieldFillingTimeMs": 300,
35
      "fieldDetectionTimeMs": 500,
36
      "fieldAnnotationTimeMs": 200
37
    },
38
    "usage": {
39
      "credits": 5.0
40
    }
41
  }
42
}
43
44
// After (2026-02-09) - all fields present, nullable fields use null when not applicable
45
{
46
  "object": "edit_run",
47
  "id": "edr_xK9mLPqRtN3vS8wF5hB2cQ",
48
  "file": {
49
    "object": "file",
50
    "id": "file_Zk9mNP12Qw4yTv8BdR3H",
51
    "name": "application-form.pdf",
52
    "type": "PDF",
53
    "parentFileId": null,
54
    "metadata": {},
55
    "createdAt": "2025-05-12T21:22:37.318Z",
56
    "updatedAt": "2025-05-12T21:22:37.324Z"
57
  },
58
  "status": "PROCESSED",
59
  "failureReason": null,
60
  "config": {
61
    "schema": {
62
      "type": "object",
63
      "properties": {
64
        "fullName": { "type": ["string", "null"], "extend_edit:field_type": "text" }
65
      }
66
    },
67
    "instructions": "Fill form with provided data",
68
    "advancedOptions": {
69
      "tableParsingEnabled": false,
70
      "flattenPdf": true
71
    }
72
  },
73
  "output": {
74
    "editedFile": {
75
      "id": "file_Ab3cDE45Fg6hIj7KlM8nO",
76
      "presignedUrl": "https://extend-ai-files.s3.amazonaws.com/..."
77
    },
78
    "filledValues": {
79
      "fullName": "John Doe"
80
    }
81
  },
82
  "metrics": {
83
    "processingTimeMs": 1234,
84
    "pageCount": 2,
85
    "fieldCount": 10,
86
    "fieldsDetectedCount": 8,
87
    "fieldsAnnotatedCount": 10,
88
    "fieldDetectionTimeMs": 500,
89
    "fieldAnnotationTimeMs": 200,
90
    "fieldFillingTimeMs": 300
91
  },
92
  "usage": {
93
    "credits": 5.0
94
  }
95
}

1
// Before (2025-04-21) - Using URL
2
{
3
  "file": {
4
    "fileUrl": "https://example.com/form.pdf",
5
    "fileName": "application-form.pdf"
6
  },
7
  "config": {
8
    "schema": { ... },
9
    "instructions": "Fill with provided data"
10
  }
11
}
12
13
// After (2026-02-09) - Using URL
14
{
15
  "file": {
16
    "url": "https://example.com/form.pdf",
17
    "name": "application-form.pdf"
18
  },
19
  "config": {
20
    "schema": { ... },
21
    "instructions": "Fill with provided data"
22
  }
23
}
24
25
// Before (2025-04-21) - Using File ID
26
{
27
  "file": {
28
    "fileId": "file_xK9mLPqRtN3vS8wF5hB2cQ"
29
  },
30
  "config": { ... }
31
}
32
33
// After (2026-02-09) - Using File ID
34
{
35
  "file": {
36
    "id": "file_xK9mLPqRtN3vS8wF5hB2cQ"
37
  },
38
  "config": { ... }
39
}

1
// Sync (for testing) — client.edit() returns the completed result
2
const result = await client.edit({
3
  file: { url: "https://..." },
4
  config: { schema: { ... } }
5
});
6
console.log(result.output);
7
8
// Async with polling (recommended for production)
9
const result = await client.editRuns.createAndPoll({
10
  file: { url: "https://..." },
11
  config: { schema: { ... } }
12
});
13
console.log(result.output);

1
// Before (2025-04-21) - In progress (returned EditRunStatus)
2
{
3
  "success": true,
4
  "editRun": {
5
    "object": "edit_run_status",
6
    "id": "edit_run_xK9mLPqRtN3vS8wF5hB2cQ",
7
    "status": "PROCESSING"
8
  }
9
}
10
11
// Before (2025-04-21) - Complete (returned EditRun)
12
{
13
  "success": true,
14
  "editRun": {
15
    "object": "edit_run",
16
    "id": "edit_run_xK9mLPqRtN3vS8wF5hB2cQ",
17
    "fileId": "file_Zk9mNP12Qw4yTv8BdR3H",
18
    "editedFile": { ... },
19
    "status": "PROCESSED",
20
    "config": { ... },
21
    "output": { ... },
22
    "metrics": { ... },
23
    "usage": { ... }
24
  }
25
}
26
27
// After (2026-02-09) - In progress (all fields present, nullable fields are null)
28
{
29
  "object": "edit_run",
30
  "id": "edr_xK9mLPqRtN3vS8wF5hB2cQ",
31
  "file": {
32
    "object": "file",
33
    "id": "file_Zk9mNP12Qw4yTv8BdR3H",
34
    "name": "form.pdf",
35
    ...
36
  },
37
  "status": "PROCESSING",
38
  "failureReason": null,
39
  "config": { ... },
40
  "output": null,
41
  "metrics": null,
42
  "usage": null
43
}
44
45
// After (2026-02-09) - Complete
46
{
47
  "object": "edit_run",
48
  "id": "edr_xK9mLPqRtN3vS8wF5hB2cQ",
49
  "file": { ... },
50
  "status": "PROCESSED",
51
  "failureReason": null,
52
  "config": { ... },
53
  "output": {
54
    "editedFile": {
55
      "id": "file_Ab3cDE45Fg6hIj7KlM8nO",
56
      "presignedUrl": "https://..."
57
    },
58
    "filledValues": { ... }
59
  },
60
  "metrics": { ... },
61
  "usage": { ... }
62
}

1
// Before (2025-04-21)
2
{
3
  "success": true,
4
  "editRunId": "edit_run_xK9mLPqRtN3vS8wF5hB2cQ",
5
  "message": "Edit run data has been successfully deleted."
6
}
7
8
// After (2026-02-09)
9
{
10
  "id": "edr_xK9mLPqRtN3vS8wF5hB2cQ"
11
}

1
// Before (2025-04-21)
2
const editedFileUrl = editRun.editedFile?.downloadUrl;
3
const editedFileId = editRun.editedFile?.fileId;
4
const filledValues = editRun.output;
5
6
// After (2026-02-09)
7
const editedFileUrl = editRun.output?.editedFile?.presignedUrl;
8
const editedFileId = editRun.output?.editedFile?.id;
9
const filledValues = editRun.output?.filledValues;