Microsoft Azure Form Recognizer Client

Name: Form Recognizer Client API
Brand: Azure Form Recognizer Client
Availability: InStock

★ Only Publicly Available OpenAPI DocumentAI/MLVisionapiKey10 EndpointsREST

Install Jentic One Beta

Connect the Form Recognizer Client to your agent

Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the Form Recognizer Client, or any other public or private API you need. You set the rules, the agent never sees your credentials, and every call is logged.

Two steps, two machines. Install the instance in a safe environment, then register your agent from wherever it runs.

Step 1: Jentic One Host machine

# On the machine that will host your Jentic One instance:
curl -fsSL https://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | sh

Step 2: Agent machine

# On the machine where your agent runs (keep this separate from the instance):
curl -fsSL https://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | sh
jentic register       # connects your agent to your Jentic One instance

Jentic One is in public beta. The setup above keeps your agent separate from the instance, which is what you want before using real credentials: an agent running as the same OS user as Jentic One can read its stored keys directly. Just evaluating? A single local install is fine to start. See the secure deployment guide for the tiers.

Capabilities

What an agent can do with Form Recognizer Client API.

Train a custom Form Recognizer model from labelled forms in a SAS-accessible blob folder

List and delete custom Form Recognizer models

Analyse a form with a custom model and poll for the structured key-value result

GET STARTED

Start building with Form Recognizer Client API

Explore with Jentic

View OpenAPI Document

For Agents

Train custom form models, analyse forms, layouts, and receipts asynchronously, and retrieve the structured extraction results.

Use for: Train a custom Form Recognizer model from blob folder https://.../forms/, Analyse the invoice at https://.../inv-123.pdf with custom model abc-123, Get the layout of contract.pdf including tables and selection marks, Extract merchant name and total from the receipt at https://.../receipt.jpg

Not supported: Does not transcribe speech, classify or describe arbitrary images, translate text, or run general-purpose OCR - use only to train and run Form Recognizer custom models, layout analysis, and the prebuilt receipt model.

Use Cases

Patterns agents use Form Recognizer Client API for, with concrete tasks.

★ Extract Structured Data from Custom Forms

Operations teams need to convert recurring vendor forms into structured data without writing per-template parsers. Train a custom model with POST /custom/models pointing at a folder of labelled examples, then call POST /custom/models/{modelId}/analyze on each new form. The service returns a result id; GET /custom/models/{modelId}/analyzeResults/{resultId} delivers the extracted key-value pairs once the run finishes.

Train a custom model from blob folder https://contoso.blob.core.windows.net/forms/, then analyse the form at https://contoso.blob.core.windows.net/inbox/inv-2025-01.pdf and return the extracted key-value pairs

Analyse Document Layout for Downstream Pipelines

Document automation pipelines first run layout analysis to capture text, tables, and selection marks before applying domain-specific extraction. POST /layout/analyze submits the document and returns a result id; GET /layout/analyzeResults/{resultId} returns the structured layout once analysis completes, ready to feed the next stage of the pipeline.

Submit contract.pdf to layout analyse, poll the result until succeeded, and return the table cells found on page 2

Receipt Extraction for Expense Workflows

Expense and accounts-payable workflows ingest scanned receipts and need merchant, date, total, tax, and line items. POST /prebuilt/receipt/analyze runs the prebuilt receipt model and returns a result id; GET /prebuilt/receipt/analyzeResults/{resultId} returns the structured fields once analysis completes, ready to be posted to an expense or accounting system.

Analyse the receipt at https://contoso.blob.core.windows.net/receipts/r-001.jpg with the prebuilt receipt model and return merchantName, total, and line items

Agent-Driven Document Pipelines

An AI agent processing inbound documents can train a custom model, route incoming files to the right analyser, and return structured fields to an accounting or CRM workflow through Jentic. Intent search returns the train, analyse, and result endpoints with their schemas; the Ocp-Apim-Subscription-Key is held in your Jentic One instance so the agent only ever holds a short-lived scoped token at call time.

Search Jentic for 'analyse a form with Form Recognizer', execute AnalyzeWithCustomModel for the new file, then call GetAnalyzeFormResult on the returned result id until status is succeeded

Key Endpoints

