Form Recognizer API (v2.0)

On 31 August 2026 Azure AI Document Intelligence (formerly known as Azure Form Recognizer) v2.0 API will be retired. Please transition to Azure AI Document Intelligence v3.1 API by that date following the detailed steps.

Form Recognizer extracts information from forms and images into structured data. It includes the following options: * Form - Extracts information from forms (PDFs and images) into structured data based on a model created from a set of representative training forms. Form Recognizer learns the structure of your forms to intelligently extract text and data. It ingests text from forms, applies machine learning technology to identify keys, tables, and fields, and then outputs structured data that includes the relationships within the original file. * Receipt - Detects and extracts data from receipts using optical character recognition (OCR) and our receipt model, enabling you to easily extract structured data from receipts such as merchant name, merchant phone number, transaction date, transaction total, and more. * Layout - Extracts text and table structure from documents using optical character recognition (OCR).

Custom Form Model Management - Get Custom Model

Get detailed information about a custom model.

Select the testing console in the region where you created your resource:

Australia East Brazil South Canada Central Central India Central US Central US EUAP East Asia East US East US 2 France Central Germany West Central Italy North Japan East Japan West Korea Central North Central US North Europe South Africa North South Central US Southeast Asia Switzerland North Switzerland West UAE North UK South West Central US West Europe West US West US 2 West US 3 Norway East Jio India West

Request URL

Request parameters

string

Format - uuid. Model identifier.

(optional)
boolean

Include list of extracted keys in model information.

Request headers

string
Subscription key which provides access to this API. Found in your Cognitive Services accounts.

Request body

Response 200

Success

{
  "modelInfo": {
    "modelId": "string",
    "status": "creating",
    "createdDateTime": "string",
    "lastUpdatedDateTime": "string"
  },
  "keys": {
    "clusters": {}
  },
  "trainResult": {
    "trainingDocuments": [
      {
        "documentName": "string",
        "pages": 0,
        "errors": [
          "string"
        ],
        "status": "succeeded"
      }
    ],
    "fields": [
      {
        "fieldName": "string",
        "accuracy": 0.0
      }
    ],
    "averageModelAccuracy": 0.0,
    "errors": [
      {
        "message": "string"
      }
    ]
  }
}
{
  "description": "Response to the get custom model operation.",
  "type": "object",
  "required": [
    "modelInfo"
  ],
  "properties": {
    "modelInfo": {
      "description": "Basic custom model information.",
      "type": "object",
      "required": [
        "modelId",
        "status",
        "createdDateTime",
        "lastUpdatedDateTime"
      ],
      "properties": {
        "modelId": {
          "description": "Model identifier.",
          "type": "string",
          "format": "uuid",
          "x-nullable": false
        },
        "status": {
          "description": "Status of the model.",
          "enum": [
            "creating",
            "ready",
            "invalid"
          ],
          "type": "string",
          "x-ms-enum": {
            "name": "ModelStatus",
            "modelAsString": false
          },
          "x-nullable": false
        },
        "createdDateTime": {
          "format": "date-time",
          "description": "Date and time (UTC) when the model was created.",
          "type": "string",
          "x-nullable": false
        },
        "lastUpdatedDateTime": {
          "format": "date-time",
          "description": "Date and time (UTC) when the status is last updated.",
          "type": "string",
          "x-nullable": false
        }
      }
    },
    "keys": {
      "description": "Keys extracted by the custom model.",
      "type": "object",
      "required": [
        "clusters"
      ],
      "properties": {
        "clusters": {
          "description": "Object mapping clusterIds to a list of keys.",
          "type": "object",
          "additionalProperties": {
            "type": "array",
            "uniqueItems": true,
            "items": {
              "type": "string"
            }
          }
        }
      }
    },
    "trainResult": {
      "description": "Custom model training result.",
      "type": "object",
      "required": [
        "trainingDocuments"
      ],
      "properties": {
        "trainingDocuments": {
          "description": "List of the documents used to train the model and any errors reported in each document.",
          "type": "array",
          "items": {
            "description": "Report for a custom model training document.",
            "type": "object",
            "required": [
              "documentName",
              "pages",
              "errors",
              "status"
            ],
            "properties": {
              "documentName": {
                "description": "Training document name.",
                "type": "string"
              },
              "pages": {
                "format": "int32",
                "description": "Total number of pages trained.",
                "type": "integer",
                "x-nullable": false
              },
              "errors": {
                "description": "List of errors.",
                "type": "array",
                "items": {
                  "type": "string"
                }
              },
              "status": {
                "description": "Status of the training operation.",
                "enum": [
                  "succeeded",
                  "partiallySucceeded",
                  "failed"
                ],
                "type": "string",
                "x-ms-enum": {
                  "name": "TrainStatus",
                  "modelAsString": false
                },
                "x-nullable": false
              }
            }
          }
        },
        "fields": {
          "description": "List of fields used to train the model and the train operation error reported by each.",
          "type": "array",
          "items": {
            "description": "Report for a custom model training field.",
            "type": "object",
            "required": [
              "fieldName",
              "accuracy"
            ],
            "properties": {
              "fieldName": {
                "description": "Training field name.",
                "type": "string"
              },
              "accuracy": {
                "description": "Estimated extraction accuracy for this field.",
                "type": "number",
                "x-nullable": false
              }
            }
          }
        },
        "averageModelAccuracy": {
          "description": "Average accuracy.",
          "type": "number",
          "x-nullable": false
        },
        "errors": {
          "description": "Errors returned during the training operation.",
          "type": "array",
          "items": {
            "description": "Error reported during an operation.",
            "type": "object",
            "required": [
              "message"
            ],
            "properties": {
              "message": {
                "description": "Error message.",
                "type": "string"
              }
            }
          }
        }
      }
    }
  }
}

