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.
Book a demoLog in
DocumentationAPI ReferenceModel VersioningChangelog
DocumentationAPI ReferenceModel VersioningChangelog
    • Authentication
    • API Versioning
    • Deployments
    • Error Handling
  • Endpoints
      • POSTEdit File (Sync)
      • POSTEdit File (Async)
      • GETGet Edit Run
      • DELDelete Edit Run
      • GETGet Edit Template
      • POSTGenerate Edit Schema
  • Webhook Events
LogoLogo
Book a demoLog in
EndpointsEdit

Get Edit Template

GET
/edit_templates/:id
GET
/edit_templates/:id
$curl https://api.extend.ai/edit_templates/edit_template_id_here \
>     -H "x-extend-api-version: 2026-02-09" \
>     -H "Authorization: Bearer <token>"
1{
2  "object": "edit_template",
3  "id": "edt_xK9mLPqRtN3vS8wF5hB2cQ",
4  "name": "W-9 Template",
5  "description": "Fill a W-9 form",
6  "file": {
7    "object": "file",
8    "id": "file_xK9mLPqRtN3vS8wF5hB2cQ",
9    "name": "Invoices.pdf",
10    "type": "PDF",
11    "parentFileId": "file_Zk9mNP12Qw4yTv8BdR3H",
12    "metadata": {
13      "pageCount": 30,
14      "parentSplit": {
15        "id": "string",
16        "type": "Invoice",
17        "identifier": "other_2_9",
18        "startPage": 1,
19        "endPage": 10
20      }
21    },
22    "createdAt": "2024-03-21T16:45:00Z",
23    "updatedAt": "2024-03-21T16:45:00Z"
24  },
25  "config": {
26    "schema": {
27      "type": "object",
28      "properties": {},
29      "required": [
30        "string"
31      ],
32      "additionalProperties": true,
33      "dependentRequired": {},
34      "if": {
35        "properties": {},
36        "required": [
37          "string"
38        ],
39        "dependentRequired": {},
40        "allOf": [
41          null
42        ],
43        "oneOf": [
44          null
45        ],
46        "anyOf": [
47          null
48        ]
49      },
50      "then": {
51        "properties": {},
52        "required": [
53          "string"
54        ],
55        "dependentRequired": {},
56        "allOf": [
57          null
58        ],
59        "oneOf": [
60          null
61        ],
62        "anyOf": [
63          null
64        ]
65      },
66      "else": {
67        "properties": {},
68        "required": [
69          "string"
70        ],
71        "dependentRequired": {},
72        "allOf": [
73          null
74        ],
75        "oneOf": [
76          null
77        ],
78        "anyOf": [
79          null
80        ]
81      },
82      "allOf": [
83        {
84          "properties": {},
85          "required": [
86            "string"
87          ],
88          "dependentRequired": {},
89          "allOf": [
90            null
91          ],
92          "oneOf": [
93            null
94          ],
95          "anyOf": [
96            null
97          ]
98        }
99      ],
100      "oneOf": [
101        {
102          "properties": {},
103          "required": [
104            "string"
105          ],
106          "dependentRequired": {},
107          "allOf": [
108            null
109          ],
110          "oneOf": [
111            null
112          ],
113          "anyOf": [
114            null
115          ]
116        }
117      ],
118      "anyOf": [
119        {
120          "properties": {},
121          "required": [
122            "string"
123          ],
124          "dependentRequired": {},
125          "allOf": [
126            null
127          ],
128          "oneOf": [
129            null
130          ],
131          "anyOf": [
132            null
133          ]
134        }
135      ],
136      "not": {
137        "properties": {},
138        "required": [
139          "string"
140        ],
141        "dependentRequired": {},
142        "allOf": [
143          null
144        ],
145        "oneOf": [
146          null
147        ],
148        "anyOf": [
149          null
150        ]
151      }
152    },
153    "instructions": "string",
154    "schemaGenerationInstructions": "string",
155    "advancedOptions": {
156      "tableParsingEnabled": true,
157      "flattenPdf": true,
158      "radioEnumsEnabled": true,
159      "nativeFieldsOnly": true
160    }
161  },
162  "schemaConfig": {
163    "inputSchema": {
164      "type": "object",
165      "properties": {},
166      "required": [
167        "string"
168      ],
169      "additionalProperties": true,
170      "dependentRequired": {},
171      "if": {
172        "properties": {},
173        "required": [
174          "string"
175        ],
176        "dependentRequired": {},
177        "allOf": [
178          null
179        ],
180        "oneOf": [
181          null
182        ],
183        "anyOf": [
184          null
185        ]
186      },
187      "then": {
188        "properties": {},
189        "required": [
190          "string"
191        ],
192        "dependentRequired": {},
193        "allOf": [
194          null
195        ],
196        "oneOf": [
197          null
198        ],
199        "anyOf": [
200          null
201        ]
202      },
203      "else": {
204        "properties": {},
205        "required": [
206          "string"
207        ],
208        "dependentRequired": {},
209        "allOf": [
210          null
211        ],
212        "oneOf": [
213          null
214        ],
215        "anyOf": [
216          null
217        ]
218      },
219      "allOf": [
220        {
221          "properties": {},
222          "required": [
223            "string"
224          ],
225          "dependentRequired": {},
226          "allOf": [
227            null
228          ],
229          "oneOf": [
230            null
231          ],
232          "anyOf": [
233            null
234          ]
235        }
236      ],
237      "oneOf": [
238        {
239          "properties": {},
240          "required": [
241            "string"
242          ],
243          "dependentRequired": {},
244          "allOf": [
245            null
246          ],
247          "oneOf": [
248            null
249          ],
250          "anyOf": [
251            null
252          ]
253        }
254      ],
255      "anyOf": [
256        {
257          "properties": {},
258          "required": [
259            "string"
260          ],
261          "dependentRequired": {},
262          "allOf": [
263            null
264          ],
265          "oneOf": [
266            null
267          ],
268          "anyOf": [
269            null
270          ]
271        }
272      ],
273      "not": {
274        "properties": {},
275        "required": [
276          "string"
277        ],
278        "dependentRequired": {},
279        "allOf": [
280          null
281        ],
282        "oneOf": [
283          null
284        ],
285        "anyOf": [
286          null
287        ]
288      }
289    },
290    "instructions": "string",
291    "advancedOptions": {
292      "tableParsingEnabled": true,
293      "radioEnumsEnabled": true,
294      "nativeFieldsOnly": true
295    }
296  },
297  "createdAt": "2024-03-21T16:45:00Z",
298  "updatedAt": "2024-03-21T16:45:00Z"
299}

