Each type parameter in the data array will always have the specified type, with the possibility of being null.
If a specific type parameter is not present in the input, its value in the response will be null.
Request
Authorization
Add parameter in header
X-API-KEY
Example:
X-API-KEY: ********************
Path Params
model-id
string
required
To utilize the Axtraction AI API effectively, you must specify a model ID in your requests. The model ID follows the format model- followed by a 12-characters numbers and alphabet. This ID identifies the specific AI model you want to use for document processing.If you do not have a model yet, you can create one by visiting the Axtraction AI web app. There, you can set up your model according to your requirements and obtain the corresponding model ID for your API requests.
Example:
model-a1b2c3d4e5f6
Body Params multipart/form-data
file
file
optional
If fileBase64 is not provided, then file is required. Format: PDF, JPEG, PNG.
fileBase64
string
optional
If file is not provided, then fileBase64 is required. If both file and fileBase64 are provided, only file will be used.
Example:
JVBERi0xLjMNCiXi48/....
mimeType
string
optional
Required only when fileBase64 is provided. Supported: application/pdf, image/jpeg, image/jpg, image/png.
{"success":true,"data":[{"type":"electricity_bill_date","value":"2024-08-15"},{"type":"electricity_bill_total_amount","value":"RM120.45"},{"type":"electricity_bill_user_name","value":"Jane Smith"},{"type":"electricity_bill_user_address","value":"123, Kuala Lumpur"},{"type":"electricity_bill_account_number","value":"A123456789"},{"type":"electricity_bill_contract_number","value":"C987654321"},{"type":"electricity_bill_invoice_number","value":"INV123456"}],"miscellaneous":{"processedTime":108.996}}