Configure Document Automation with Azure AI Document Intelligence
- Updated: 2025/06/15
Send an API request to connect Document Automation with the extraction service.
Note: You will need the following information:
- Authorization token. See Authentication API in Control Room APIs.
- Azure AI Document Intelligence endpoint. See Use Document Intelligence models.
- Azure AI Document Intelligence API key. See Use Document Intelligence models.
- Microsoft Azure Blob storage URI. See Blob Snapshots.Note: For customers using bring your own license (BYOL), ensure that you provide read, create, write, delete, and list permissions to the Blob storage URI to allow the training of models.
When working with API URL trusted list for Standard Forms:
- Add only Azure AI Document Intelligence services API URL to the trusted list at Bot Runner end.
- Add the following URLs to the trusted list at the Control Room end:
- SAS (blob) URL
- Azure AI Document Intelligence services API URL
- https://fotts.azureedge.net/ (Required for specific document type rendering)
Note:
- To obtain a Microsoft Azure API Key, raise a support case with the account name or tenant name, validity period (usually till expiry of license), and region (refer to Azure Products by Region) for standard forms in description through Apeople page. For any issue, reach out to CSM or AE.
- You will not be able to see the Create Model option on the learning instances page to create models when you use your own license.
For Document Automation Cloud
Request
PUT <Cloud Host Url>/cognitive/v3/formrecognizer/config
Headers: X-Authorization - <IQBot Admin User Auth token >
Request body:
{
"formRecognizerApi": "https://<Form Recognizer Endpoint (for example: https://test.api.cognitive.microsoft.com/)>",
"formRecognizerKey": "<Form Recognizer API key1 or key2 (for example: 7d3614e94...)>",
"blobStorageSas": "https://<storage account sas_url (for example: https://aa.blob.core.windows.net/.....)>"
}
For Document Automation On-Premises
Request
PUT <On-Premises Machine ip_address or localhost:port>/cognitive/v3/formrecognizer/config
Headers: X-Authorization - <IQBot Admin User Auth token >
Request
body:
{
"formRecognizerApi": "https://<Form Recognizer Endpoint (for example: https://test.api.cognitive.microsoft.com/)>",
"formRecognizerKey": "<Form Recognizer API key1 or key2 (for example: 7d3614e94...)>",
"blobStorageSas": "https://<storage account sas_url (for example: https://aa.blob.core.windows.net/.....)>"
}
Next steps
Log in as the Learning instance creator
user to Create a custom extraction model using Standard Forms.