These APIs extract structured text and images from common document and image file types like PDF, Word, Excel, PNG, JPEG, etc. This turns unstructured files into machine-readable data for automation workflows.
Document Understanding API
Method : POST
{{base_url}}/docUnderstand
Authentication:
Required Params:
| Parameter Name | Value | Description |
| client_id | your_client_id | API authentication id. |
Required Headers:
| Header Name | Value | Description |
| client-secret | your_client_secret | API authentication secret. |
| Content-Type | application/json | Data sent in json format. |
Input Formats:
JSON Body (Base64 Data and format)
- For Markdown (Default Format)
{
“file_data”: “{%base64data%}”
}
- For Markdown (Explicit Format)
{
“file_data”: “{%base64data%}”,
“format”:“markdown”
}
- For JSON Output
{
“file_data”: “{%base64data%}”,
“format”:“json”
}
File support by docUnderstanding API:
- PowerPoint
- Word
- Excel
- Audio
- HTML
- Text-based formats (CSV, JSON, XML)
- ZIP files
- EPubs
Image Understanding API
Method: POST
{{base_url}}/imgUnderstand
Authentication:
Required Params:
| Parameter Name | Value | Description |
| client_id | your_client_id | API authentication id. |
Required Headers:
| Header Name | Value | Description |
| client-secret | your_client_secret | API authentication secret. |
| Content-Type | application/json | Data sent in json format. |
JSON Body (Base64 Data and format)
- For Markdown (Default Format)
{
“file_data”: “{%base64data%}”
}
File support by ImgUnderstanding API:
- JPEG
- JPG
- SVG
Authentication Instructions:
To acquire the Base URL and create your own Client ID and Secret, please refer to the My Profile section within your Bizdata account.
