Update template
PUT /v2/document/template/{templateId}
Updates a template based on the provided data, then returns the newly updated template version
Authorizations
Section titled “Authorizations ”Parameters
Section titled “ Parameters ”Path Parameters
Section titled “Path Parameters ”The ID of the template
Example
77a0049c-7683-45ff-956f-656f257048f7Header Parameters
Section titled “Header Parameters ”API Key
API Secret
Request Body required
Section titled “Request Body required ”object
The Template Name
Japanese InvoiceThe Template Description
Template used for extract data from japanese invoices received in Australia.Type of template, associated with the type of document. Must be one of the predefined document types.
invoiceThe Template Tag
InvoiceThe Provider Model Id (see document/models)
77a0049c-7683-45ff-956f-656f257048f7A prompt array of strings
object
Unique identifier for the prompt. Used internally for tracking and referencing specific prompts.
a1b2c3d4-5678-4e2a-9c1a-2b3c4d5e6f7aHuman-readable name for the prompt. Used for display purposes and should be descriptive of what the prompt extracts.
Invoice TotalThe data type for storing the extracted value. This determines how the value will be validated and stored in the database (e.g., string, number, float, date, boolean).
stringOptional formatting instructions for the extracted value. Can include transformation rules like “add # sign before all responses” or “convert to uppercase”. Leave empty if no formatting is needed.
Add # sign before all responsesClear, specific instructions for the AI model on what information to extract from the document. Should be detailed enough to guide accurate extraction.
What is the total amount of the invoice?The input/display type that determines how the field should be presented and extracted. This affects UI rendering, validation rules, and extraction behavior (e.g., single line text, email, phone, address, table).
singleLineResponses
Section titled “ Responses ”The resource has been successfully updated.
object
A unique template Version Id
77a0049c-7683-45ff-956f-656f257048f7A template Id grouped on version
77a0049c-7683-45ff-956f-656f257048f7The Template Version
1A template name
JapaneseInvoiceA template description
Used for extract all documents from the japanese providers.Type of template, associated with the type of document. Must be one of the predefined document types.
invoiceIdentifies your templates in the dashboard UI
customer-templateGroup of prompts or properties to be extracted or analyzed from the document
object
Unique identifier for the prompt. Used internally for tracking and referencing specific prompts.
a1b2c3d4-5678-4e2a-9c1a-2b3c4d5e6f7aHuman-readable name for the prompt. Used for display purposes and should be descriptive of what the prompt extracts.
Invoice TotalThe data type for storing the extracted value. This determines how the value will be validated and stored in the database (e.g., string, number, float, date, boolean).
stringOptional formatting instructions for the extracted value. Can include transformation rules like “add # sign before all responses” or “convert to uppercase”. Leave empty if no formatting is needed.
Add # sign before all responsesClear, specific instructions for the AI model on what information to extract from the document. Should be detailed enough to guide accurate extraction.
What is the total amount of the invoice?The input/display type that determines how the field should be presented and extracted. This affects UI rendering, validation rules, and extraction behavior (e.g., single line text, email, phone, address, table).
singleLineThe provider model id
77a0049c-7683-45ff-956f-656f257048f7The date the template was created
2021-01-01T00:00:00.000ZThe date the template was updated
2021-01-01T00:00:00.000ZBad Request
Unauthorized
Forbidden
Not Found
Internal Server Error