For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
GuidesAPI ReferenceChangelogModel Versioning
GuidesAPI ReferenceChangelogModel Versioning
    • Getting Started
    • Authentication
    • API Versioning
    • SDKs
    • Deployments
    • Error Codes
    • Async Processing
  • Endpoints
  • Webhook Events
      • POSTEdit Run Processed
      • POSTEdit Run Failed
LogoLogo
Webhook EventsEdit

Edit Run Processed

Payload
1{
2 "eventId": "string",
3 "payload": {
4 "object": "edit_run",
5 "id": "edr_xK9mLPqRtN3vS8wF5hB2cQ",
6 "file": {
7 "object": "file",
8 "id": "file_xK9mLPqRtN3vS8wF5hB2cQ",
9 "name": "Invoices.pdf",
10 "type": "PDF",
11 "parentFileId": "file_Zk9mNP12Qw4yTv8BdR3H",
12 "metadata": {},
13 "createdAt": "2024-03-21T16:45:00Z",
14 "updatedAt": "2024-03-21T16:45:00Z"
15 },
16 "status": "PROCESSING",
17 "failureReason": "FILE_TYPE_NOT_SUPPORTED",
18 "failureMessage": "File type not supported. Edit runs currently require a PDF.",
19 "config": {},
20 "output": {
21 "editedFile": {
22 "id": "file_Ab3cDE45Fg6hIj7KlM8nO",
23 "presignedUrl": "https://extend-ai-files.s3.amazonaws.com/..."
24 }
25 },
26 "metrics": {
27 "processingTimeMs": 1234,
28 "pageCount": 5,
29 "fieldCount": 10,
30 "fieldsDetectedCount": 8,
31 "fieldsAnnotatedCount": 10,
32 "fieldDetectionTimeMs": 500,
33 "fieldAnnotationTimeMs": 200,
34 "fieldFillingTimeMs": 300
35 },
36 "usage": {
37 "credits": 9
38 }
39 },
40 "eventType": "edit_run.processed"
41}
Was this page helpful?
Previous

Edit Run Failed

Next
Built with

Payload

The payload of this webhook request is an object.
eventIdstringRequired
Unique identifier for the event
payloadobjectRequired
Edit run object.

Response

200
Return a 200 status to indicate that the webhook was received successfully