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

Microsoft Azure documentModels API

The documentModels API from Microsoft Azure — 5 operation(s) for documentmodels.

Microsoft Azure documentModels API is one of 1667 APIs that Microsoft Azure 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, an API reference, pricing, a JSON-LD context, and a getting-started guide.

This API exposes 6 operations across 5 paths, and defines 52 schemas. It is described by OpenAPI 3.2.0, at version 2020-08-01-preview.

6 operations 5 paths 52 schemas 1 DELETE3 GET2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2020-08-01-preview
Resource Areas
1

Paths & Operations 6

Across 5 paths, the API surfaces 6 operations — 1 DELETE, 3 GET, 2 POST. Each is listed below with its method, path, parameters, and response codes.

documentModels 6
GET
/documentModels
Microsoft Azure Get Documentmodels
microsoftAzureDocumentmodelsListmodels 2 params → 200default
POST
/documentModels/{modelId}:analyze
Microsoft Azure Post Documentmodels Modelid:analyze
microsoftAzureDocumentmodelsAnalyzedocumentfromstream 9 params → 202default
GET
/documentModels/{modelId}
Microsoft Azure Get Documentmodels Modelid
microsoftAzureDocumentmodelsGetmodel 3 params → 200default
DELETE
/documentModels/{modelId}
Microsoft Azure Delete Documentmodels Modelid
microsoftAzureDocumentmodelsDeletemodel 3 params → 204default
POST
/documentModels/{modelId}:copyTo
Microsoft Azure Post Documentmodels Modelid:copyto
microsoftAzureDocumentmodelsCopymodelto 2 params body → 202default
GET
/documentModels/{modelId}/analyzeResults/{resultId}
Microsoft Azure Get Documentmodels Modelid Analyzeresults Resultid
microsoftAzureDocumentmodelsGetanalyzeresult 3 params → 200default

Schemas 52

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

ParagraphRole
string
Semantic role of the paragraph.
DocumentBarcode
object
A barcode object.
5 properties 4 required
DocumentSelectionMark
object
A selection mark object representing check boxes, radio buttons, and other elements indicating a selection.
4 properties 3 required
FontWeight
string
Font weight.
DocumentFigure
object
An object representing a figure in the document.
5 properties 1 required
Error
object
The error object.
5 properties 2 required
DocumentSection
object
An object representing a section in the document.
2 properties 1 required
DocumentTypeDetails
object
Document type info.
4 properties 1 required
Document
object
An object describing the location and semantic content of a document.
5 properties 3 required
DocumentFieldSchema
object
Description of the field semantic schema using a JSON Schema style syntax.
5 properties 1 required
DocumentTableCell
object
An object representing the location and content of a table cell.
9 properties 4 required
DocumentSelectionMarkState
string
State of the selection mark.
AzureBlobContentSource
object
Azure Blob Storage content.
2 properties 1 required
CopyAuthorization
object
Authorization to copy a document model to the specified target resource and modelId.
6 properties 6 required
StringIndexType
string
Method used to compute string offset and length.
DocumentPage
object
Content and layout elements extracted from a page from the input.
11 properties 2 required
DocumentStyle
object
An object representing observed text styles.
8 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".
DocumentLine
object
A content line object consisting of an adjacent sequence of content elements, such as words and selection marks.
3 properties 2 required
ContentFormat
string
Format of the content in analyzed result.
DocumentKeyValuePair
object
An object representing a form field with distinct field label (key) and field value (may be empty).
3 properties 2 required
InnerError
object
An object containing more specific information about the error.
3 properties
DocumentFormula
object
A formula object.
5 properties 4 required
DocumentCaption
object
A caption object describing a table or figure.
4 properties 2 required
CurrencyValue
object
Currency field value.
3 properties 1 required
AzureBlobFileListContentSource
object
File list in Azure Blob Storage.
2 properties 2 required
FontStyle
string
Font style.
PagedDocumentModelDetails
object
Paged collection of DocumentModelDetails items
2 properties 1 required
DocumentLanguage
object
An object representing the detected language for a given text span.
3 properties 3 required
BoundingRegion
object
Bounding polygon on a specific page of the input.
2 properties 2 required
AddressValue
object
Address field value.
14 properties
Warning
object
The error object.
3 properties 2 required
DocumentSpan
object
Contiguous region of the concatenated content property, specified as an offset and length.
2 properties 2 required
DocumentElement
string
An JSON pointer referencing an element of the document, such as paragraph, table, section, etc.
AnalyzeResultOperation
object
Status and result of the analyze operation.
5 properties 3 required
DocumentSignatureType
string
Presence of signature.
DocumentField
object
An object representing the content and location of a field value.
20 properties 1 required
DocumentKeyValueElement
object
An object representing the field key or value in a key-value pair.
3 properties 2 required
DocumentBuildMode
string
Custom document model build mode.
OperationStatus
string
Operation status.
DocumentListItem
object
An object representing a list item in the document.
5 properties 3 required
AnalyzeResult
object
Document analysis result.
15 properties 5 required
DocumentBarcodeKind
string
Barcode kind.
ErrorResponse
object
Error response object.
1 property 1 required
DocumentFormulaKind
string
Formula kind.
DocumentModelDetails
object
Document model info.
11 properties 2 required
DocumentFootnote
object
A footnote object describing a table or figure.
4 properties 2 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
DocumentFieldType
string
Semantic data type of the field value.
DocumentTable
object
A table object consisting table cells arranged in a rectangular layout.
7 properties 4 required
DocumentParagraph
object
A paragraph object consisting with contiguous lines generally with common alignment and spacing.
4 properties 2 required
DocumentList
object
An object representing a list in the document.
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

microsoft-azure-documentmodels-api-openapi.yml Raw ↑

Other APIs Microsoft Azure publishes across the network.

Microsoft Azure AI Search API
Microsoft Azure Communication Services API
Microsoft Azure Event Grid API
Microsoft Azure Functions API
Microsoft Azure DevOps REST API
Microsoft Azure AI Foundry API
Microsoft Azure Resource JSON Schema
Microsoft Azure JSON-LD Context
Microsoft Azure AccessConnector API
Microsoft Azure AccessControlRecords API
Microsoft Azure AccessPolicies API
Microsoft Azure AccessReviewInstanceAcceptRecommmendations API
Where this information came from

This is an independent, third-party profile of Microsoft Azure 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.