# Form Recognizer Client API

> Form Recognizer Client API on Apizie: 19 endpoints (Create and train a custom model. The request must include a source parameter that is either an externally…, Get detailed information about a custom model., Mark model for deletion. Model artifacts will be permanently removed within a predetermined period., Extract key-value pairs, tables, and semantic values from a given document. The input document must be of…, …) returned as clean JSON through one API key. Send your own provider key in the x-upstream-key header. Call it over REST at https://www.apizie.tech/v1/cloud:azure-cognitiveservices-form-recognizer/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `cloud:azure-cognitiveservices-form-recognizer`
- Category: Cloud
- Status: byok
- Source: https://learn.microsoft.com/rest/api/azure/
- Page: https://www.apizie.tech/api/cloud/azure-cognitiveservices-form-recognizer
- OpenAPI: https://www.apizie.tech/api/cloud/azure-cognitiveservices-form-recognizer/openapi.json

Extracts information from forms and images into structured data.

## Endpoints

### Create and train a custom model. The request must include a source parameter that is either an externally…
`POST https://www.apizie.tech/v1/cloud:azure-cognitiveservices-form-recognizer/custom-models-train` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | Supported Cognitive Services endpoints (protocol and hostname, for example: https://westus2.api.cognitive.microsoft.com). |
| body | object | yes | JSON request body |

### Get detailed information about a custom model.
`GET https://www.apizie.tech/v1/cloud:azure-cognitiveservices-form-recognizer/custom-models-get` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | Supported Cognitive Services endpoints (protocol and hostname, for example: https://westus2.api.cognitive.microsoft.com). |
| modelId | string | yes | Model identifier. |
| includeKeys | boolean | no | Include list of extracted keys in model information. |

### Mark model for deletion. Model artifacts will be permanently removed within a predetermined period.
`POST https://www.apizie.tech/v1/cloud:azure-cognitiveservices-form-recognizer/custom-models-delete` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | Supported Cognitive Services endpoints (protocol and hostname, for example: https://westus2.api.cognitive.microsoft.com). |
| modelId | string | yes | Model identifier. |

### Extract key-value pairs, tables, and semantic values from a given document. The input document must be of…
`POST https://www.apizie.tech/v1/cloud:azure-cognitiveservices-form-recognizer/custom-models-analyze-document` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | Supported Cognitive Services endpoints (protocol and hostname, for example: https://westus2.api.cognitive.microsoft.com). |
| modelId | string | yes | Model identifier. |
| includeTextDetails | boolean | no | Include text lines and element references in the result. |
| pages | array | no | Custom page numbers for multi-page documents(PDF/TIFF), input the number of the pages you want to get OCR result. For a range of pages,… |
| body | object | no | JSON request body |

### Obtain current status and the result of the analyze form operation.
`GET https://www.apizie.tech/v1/cloud:azure-cognitiveservices-form-recognizer/custom-models-get-analyze-result` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | Supported Cognitive Services endpoints (protocol and hostname, for example: https://westus2.api.cognitive.microsoft.com). |
| modelId | string | yes | Model identifier. |
| resultId | string | yes | Analyze operation result identifier. |

### Copy custom model stored in this resource (the source) to user specified target Form Recognizer resource.
`POST https://www.apizie.tech/v1/cloud:azure-cognitiveservices-form-recognizer/custom-models-copy` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | Supported Cognitive Services endpoints (protocol and hostname, for example: https://westus2.api.cognitive.microsoft.com). |
| modelId | string | yes | Model identifier. |
| body | object | yes | JSON request body |

### Obtain current status and the result of a custom model copy operation.
`GET https://www.apizie.tech/v1/cloud:azure-cognitiveservices-form-recognizer/custom-models-get-copy-result` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | Supported Cognitive Services endpoints (protocol and hostname, for example: https://westus2.api.cognitive.microsoft.com). |
| modelId | string | yes | Model identifier. |
| resultId | string | yes | Copy operation result identifier. |

### Generate authorization to copy a model into the target Form Recognizer resource.
`POST https://www.apizie.tech/v1/cloud:azure-cognitiveservices-form-recognizer/custom-models-authorize-model-copy` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | Supported Cognitive Services endpoints (protocol and hostname, for example: https://westus2.api.cognitive.microsoft.com). |

### Compose request would include list of models ids. It would validate what all models either trained with…
`POST https://www.apizie.tech/v1/cloud:azure-cognitiveservices-form-recognizer/custom-models-compose` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | Supported Cognitive Services endpoints (protocol and hostname, for example: https://westus2.api.cognitive.microsoft.com). |
| body | object | yes | JSON request body |

### Extract field text and semantic values from a given business card document. The input document must be of…
`POST https://www.apizie.tech/v1/cloud:azure-cognitiveservices-form-recognizer/analyzer-analyze-business-card` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | Supported Cognitive Services endpoints (protocol and hostname, for example: https://westus2.api.cognitive.microsoft.com). |
| includeTextDetails | boolean | no | Include text lines and element references in the result. |
| locale | string | no | Locale of the input document. Supported locales include: en-AU, en-CA, en-GB, en-IN, en-US(default). |
| pages | array | no | Custom page numbers for multi-page documents(PDF/TIFF), input the number of the pages you want to get OCR result. For a range of pages,… |
| body | object | no | JSON request body |

### Track the progress and obtain the result of the analyze business card operation.
`GET https://www.apizie.tech/v1/cloud:azure-cognitiveservices-form-recognizer/analyzer-get-analyze-business-card-result` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | Supported Cognitive Services endpoints (protocol and hostname, for example: https://westus2.api.cognitive.microsoft.com). |
| resultId | string | yes | Analyze operation result identifier. |

### Extract field text and semantic values from a given invoice document. The input document must be of one of…
`POST https://www.apizie.tech/v1/cloud:azure-cognitiveservices-form-recognizer/analyzer-analyze-invoice` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | Supported Cognitive Services endpoints (protocol and hostname, for example: https://westus2.api.cognitive.microsoft.com). |
| includeTextDetails | boolean | no | Include text lines and element references in the result. |
| locale | string | no | Locale of the input document. Supported locales include: en-AU, en-CA, en-GB, en-IN, en-US(default). |
| pages | array | no | Custom page numbers for multi-page documents(PDF/TIFF), input the number of the pages you want to get OCR result. For a range of pages,… |
| body | object | no | JSON request body |

### Track the progress and obtain the result of the analyze invoice operation.
`GET https://www.apizie.tech/v1/cloud:azure-cognitiveservices-form-recognizer/analyzer-get-analyze-invoice-result` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | Supported Cognitive Services endpoints (protocol and hostname, for example: https://westus2.api.cognitive.microsoft.com). |
| resultId | string | yes | Analyze operation result identifier. |

### Extract field text and semantic values from a given ID document. The input document must be of one of the…
`POST https://www.apizie.tech/v1/cloud:azure-cognitiveservices-form-recognizer/analyzer-analyze-id-document` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | Supported Cognitive Services endpoints (protocol and hostname, for example: https://westus2.api.cognitive.microsoft.com). |
| includeTextDetails | boolean | no | Include text lines and element references in the result. |
| pages | array | no | Custom page numbers for multi-page documents(PDF/TIFF), input the number of the pages you want to get OCR result. For a range of pages,… |
| body | object | no | JSON request body |

### Track the progress and obtain the result of the analyze ID operation.
`GET https://www.apizie.tech/v1/cloud:azure-cognitiveservices-form-recognizer/analyzer-get-analyze-id-document-result` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | Supported Cognitive Services endpoints (protocol and hostname, for example: https://westus2.api.cognitive.microsoft.com). |
| resultId | string | yes | Analyze operation result identifier. |

### Extract field text and semantic values from a given receipt document. The input document must be of one of…
`POST https://www.apizie.tech/v1/cloud:azure-cognitiveservices-form-recognizer/analyzer-analyze-receipt` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | Supported Cognitive Services endpoints (protocol and hostname, for example: https://westus2.api.cognitive.microsoft.com). |
| includeTextDetails | boolean | no | Include text lines and element references in the result. |
| locale | string | no | Locale of the input document. Supported locales include: en-AU, en-CA, en-GB, en-IN, en-US(default). |
| pages | array | no | Custom page numbers for multi-page documents(PDF/TIFF), input the number of the pages you want to get OCR result. For a range of pages,… |
| body | object | no | JSON request body |

### Track the progress and obtain the result of the analyze receipt operation.
`GET https://www.apizie.tech/v1/cloud:azure-cognitiveservices-form-recognizer/analyzer-get-analyze-receipt-result` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | Supported Cognitive Services endpoints (protocol and hostname, for example: https://westus2.api.cognitive.microsoft.com). |
| resultId | string | yes | Analyze operation result identifier. |

### Extract text and layout information from a given document. The input document must be of one of the…
`POST https://www.apizie.tech/v1/cloud:azure-cognitiveservices-form-recognizer/analyzer-analyze-layout` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | Supported Cognitive Services endpoints (protocol and hostname, for example: https://westus2.api.cognitive.microsoft.com). |
| pages | array | no | Custom page numbers for multi-page documents(PDF/TIFF), input the number of the pages you want to get OCR result. For a range of pages,… |
| language | string | no | Currently, only Afrikaans (‘af’), Albanian (‘sq’), Asturian (‘ast’), Basque (‘eu’), Bislama (‘bi’), Breton (‘br’), Catalan (‘ca’), Cebuano… |
| readingOrder | string | no | Reading order algorithm to sort the text lines returned. Supported reading orders include: basic(default), natural. |
| body | object | no | JSON request body |

### Track the progress and obtain the result of the analyze layout operation
`GET https://www.apizie.tech/v1/cloud:azure-cognitiveservices-form-recognizer/analyzer-get-analyze-layout-result` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | Supported Cognitive Services endpoints (protocol and hostname, for example: https://westus2.api.cognitive.microsoft.com). |
| resultId | string | yes | Analyze operation result identifier. |

## Example
```
curl "https://www.apizie.tech/v1/cloud:azure-cognitiveservices-form-recognizer/custom-models-train" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the Form Recognizer Client API?
Create a free Apizie key, then send POST https://www.apizie.tech/v1/cloud:azure-cognitiveservices-form-recognizer/custom-models-train with the header x-api-key. Every endpoint returns { project, data, timestamp }.

### Is the Form Recognizer Client API free on Apizie?
Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card. Form Recognizer Client itself also needs your own key from azure.com.

### Can AI agents use the Form Recognizer Client API?
Yes. Add the Apizie MCP server (https://www.apizie.tech/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key cloud:azure-cognitiveservices-form-recognizer.

### What is the status of the Form Recognizer Client API?
Needs your own provider key (bring your own key)