How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Azure AI Document Intelligence

Azure AI Document Intelligence DocumentModels API

The DocumentModels API from Azure AI Document Intelligence — 10 operation(s) for documentmodels.

Documentation Provider Profile APIs.io OpenAPI GitHub

Azure AI Document Intelligence DocumentModels API is one of 9 APIs that Azure AI Document Intelligence publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include DocumentModels. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 13 operations across 10 paths, and defines 57 schemas. It is described by OpenAPI 3.2.0, at version 2024-11-30.

Requests are made against a single base URL, https://.cognitiveservices.azure.com/.

13 operations 10 paths 57 schemas 3 DELETE7 GET3 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2024-11-30
Base URL
https://.cognitiveservices.azure.com
Authentication
API Key, OAuth 2.0
Resource Areas
1

Authentication & Security 2

Azure AI Document Intelligence DocumentModels API declares 2 security schemes for authenticating requests. An API key is passed in the header as Ocp-Apim-Subscription-Key (ApiKeyAuth). It supports OAuth 2.0 (OAuth2Auth) using the authorizationCode flow, exposing 1 scope. By default, every request must be authenticated.

Paths & Operations 13

Across 10 paths, the API surfaces 13 operations — 3 DELETE, 7 GET, 3 POST. Each is listed below with its method, path, parameters, and response codes.

DocumentModels 13
GET
/documentModels
List all document models
DocumentModels_ListModels 2 params → 200default
POST
/documentModels/{modelId}:analyze
Analyzes document with document model.
DocumentModels_AnalyzeDocumentFromStream 10 params → 202default
POST
/documentModels/{modelId}:analyzeBatch
Analyzes batch documents with document model.
DocumentModels_AnalyzeBatchDocuments 9 params body → 202default
GET
/documentModels/{modelId}
Gets detailed document model information.
DocumentModels_GetModel 3 params → 200default
DELETE
/documentModels/{modelId}
Deletes document model.
DocumentModels_DeleteModel 3 params → 204default
POST
/documentModels/{modelId}:copyTo
Copies document model to the target resource, region, and modelId.
DocumentModels_CopyModelTo 2 params body → 202default
GET
/documentModels/{modelId}/analyzeBatchResults
List batch document analysis results.
DocumentModels_ListAnalyzeBatchResults 2 params → 200default
GET
/documentModels/{modelId}/analyzeBatchResults/{resultId}
Gets the result of batch document analysis.
DocumentModels_GetAnalyzeBatchResult 3 params → 200default
DELETE
/documentModels/{modelId}/analyzeBatchResults/{resultId}
Mark the batch document analysis result for deletion.
DocumentModels_DeleteAnalyzeBatchResult 3 params → 204default
GET
/documentModels/{modelId}/analyzeResults/{resultId}
Gets the result of document analysis.
DocumentModels_GetAnalyzeResult 3 params → 200default
DELETE
/documentModels/{modelId}/analyzeResults/{resultId}
Mark the result of document analysis for deletion.
DocumentModels_DeleteAnalyzeResult 3 params → 204default
GET
/documentModels/{modelId}/analyzeResults/{resultId}/figures/{figureId}
Gets the generated cropped image of specified figure from document analysis.
DocumentModels_GetAnalyzeResultFigure 4 params → 200default
GET
/documentModels/{modelId}/analyzeResults/{resultId}/pdf
Gets the generated searchable PDF output from document analysis.
DocumentModels_GetAnalyzeResultPdf 3 params → 200default

Schemas 57

The contract defines 57 schemas that model the data the API accepts and returns. The most detailed are DocumentField (20 properties), DocumentModelDetails (15 properties), AnalyzeResult (15 properties), AddressValue (14 properties). Each schema is shown below with its type and property counts.

