Create a Scan Prompt Template
Endpoint
This API endpoint allows you to create new Scan Prompt Template for specific document types that we don't have at the moment in Verifik database. The Scan Prompt Templates help in structuring the extraction of key data fields from documents, enabling you to capture the required information accurately. When creating a new Scan Prompt Template, it's important to emphasize the prompt parameter, which plays a crucial role in instructing the system on how to extract data from the provided document type.
By creating custom templates with detailed prompts, you can ensure that the API accurately extracts the required data from any document you pass to us, even when dealing with multilingual, distorted, or culturally specific text.
Headers
Content-Type
application/json
Authorization
Bearer <token>
Prompt
Take a look at this prompt example:
Basically the prompt is a series of instructions and considerations about the document you desire to extract, you must define the most important aspects in the body of the prompt.
It's important that inside the prompt you add {{fields}} and {{format}}, this is to tell the AI what data extract and in which format return.
Body
documentType
string
Image in Base64 encoded format or a URL where the image is hosted.
fields
string
name
string
format
string
prompt
string
description
string
Body Example
Response
Last updated