Response 500

Response entity accompanying non-successful responses containing additional details about the error.

Code samples

@ECHO OFF

curl -v -X GET "https://eastasia.api.cognitive.microsoft.com/formrecognizer/v2.0/custom/models/{modelId}?includeKeys=False"
-H "Ocp-Apim-Subscription-Key: {subscription key}"

--data-ascii "{body}" 

using System;
using System.Net.Http.Headers;
using System.Text;
using System.Net.Http;
using System.Web;

namespace CSHttpClientSample
{
    static class Program
    {
        static void Main()
        {
            MakeRequest();
            Console.WriteLine("Hit ENTER to exit...");
            Console.ReadLine();
        }
        
        static async void MakeRequest()
        {
            var client = new HttpClient();
            var queryString = HttpUtility.ParseQueryString(string.Empty);

            // Request headers
            client.DefaultRequestHeaders.Add("Ocp-Apim-Subscription-Key", "{subscription key}");

            // Request parameters
            queryString["includeKeys"] = "False";
            var uri = "https://eastasia.api.cognitive.microsoft.com/formrecognizer/v2.0/custom/models/{modelId}?" + queryString;

            var response = await client.GetAsync(uri);
        }
    }
}	
// // This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
import java.net.URI;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.client.utils.URIBuilder;
import org.apache.http.impl.client.HttpClients;
import org.apache.http.util.EntityUtils;

public class JavaSample 
{
    public static void main(String[] args) 
    {
        HttpClient httpclient = HttpClients.createDefault();

        try
        {
            URIBuilder builder = new URIBuilder("https://eastasia.api.cognitive.microsoft.com/formrecognizer/v2.0/custom/models/{modelId}");

            builder.setParameter("includeKeys", "False");

            URI uri = builder.build();
            HttpGet request = new HttpGet(uri);
            request.setHeader("Ocp-Apim-Subscription-Key", "{subscription key}");


            // Request body
            StringEntity reqEntity = new StringEntity("{body}");
            request.setEntity(reqEntity);

            HttpResponse response = httpclient.execute(request);
            HttpEntity entity = response.getEntity();

            if (entity != null) 
            {
                System.out.println(EntityUtils.toString(entity));
            }
        }
        catch (Exception e)
        {
            System.out.println(e.getMessage());
        }
    }
}


<!DOCTYPE html>
<html>
<head>
    <title>JSSample</title>
    <script src="http://ajax.googleapis.com/ajax/libs/jquery/1.9.0/jquery.min.js"></script>
</head>
<body>

<script type="text/javascript">
    $(function() {
        var params = {
            // Request parameters
            "includeKeys": "False",
        };
      
        $.ajax({
            url: "https://eastasia.api.cognitive.microsoft.com/formrecognizer/v2.0/custom/models/{modelId}?" + $.param(params),
            beforeSend: function(xhrObj){
                // Request headers
                xhrObj.setRequestHeader("Ocp-Apim-Subscription-Key","{subscription key}");
            },
            type: "GET",
            // Request body
            data: "{body}",
        })
        .done(function(data) {
            alert("success");
        })
        .fail(function() {
            alert("error");
        });
    });
</script>
</body>
</html>

#import <Foundation/Foundation.h>

