Quick Start (5 minutes)

1
import { ExtendClient } from "extend-ai";
2
3
const client = new ExtendClient({ token: "YOUR_API_KEY" });
4
5
// client.extract() is for testing, we recommend using webhooks or polling with client.extractRuns.createAndPoll() in production
6
const result = await client.extract({
7
  extractor: {
8
    id: "<YOUR_EXTRACTOR_ID>", // This can be retrieved in the "Overview" tab of your newly created Extractor, in the UI
9
    overrideConfig: {
10
      // Put your config overrides here, or copy our sample invoice config below
11
    }
12
  },
13
  file: {
14
    url: "<YOUR_FILE_URL>", // You may use our sample invoice URL. Only keep one of url or id.
15
    id: "<YOUR_FILE_ID>" // If you uploaded a file into the Extend system, use this. Only keep one of id or url.
16
  }
17
});
18
19
console.log("Extract run:", result);

1
"config": {
2
    "baseProcessor": "extraction_performance",
3
    "baseVersion": "4.1.1",
4
    "schema": {
5
      "type": "object",
6
      "required": [
7
        "bill_to",
8
        "ship_to",
9
        "due_date",
10
        "line_items",
11
        "tax_amount",
12
        "balance_due",
13
        "vendor_name",
14
        "invoice_date",
15
        "total_amount",
16
        "invoice_number",
17
        "subtotal_amount"
18
      ],
19
      "properties": {
20
        "bill_to": {
21
          "type": [
22
            "string",
23
            "null"
24
          ],
25
          "description": "The name and address of the individual or organization being billed. This is the recipient of the invoice and payment request. May appear under labels such as 'Bill To', 'Billed To', or similar."
26
        },
27
        "ship_to": {
28
          "type": [
29
            "string",
30
            "null"
31
          ],
32
          "description": "The name and address where goods or services are to be delivered, if different from the billing address. May be labeled as 'Ship To', 'Shipping Address', or similar."
33
        },
34
        "due_date": {
35
          "type": [
36
            "string",
37
            "null"
38
          ],
39
          "description": "The date by which payment for this invoice is expected. May be explicitly labeled as 'Due Date', 'Payment Due', or may require calculation based on payment terms. The key is identifying when the payment obligation becomes due.",
40
          "extend:type": "date"
41
        },
42
        "line_items": {
43
          "type": "array",
44
          "items": {
45
            "type": "object",
46
            "required": [
47
              "amount",
48
              "quantity",
49
              "unit_price",
50
              "description"
51
            ],
52
            "properties": {
53
              "amount": {
54
                "type": [
55
                  "number",
56
                  "null"
57
                ],
58
                "description": "The total cost for this line item, typically calculated as quantity multiplied by unit price. May also be labeled as 'Amount', 'Line Total', or similar."
59
              },
60
              "quantity": {
61
                "type": [
62
                  "number",
63
                  "null"
64
                ],
65
                "description": "The number of units, items, or hours billed for this line item. Can be a whole number or decimal."
66
              },
67
              "unit_price": {
68
                "type": [
69
                  "number",
70
                  "null"
71
                ],
72
                "description": "The price per single unit of this item before quantity multiplication. Represents the base rate for one unit."
73
              },
74
              "description": {
75
                "type": [
76
                  "string",
77
                  "null"
78
                ],
79
                "description": "A description of the product or service provided in this line item. May include item names, service details, or product codes."
80
              }
81
            },
82
            "additionalProperties": false
83
          },
84
          "description": "The individual products, services, or charges that make up this invoice. Each item typically includes a description, quantity, unit price, and total amount. Format may vary from tables to lists."
85
        },
86
        "tax_amount": {
87
          "type": "object",
88
          "required": [
89
            "amount",
90
            "iso_4217_currency_code"
91
          ],
92
          "properties": {
93
            "amount": {
94
              "type": [
95
                "number",
96
                "null"
97
              ]
98
            },
99
            "iso_4217_currency_code": {
100
              "type": [
101
                "string",
102
                "null"
103
              ]
104
            }
105
          },
106
          "description": "The total tax applied to this invoice. May be labeled as 'Tax', 'Sales Tax', or include a percentage. Represents the sum of all taxes charged.",
107
          "extend:type": "currency",
108
          "additionalProperties": false
109
        },
110
        "balance_due": {
111
          "type": "object",
112
          "required": [
113
            "amount",
114
            "iso_4217_currency_code"
115
          ],
116
          "properties": {
117
            "amount": {
118
              "type": [
119
                "number",
120
                "null"
121
              ]
122
            },
123
            "iso_4217_currency_code": {
124
              "type": [
125
                "string",
126
                "null"
127
              ]
128
            }
129
          },
130
          "description": "The outstanding amount that remains to be paid on this invoice. May be labeled as 'Balance Due', 'Amount Due', or similar. In some documents, this may be the same as the total amount if no prior payments or credits have been applied.",
131
          "extend:type": "currency",
132
          "additionalProperties": false
133
        },
134
        "vendor_name": {
135
          "type": [
136
            "string",
137
            "null"
138
          ],
139
          "description": "The name of the company or individual issuing the invoice. This is the party requesting payment, often found at the top or in a header section."
140
        },
141
        "invoice_date": {
142
          "type": [
143
            "string",
144
            "null"
145
          ],
146
          "description": "The date when this invoice was created or issued. This is the official date for accounting and payment term calculations. May be labeled as 'Date', 'Invoice Date', or similar, and can appear in various formats.",
147
          "extend:type": "date"
148
        },
149
        "total_amount": {
150
          "type": "object",
151
          "required": [
152
            "amount",
153
            "iso_4217_currency_code"
154
          ],
155
          "properties": {
156
            "amount": {
157
              "type": [
158
                "number",
159
                "null"
160
              ]
161
            },
162
            "iso_4217_currency_code": {
163
              "type": [
164
                "string",
165
                "null"
166
              ]
167
            }
168
          },
169
          "description": "The final amount owed by the customer, including all items, taxes, and adjustments. This is the complete payment obligation. May be labeled as 'Total', 'Amount Due', 'Balance Due', or similar, and is often the most prominent monetary value on the document.",
170
          "extend:type": "currency",
171
          "additionalProperties": false
172
        },
173
        "invoice_number": {
174
          "type": [
175
            "string",
176
            "null"
177
          ],
178
          "description": "The unique identifier assigned to this invoice or billing document. This is the primary reference number for the transaction and may include numbers, letters, or special characters. Common labels include 'Invoice #', 'Bill Number', or may appear as a prominent number near the top or center of the document."
179
        },
180
        "subtotal_amount": {
181
          "type": "object",
182
          "required": [
183
            "amount",
184
            "iso_4217_currency_code"
185
          ],
186
          "properties": {
187
            "amount": {
188
              "type": [
189
                "number",
190
                "null"
191
              ]
192
            },
193
            "iso_4217_currency_code": {
194
              "type": [
195
                "string",
196
                "null"
197
              ]
198
            }
199
          },
200
          "description": "The sum of all line item amounts before taxes, discounts, or additional charges. May be labeled as 'Subtotal' or similar. Represents the total of goods and services prior to adjustments.",
201
          "extend:type": "currency",
202
          "additionalProperties": false
203
        }
204
      },
205
      "additionalProperties": false
206
    },
207
    "advancedOptions": {
208
      "citationsEnabled": true,
209
      "chunkingOptions": {},
210
      "advancedFigureParsingEnabled": true
211
    }
212
  }

1
import { ExtendClient } from "extend-ai";
2
import * as fs from "fs";
3
const client = new ExtendClient({ token: "YOUR_TOKEN" });
4
const result = await client.files.upload(fs.createReadStream("/path/to/your/file"));
5
console.log(result);

1
import { ExtendClient } from "extend-ai";
2
import * as fs from "fs";
3
4
const client = new ExtendClient({ token: "YOUR_API_KEY" });
5
6
// Upload the file
7
const upload = await client.files.upload(fs.createReadStream("/path/to/your/file.pdf"));
8
const fileId = upload.id;
9
10
// Run the extractor — client.extract() is for testing, we recommend using webhooks or polling in production
11
const result = await client.extract({
12
  extractor: {
13
    id: "<YOUR_EXTRACTOR_ID>",
14
    overrideConfig: {
15
      // Optional: override specific config options from your extractor
16
    }
17
  },
18
  file: { id: fileId }
19
});
20
21
console.log("Extract run:", result);