Retrieve a saved edit template by ID.

Use this endpoint to inspect the source file, default edit configuration, and optional schema generation configuration saved on an edit template. You can reuse the returned config with POST /edit or POST /edit_runs, and reuse schemaConfig with POST /edit_schemas/generate.

Was this page helpful?
Previous

Generate Edit Schema

Next
Built with

Authentication

AuthorizationBearer

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

Path parameters

idstringRequired

The unique identifier for the edit template.

Example: "edt_xK9mLPqRtN3vS8wF5hB2cQ"

Headers

x-extend-api-version"2026-02-09"OptionalDefaults to 2026-02-09
API version to use for the request. If you're using an SDK, you can ignore this parameter. If you are not using an SDK and do not specify a version, you will either receive a `400 Bad Request` or be set to a previous legacy version. See [API Versioning](https://docs.extend.ai/2026-02-09/api-reference/api-versioning) for more details.
x-extend-workspace-idstringOptional
The workspace ID to target. **Required** when using an organization-scoped API key; optional for workspace-scoped keys (the key is already tied to a workspace). See [Authentication](https://docs.extend.ai/2026-02-09/api-reference/authentication) for details on API key scopes.

Response

Successfully retrieved edit template
objectenum

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

Allowed values:
idstring

A unique identifier for the edit template.

Example: "edt_xK9mLPqRtN3vS8wF5hB2cQ"

namestring
The name of the edit template.
descriptionstring or null
The description of the edit template, if one was provided.
fileobject
The source file associated with this edit template.
configobject
Default edit configuration saved on the template. Empty when no edit configuration was saved.
schemaConfigobject or null
Optional schema generation configuration saved on the template.
createdAtstringformat: "date-time"

The time (in UTC) at which the object was created. Will follow the RFC 3339 format.

Example: "2024-03-21T16:45:00Z"

updatedAtstringformat: "date-time"

The time (in UTC) at which the object was last updated. Will follow the RFC 3339 format.

Example: "2024-03-21T16:45:00Z"

Errors

400
Bad Request Error
401
Unauthorized Error
402
Payment Required Error
403
Forbidden Error
404
Not Found Error
422
Unprocessable Entity Error
429
Too Many Requests Error
500
Internal Server Error

API version to use for the request. If you’re using an SDK, you can ignore this parameter. If you are not using an SDK and do not specify a version, you will either receive a 400 Bad Request or be set to a previous legacy version. See API Versioning for more details.

The workspace ID to target. Required when using an organization-scoped API key; optional for workspace-scoped keys (the key is already tied to a workspace). See Authentication for details on API key scopes.