int main(int argc, const char * argv[])
{
    NSAutoreleasePool * pool = [[NSAutoreleasePool alloc] init];
    
    NSString* path = @"https://eastasia.api.cognitive.microsoft.com/formrecognizer/v2.0/custom/models/{modelId}";
    NSArray* array = @[
                         // Request parameters
                         @"entities=true",
                         @"includeKeys=False",
                      ];
    
    NSString* string = [array componentsJoinedByString:@"&"];
    path = [path stringByAppendingFormat:@"?%@", string];

    NSLog(@"%@", path);

    NSMutableURLRequest* _request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:path]];
    [_request setHTTPMethod:@"GET"];
    // Request headers
    [_request setValue:@"{subscription key}" forHTTPHeaderField:@"Ocp-Apim-Subscription-Key"];
    // Request body
    [_request setHTTPBody:[@"{body}" dataUsingEncoding:NSUTF8StringEncoding]];
    
    NSURLResponse *response = nil;
    NSError *error = nil;
    NSData* _connectionData = [NSURLConnection sendSynchronousRequest:_request returningResponse:&response error:&error];

    if (nil != error)
    {
        NSLog(@"Error: %@", error);
    }
    else
    {
        NSError* error = nil;
        NSMutableDictionary* json = nil;
        NSString* dataString = [[NSString alloc] initWithData:_connectionData encoding:NSUTF8StringEncoding];
        NSLog(@"%@", dataString);
        
        if (nil != _connectionData)
        {
            json = [NSJSONSerialization JSONObjectWithData:_connectionData options:NSJSONReadingMutableContainers error:&error];
        }
        
        if (error || !json)
        {
            NSLog(@"Could not parse loaded json with error:%@", error);
        }
        
        NSLog(@"%@", json);
        _connectionData = nil;
    }
    
    [pool drain];

    return 0;
}

<?php
// This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
require_once 'HTTP/Request2.php';

$request = new Http_Request2('https://eastasia.api.cognitive.microsoft.com/formrecognizer/v2.0/custom/models/{modelId}');
$url = $request->getUrl();

$headers = array(
    // Request headers
    'Ocp-Apim-Subscription-Key' => '{subscription key}',
);

$request->setHeader($headers);

$parameters = array(
    // Request parameters
    'includeKeys' => 'False',
);

$url->setQueryVariables($parameters);

$request->setMethod(HTTP_Request2::METHOD_GET);

// Request body
$request->setBody("{body}");

try
{
    $response = $request->send();
    echo $response->getBody();
}
catch (HttpException $ex)
{
    echo $ex;
}

?>
########### Python 2.7 #############
import httplib, urllib, base64

headers = {
    # Request headers
    'Ocp-Apim-Subscription-Key': '{subscription key}',
}

params = urllib.urlencode({
    # Request parameters
    'includeKeys': 'False',
})

try:
    conn = httplib.HTTPSConnection('eastasia.api.cognitive.microsoft.com')
    conn.request("GET", "/formrecognizer/v2.0/custom/models/{modelId}?%s" % params, "{body}", headers)
    response = conn.getresponse()
    data = response.read()
    print(data)
    conn.close()
except Exception as e:
    print("[Errno {0}] {1}".format(e.errno, e.strerror))

####################################

########### Python 3.2 #############
import http.client, urllib.request, urllib.parse, urllib.error, base64

headers = {
    # Request headers
    'Ocp-Apim-Subscription-Key': '{subscription key}',
}

params = urllib.parse.urlencode({
    # Request parameters
    'includeKeys': 'False',
})

try:
    conn = http.client.HTTPSConnection('eastasia.api.cognitive.microsoft.com')
    conn.request("GET", "/formrecognizer/v2.0/custom/models/{modelId}?%s" % params, "{body}", headers)
    response = conn.getresponse()
    data = response.read()
    print(data)
    conn.close()
except Exception as e:
    print("[Errno {0}] {1}".format(e.errno, e.strerror))

####################################
require 'net/http'

uri = URI('https://eastasia.api.cognitive.microsoft.com/formrecognizer/v2.0/custom/models/{modelId}')
uri.query = URI.encode_www_form({
    # Request parameters
    'includeKeys' => 'False'
})

request = Net::HTTP::Get.new(uri.request_uri)
# Request headers
request['Ocp-Apim-Subscription-Key'] = '{subscription key}'
# Request body
request.body = "{body}"

response = Net::HTTP.start(uri.host, uri.port, :use_ssl => uri.scheme == 'https') do |http|
    http.request(request)
end

puts response.body