Azure AI | Document Intelligence | REST API | Authentication

Question

Hi Team,

I am trying to use the Document Intelligence Services REST API for a custom mode. The API works great in the "Try in out" mode. However, I want to use it programmatically via API. I am unable to figure out the Authentication piece, what all needs to be passed via calling API from Postman . I implemented it successfully in C# SDK and passed 2 parameters there - endpoint and key.

But help is requested to identify the same in REST API.

EDIT: I tried below but it throws error:

Call Details:

Endpoint:

https://<Document intelligence URL>/documentintelligence/documentModels/<ID of Custom extraction model>:analyze?_overload=analyzeDocument&api-version=2023-10-31-preview&Ocp-Apim-Subscription-Key=<KEY associated to endpoint>&urlSource=<PATH to PDF from azure blob storage>

Error:

{
    "statusCode": 401,
    "message": "Unauthorized. Access token is missing, invalid, audience is incorrect (https://cognitiveservices.azure.com), or have expired."
}

Note: the combination of endpoint and the key works from C# SDK as well as the Document intelligence studio.

Avni Bhatt

Answer 1

Hi @Avni Bhatt ,

Thank you for using the Microsoft Q&A.

Regarding your error while using the REST API, Kindly issue the POST request followed by GET request in the postman to the document intelligence custom model. Once the POST request was done in the Postman / curl command(in cmd window), we get the "Operation Location", from where we can check the model analysis results. Kindly use this "Operation Location" URL in the GET request in postman. Please also provide the API key , content type etc in the GET request as well and click on "SEND" button in postman.

Note : The headers, body in the postman are important ones to configure while sending the POST request followed by the GET request. POST request is used to submit the forms inside your Blob container to the custom model (URL mentioned in POST request). Then the GET request is used to fetch the model results.

Also check on below in your postman or CURL command:

• Ensure the API key is correct.
• Confirm that the endpoint URL is accurate.
• API documentation - Document Models - Analyze Document - REST API (Azure Azure AI Services) | Microsoft Learn

Screenshots from Postman :

POST:

Inside the "Body" of POST request in postman, please give your BLOB container SAS URL, as shown below :

Take a note of the "Operation Location" from above step, after clicking on the "SEND" button.  

**GET
**

I hope this helps! Thanks!