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
      • POSTClassify Run Processed
      • POSTClassify Run Failed
      • POSTClassifier Created
      • POSTClassifier Updated
      • POSTClassifier Deleted
      • POSTClassifier Draft Updated
      • POSTClassifier Version Published
LogoLogo
Webhook EventsClassify

Classify Run Processed

Payload
1{
2  "eventId": "string",
3  "payload": {
4    "object": "classify_run",
5    "id": "clr_Xj8mK2pL9nR4vT7qY5wZ",
6    "status": "PROCESSING",
7    "output": {
8      "id": "string",
9      "type": "string",
10      "confidence": 1.1,
11      "insights": [
12        {
13          "type": "reasoning",
14          "content": "string"
15        }
16      ]
17    },
18    "classifier": {
19      "object": "classifier",
20      "id": "cl_Xj8mK2pL9nR4vT7qY5wZ",
21      "name": "Document Type Classifier",
22      "createdAt": "2024-03-21T16:45:00Z",
23      "updatedAt": "2024-03-21T16:45:00Z"
24    },
25    "classifierVersion": {
26      "object": "classifier_version",
27      "id": "clv_xK9mLPqRtN3vS8wF5hB2cQ",
28      "description": "Added new document types for Q4 processing",
29      "version": "draft",
30      "classifierId": "cl_Xj8mK2pL9nR4vT7qY5wZ",
31      "createdAt": "2024-03-21T16:45:00Z"
32    },
33    "initialOutput": {
34      "id": "string",
35      "type": "string",
36      "confidence": 1.1,
37      "insights": [
38        {
39          "type": "reasoning",
40          "content": "string"
41        }
42      ]
43    },
44    "reviewedOutput": {
45      "id": "string",
46      "type": "string",
47      "confidence": 1.1,
48      "insights": [
49        {
50          "type": "reasoning",
51          "content": "string"
52        }
53      ]
54    },
55    "failureReason": "PARSING_ERROR",
56    "failureMessage": "string",
57    "metadata": {},
58    "reviewed": false,
59    "edited": false,
60    "config": {
61      "classifications": [
62        {
63          "id": "my_unique_id",
64          "type": "invoice",
65          "description": "An invoice is a document that lists the items purchased and the total amount due."
66        }
67      ]
68    },
69    "file": {
70      "object": "file",
71      "id": "file_xK9mLPqRtN3vS8wF5hB2cQ",
72      "name": "Invoices.pdf",
73      "type": "PDF",
74      "parentFileId": "file_Zk9mNP12Qw4yTv8BdR3H",
75      "metadata": {},
76      "createdAt": "2024-03-21T16:45:00Z",
77      "updatedAt": "2024-03-21T16:45:00Z"
78    },
79    "parseRunId": "pr_Xj8mK2pL9nR4vT7qY5wZ",
80    "dashboardUrl": "https://dashboard.extend.ai/runs/clr_Xj8mK2pL9nR4vT7qY5wZ",
81    "usage": {
82      "credits": 9
83    },
84    "createdAt": "2024-03-21T16:45:00Z",
85    "updatedAt": "2024-03-21T16:45:00Z"
86  },
87  "eventType": "classify_run.processed"
88}
Was this page helpful?
Previous

Classify Run Failed

Next
Built with

Payload

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

Response

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