10 endpoints — jentic publishes the only available openapi specification for the azure cognitive services form recognizer client (v2.

METHOD

PATH

DESCRIPTION

POST

/custom/models

Train a custom Form Recognizer model

GET

/custom/models

List custom models

POST

/custom/models/{modelId}/analyze

Analyse a form with a custom model

GET

/custom/models/{modelId}/analyzeResults/{resultId}

Get analyse form result

POST

/layout/analyze

Analyse the layout of a document

GET

/layout/analyzeResults/{resultId}

Get analyse layout result

POST

/prebuilt/receipt/analyze

Analyse a receipt with the prebuilt model

GET

/prebuilt/receipt/analyzeResults/{resultId}

Get analyse receipt result

POST

/custom/models

Train a custom Form Recognizer model

GET

/custom/models

List custom models

POST

/custom/models/{modelId}/analyze

Analyse a form with a custom model

GET

/custom/models/{modelId}/analyzeResults/{resultId}

Get analyse form result

POST

/layout/analyze

Analyse the layout of a document

Why Jentic?

Three things that make agents converge on Jentic-routed access.

Credential isolation

Your Ocp-Apim-Subscription-Key is stored once, encrypted, by your own Jentic One instance and injected at execution time. The raw subscription key never enters the agent's prompt, logs, or context.

Intent-based discovery

Agents search Jentic by intent such as 'analyse a form with Form Recognizer' or 'extract receipt fields', and Jentic returns the matching custom-model, layout, or prebuilt-receipt operation with its input schema so the agent calls the right endpoint without learning the v2.0 path layout.

Time to first call

FAQs

Specific to using Form Recognizer Client API through Jentic.

Why is there no official OpenAPI spec for Form Recognizer Client?

Microsoft Azure does not publish an OpenAPI specification. Jentic generates and maintains this spec so that AI agents and developers can call Form Recognizer Client via structured tooling. It is validated against the live API and kept up to date. Get started with Jentic One, the self-hosted execution layer.

What authentication does the Form Recognizer API use?

The API uses an API key in the `Ocp-Apim-Subscription-Key` request header (the apim_key scheme). Through Jentic, that key is stored encrypted in your Jentic One instance and injected on each call so the agent never holds the raw subscription key.

Can I train a custom Form Recognizer model with this API?

Yes. Call POST /custom/models with a body that points at a SAS-accessible blob folder containing your labelled forms. The service returns a model id; once training completes, call POST /custom/models/{modelId}/analyze to extract data from new documents of the same template.

How do I get the result of an analyse call?

Analyse calls are asynchronous. The POST /custom/models/{modelId}/analyze, /layout/analyze, and /prebuilt/receipt/analyze endpoints return a result id (in the response headers). Poll the matching GET .../analyzeResults/{resultId} endpoint until the response status is 'succeeded' to retrieve the extracted fields.

What are the rate limits for the Form Recognizer API?

Form Recognizer applies per-resource quotas tied to the Cognitive Services pricing tier (free or standard). On HTTP 429 back off using the Retry-After header. Training jobs are heavier than analyse calls, so issue them serially per resource.

How do I run a Form Recognizer pipeline through Jentic?

Run pip install jentic, then search Jentic with 'analyse a form with Form Recognizer'. Load AnalyzeWithCustomModel, supply the modelId and document URL, and execute. Then call GetAnalyzeFormResult with the returned result id until status is succeeded. The Ocp-Apim-Subscription-Key is sourced from the vault on every call.

Can I limit what my agent is allowed to do with the Azure Form Recognizer API?

Yes. Because you run Jentic One yourself, your own rules decide which Form Recognizer operations the agent may call and which credentials it may use. Since the model id sits in the URL path for POST /custom/models/{modelId}/analyze and GET /custom/models/{modelId}/analyzeResults/{resultId}, you can pin the agent to a single custom model, and you can keep it to training, analysing, and reading results while leaving out a destructive operation like deleting a custom model. Only the operations you explicitly grant are available to the agent.

Microsoft Azure Form Recognizer Client

Connect the Form Recognizer Client to your agent

Capabilities

Start building with Form Recognizer Client API

Use Cases

Key Endpoints

Why Jentic?

Related APIs

FAQs