AnalyzeBatchResult
object
Batch document analysis result.
4 properties 3 required
DocumentSelectionMark
object
A selection mark object representing check boxes, radio buttons, and other elements indicating a selection.
4 properties 3 required
DocumentTableCell
object
An object representing the location and content of a table cell.
9 properties 4 required
DocumentFontStyle
string
Font style.
DocumentIntelligenceOperationStatus
string
Operation status.
AnalyzeBatchOperationDetail
object
Operation detail for a document in a batch analysis.
4 properties 2 required
DocumentField
object
An object representing the content and location of a field value.
20 properties 1 required
DocumentBarcodeKind
string
Barcode kind.
DocumentBuildMode
string
Custom document model build mode.
DocumentFootnote
object
A footnote object describing a table or figure.
4 properties 2 required
DocumentTable
object
A table object consisting table cells arranged in a rectangular layout.
7 properties 4 required
DocumentPage
object
Content and layout elements extracted from a page from the input.
11 properties 2 required
AnalyzeBatchDocumentsRequest
object
Batch document analysis parameters.
5 properties 1 required
DocumentWord
object
A word object consisting of a contiguous sequence of characters. For non-space delimited languages, such as Chinese, Japanese, and Korean, each character is re…
4 properties 3 required
AddressValue
object
Address field value.
14 properties
DocumentIntelligenceInnerError
object
An object containing more specific information about the error.
3 properties
DocumentFigure
object
An object representing a figure in the document.
6 properties 1 required
DocumentBarcode
object
A barcode object.
5 properties 4 required
DocumentSelectionMarkState
string
State of the selection mark.
DocumentAnalysisFeature
string
Document analysis features to enable.
PagedAnalyzeBatchOperation
object
Paged collection of AnalyzeBatchOperation items
2 properties 1 required
AzureBlobContentSource
object
Azure Blob Storage content.
2 properties 1 required
DocumentSection
object
An object representing a section in the document.
2 properties 1 required
DocumentFontWeight
string
Font weight.
DocumentLine
object
A content line object consisting of an adjacent sequence of content elements, such as words and selection marks.
3 properties 2 required
LengthUnit
string
The unit used by the width, height, and polygon properties. For images, the unit is "pixel". For PDF, the unit is "inch".
DocumentTypeDetails
object
Document type info.
9 properties
DocumentFieldSchema
object
Description of the field semantic schema using a JSON Schema style syntax.
5 properties 1 required
DocumentIntelligenceError
object
The error object.
5 properties 2 required
DocumentIntelligenceErrorResponse
object
Error response object.
1 property 1 required
DocumentKeyValuePair
object
An object representing a form field with distinct field label (key) and field value (may be empty).
3 properties 2 required
DocumentKeyValueElement
object
An object representing the field key or value in a key-value pair.
3 properties 2 required
BoundingRegion
object
Bounding polygon on a specific page of the input.
2 properties 2 required
DocumentStyle
object
An object representing observed text styles.
8 properties 2 required
AzureBlobFileListContentSource
object
File list in Azure Blob Storage.
2 properties 2 required
AnalyzedDocument
object
An object describing the location and semantic content of a document.
5 properties 3 required
PagedDocumentModelDetails
object
Paged collection of DocumentModelDetails items
2 properties 1 required
DocumentModelDetails
object
Document model info.
15 properties 2 required
DocumentParagraph
object
A paragraph object consisting with contiguous lines generally with common alignment and spacing.
4 properties 2 required
DocumentContentFormat
string
Format of the content in analyzed result.
DocumentCaption
object
A caption object describing a table or figure.
4 properties 2 required
DocumentFormulaKind
string
Formula kind.
DocumentFormula
object
A formula object.
5 properties 4 required
DocumentFieldType
string
Semantic data type of the field value.
StringIndexType
string
Method used to compute string offset and length.
DocumentLanguage
object
An object representing the detected language for a given text span.
3 properties 3 required
ModelCopyAuthorization
object
Authorization to copy a document model to the specified target resource and modelId.
6 properties 6 required
Azure.Core.uuid
string
Universally Unique Identifier
AnalyzeOperation
object
Status and result of the analyze operation.
5 properties 3 required
DocumentElement
string
An JSON pointer referencing an element of the document, such as paragraph, table, section, etc.
DocumentSignatureType
string
Presence of signature.
DocumentSpan
object
Contiguous region of the concatenated content property, specified as an offset and length.
2 properties 2 required
ParagraphRole
string
Semantic role of the paragraph.
AnalyzeResult
object
Document analysis result.
15 properties 5 required
DocumentIntelligenceWarning
object
The error object.
3 properties 2 required
AnalyzeBatchOperation
object
Status and result of the analyze batch operation.
7 properties 3 required
CurrencyValue
object
Currency field value.
3 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

azure-document-intelligence-documentmodels-api-openapi.yml Raw ↑

Other APIs Azure AI Document Intelligence publishes across the network.

Azure AI Document Intelligence DocumentClassifiers API
AE Profile APIs.io
Azure AI Document Intelligence DocumentClassifiers:authorizeCopy API
AE Profile APIs.io
Azure AI Document Intelligence DocumentClassifiers:build API
AE Profile APIs.io
Azure AI Document Intelligence DocumentModels:authorizeCopy API
AE Profile APIs.io
Azure AI Document Intelligence DocumentModels:build API
AE Profile APIs.io
Azure AI Document Intelligence DocumentModels:compose API
AE Profile APIs.io
Azure AI Document Intelligence Info API
AE Profile APIs.io
Azure AI Document Intelligence Operations API
AE Profile APIs.io
#DocumentModels
← Back to A APIs
API Details
ID
azure-document-intelligence:azure-document-intelligence-documentmodels-api
Base URL
https://.cognitiveservices.azure.com
Docs
https://learn.microsoft.com/en-us/azure/ai-services/document-intelligence/
Provider
Azure AI Document Intelligence
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=azure-document-intelligence-documentmodels-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/azure-document-intelligence-documentmodels-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of Azure AI Document Intelligence DocumentModels API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.