Azure AI Document Intelligence

Azure AI Document Intelligence (formerly Form Recognizer) is Microsoft's cloud document understanding service. It exposes prebuilt models for invoices, receipts, IDs, business cards, tax forms and contracts, plus a layout/OCR Read model and a Custom-model framework for fine-tuned extraction. The 2024- 11-30 GA REST API is the current stable surface; preview APIs add Custom Generative Extraction.
1 APIs 0 Features
AIDocument AIAzureIDPOCRMicrosoftREST
APIs

Azure AI Document Intelligence REST API

REST API for document Read (OCR), Layout, prebuilt models (Invoice, Receipt, ID, Business Card, W2, Contract, Health Insurance Card etc.), Custom Classifiers and Custom Extracto...
Collections

Document Intelligence (formerly Form Recognizer)

OPEN
Pricing Plans

Azure Document Intelligence Plans Pricing

5 plans
PLANS
Rate Limits

Azure Document Intelligence Rate Limits

4 limits
RATE LIMITS
FinOps

Azure Document Intelligence Finops

FINOPS
Resources

Sources

opencollection: 1.0.0
info:
  name: Document Intelligence (formerly Form Recognizer)
  version: '2024-11-30'
items:
- info:
    name: DocumentClassifiers_ListClassifiers
    type: http
  http:
    method: GET
    url: '{{baseUrl}}/documentClassifiers'
    headers:
    - name: x-ms-client-request-id
      value: ''
    params:
    - name: api-version
      value: ''
      type: query
      description: The API version to use for this operation.
  docs: List all document classifiers.
- info:
    name: DocumentClassifiers_GetClassifier
    type: http
  http:
    method: GET
    url: '{{baseUrl}}/documentClassifiers/:classifierId'
    headers:
    - name: x-ms-client-request-id
      value: ''
    params:
    - name: api-version
      value: ''
      type: query
      description: The API version to use for this operation.
    - name: classifierId
      value: ''
      type: path
      description: Unique document classifier name.
  docs: Gets detailed document classifier information.
- info:
    name: DocumentClassifiers_DeleteClassifier
    type: http
  http:
    method: DELETE
    url: '{{baseUrl}}/documentClassifiers/:classifierId'
    headers:
    - name: x-ms-client-request-id
      value: ''
    params:
    - name: api-version
      value: ''
      type: query
      description: The API version to use for this operation.
    - name: classifierId
      value: ''
      type: path
      description: Unique document classifier name.
  docs: Deletes document classifier.
- info:
    name: DocumentClassifiers_ClassifyDocumentFromStream
    type: http
  http:
    method: POST
    url: '{{baseUrl}}/documentClassifiers/:classifierId:analyze'
    params:
    - name: api-version
      value: ''
      type: query
      description: The API version to use for this operation.
    - name: classifierId
      value: ''
      type: path
      description: Unique document classifier name.
    - name: stringIndexType
      value: ''
      type: query
      description: Method used to compute string offset and length.
    - name: split
      value: ''
      type: query
      description: Document splitting mode.
    - name: pages
      value: ''
      type: query
      description: 1-based page numbers to analyze.  Ex. "1-3,5,7-9"
  docs: Classifies document with document classifier.
- info:
    name: DocumentClassifiers_CopyClassifierTo
    type: http
  http:
    method: POST
    url: '{{baseUrl}}/documentClassifiers/:classifierId:copyTo'
    params:
    - name: api-version
      value: ''
      type: query
      description: The API version to use for this operation.
    - name: classifierId
      value: ''
      type: path
      description: Unique document classifier name.
  docs: Copies document classifier to the target resource, region, and classifierId.
- info:
    name: DocumentClassifiers_GetClassifyResult
    type: http
  http:
    method: GET
    url: '{{baseUrl}}/documentClassifiers/:classifierId/analyzeResults/:resultId'
    params:
    - name: api-version
      value: ''
      type: query
      description: The API version to use for this operation.
    - name: classifierId
      value: ''
      type: path
      description: Unique document classifier name.
    - name: resultId
      value: ''
      type: path
      description: Analyze operation result ID.
  docs: Gets the result of document classifier.
- info:
    name: DocumentClassifiers_AuthorizeClassifierCopy
    type: http
  http:
    method: POST
    url: '{{baseUrl}}/documentClassifiers:authorizeCopy'
    params:
    - name: api-version
      value: ''
      type: query
      description: The API version to use for this operation.
  docs: 'Generates authorization to copy a document classifier to this location with

    specified classifierId and optional description.'
- info:
    name: DocumentClassifiers_BuildClassifier
    type: http
  http:
    method: POST
    url: '{{baseUrl}}/documentClassifiers:build'
    params:
    - name: api-version
      value: ''
      type: query
      description: The API version to use for this operation.
  docs: Builds a custom document classifier.
- info:
    name: DocumentModels_ListModels
    type: http
  http:
    method: GET
    url: '{{baseUrl}}/documentModels'
    headers:
    - name: x-ms-client-request-id
      value: ''
    params:
    - name: api-version
      value: ''
      type: query
      description: The API version to use for this operation.
  docs: List all document models
- info:
    name: DocumentModels_AnalyzeDocumentFromStream
    type: http
  http:
    method: POST
    url: '{{baseUrl}}/documentModels/:modelId:analyze'
    params:
    - name: api-version
      value: ''
      type: query
      description: The API version to use for this operation.
    - name: modelId
      value: ''
      type: path
      description: Unique document model name.
    - name: pages
      value: ''
      type: query
      description: 1-based page numbers to analyze.  Ex. "1-3,5,7-9"
    - name: locale
      value: ''
      type: query
      description: 'Locale hint for text recognition and document analysis.  Value may contain only

        the language code (ex. "en", "fr") or BCP 47 language tag (ex. "en-US").'
    - name: stringIndexType
      value: ''
      type: query
      description: Method used to compute string offset and length.
    - name: features
      value: ''
      type: query
      description: List of optional analysis features.
    - name: queryFields
      value: ''
      type: query
      description: List of additional fields to extract.  Ex. "NumberOfGuests,StoreNumber"
    - name: outputContentFormat
      value: ''
      type: query
      description: Format of the analyze result top-level content.
    - name: output
      value: ''
      type: query
      description: Additional outputs to generate during analysis.
  docs: Analyzes document with document model.
- info:
    name: DocumentModels_AnalyzeBatchDocuments
    type: http
  http:
    method: POST
    url: '{{baseUrl}}/documentModels/:modelId:analyzeBatch'
    params:
    - name: api-version
      value: ''
      type: query
      description: The API version to use for this operation.
    - name: modelId
      value: ''
      type: path
      description: Unique document model name.
    - name: pages
      value: ''
      type: query
      description: 1-based page numbers to analyze.  Ex. "1-3,5,7-9"
    - name: locale
      value: ''
      type: query
      description: 'Locale hint for text recognition and document analysis.  Value may contain only

        the language code (ex. "en", "fr") or BCP 47 language tag (ex. "en-US").'
    - name: stringIndexType
      value: ''
      type: query
      description: Method used to compute string offset and length.
    - name: features
      value: ''
      type: query
      description: List of optional analysis features.
    - name: queryFields
      value: ''
      type: query
      description: List of additional fields to extract.  Ex. "NumberOfGuests,StoreNumber"
    - name: outputContentFormat
      value: ''
      type: query
      description: Format of the analyze result top-level content.
    - name: output
      value: ''
      type: query
      description: Additional outputs to generate during analysis.
  docs: Analyzes batch documents with document model.
- info:
    name: DocumentModels_GetModel
    type: http
  http:
    method: GET
    url: '{{baseUrl}}/documentModels/:modelId'
    headers:
    - name: x-ms-client-request-id
      value: ''
    params:
    - name: api-version
      value: ''
      type: query
      description: The API version to use for this operation.
    - name: modelId
      value: ''
      type: path
      description: Unique document model name.
  docs: Gets detailed document model information.
- info:
    name: DocumentModels_DeleteModel
    type: http
  http:
    method: DELETE
    url: '{{baseUrl}}/documentModels/:modelId'
    headers:
    - name: x-ms-client-request-id
      value: ''
    params:
    - name: api-version
      value: ''
      type: query
      description: The API version to use for this operation.
    - name: modelId
      value: ''
      type: path
      description: Unique document model name.
  docs: Deletes document model.
- info:
    name: DocumentModels_CopyModelTo
    type: http
  http:
    method: POST
    url: '{{baseUrl}}/documentModels/:modelId:copyTo'
    params:
    - name: api-version
      value: ''
      type: query
      description: The API version to use for this operation.
    - name: modelId
      value: ''
      type: path
      description: Unique document model name.
  docs: Copies document model to the target resource, region, and modelId.
- info:
    name: DocumentModels_ListAnalyzeBatchResults
    type: http
  http:
    method: GET
    url: '{{baseUrl}}/documentModels/:modelId/analyzeBatchResults'
    params:
    - name: api-version
      value: ''
      type: query
      description: The API version to use for this operation.
    - name: modelId
      value: ''
      type: path
      description: Unique document model name.
  docs: List batch document analysis results.
- info:
    name: DocumentModels_GetAnalyzeBatchResult
    type: http
  http:
    method: GET
    url: '{{baseUrl}}/documentModels/:modelId/analyzeBatchResults/:resultId'
    params:
    - name: api-version
      value: ''
      type: query
      description: The API version to use for this operation.
    - name: modelId
      value: ''
      type: path
      description: Unique document model name.
    - name: resultId
      value: ''
      type: path
      description: Analyze batch operation result ID.
  docs: Gets the result of batch document analysis.
- info:
    name: DocumentModels_DeleteAnalyzeBatchResult
    type: http
  http:
    method: DELETE
    url: '{{baseUrl}}/documentModels/:modelId/analyzeBatchResults/:resultId'
    params:
    - name: api-version
      value: ''
      type: query
      description: The API version to use for this operation.
    - name: modelId
      value: ''
      type: path
      description: Unique document model name.
    - name: resultId
      value: ''
      type: path
      description: Analyze batch operation result ID.
  docs: Mark the batch document analysis result for deletion.
- info:
    name: DocumentModels_GetAnalyzeResult
    type: http
  http:
    method: GET
    url: '{{baseUrl}}/documentModels/:modelId/analyzeResults/:resultId'
    params:
    - name: api-version
      value: ''
      type: query
      description: The API version to use for this operation.
    - name: modelId
      value: ''
      type: path
      description: Unique document model name.
    - name: resultId
      value: ''
      type: path
      description: Analyze operation result ID.
  docs: Gets the result of document analysis.
- info:
    name: DocumentModels_DeleteAnalyzeResult
    type: http
  http:
    method: DELETE
    url: '{{baseUrl}}/documentModels/:modelId/analyzeResults/:resultId'
    params:
    - name: api-version
      value: ''
      type: query
      description: The API version to use for this operation.
    - name: modelId
      value: ''
      type: path
      description: Unique document model name.
    - name: resultId
      value: ''
      type: path
      description: Analyze operation result ID.
  docs: Mark the result of document analysis for deletion.
- info:
    name: DocumentModels_GetAnalyzeResultFigure
    type: http
  http:
    method: GET
    url: '{{baseUrl}}/documentModels/:modelId/analyzeResults/:resultId/figures/:figureId'
    params:
    - name: api-version
      value: ''
      type: query
      description: The API version to use for this operation.
    - name: modelId
      value: ''
      type: path
      description: Unique document model name.
    - name: resultId
      value: ''
      type: path
      description: Analyze operation result ID.
    - name: figureId
      value: ''
      type: path
      description: Figure ID.
  docs: Gets the generated cropped image of specified figure from document analysis.
- info:
    name: DocumentModels_GetAnalyzeResultPdf
    type: http
  http:
    method: GET
    url: '{{baseUrl}}/documentModels/:modelId/analyzeResults/:resultId/pdf'
    params:
    - name: api-version
      value: ''
      type: query
      description: The API version to use for this operation.
    - name: modelId
      value: ''
      type: path
      description: Unique document model name.
    - name: resultId
      value: ''
      type: path
      description: Analyze operation result ID.
  docs: Gets the generated searchable PDF output from document analysis.
- info:
    name: DocumentModels_AuthorizeModelCopy
    type: http
  http:
    method: POST
    url: '{{baseUrl}}/documentModels:authorizeCopy'
    params:
    - name: api-version
      value: ''
      type: query
      description: The API version to use for this operation.
  docs: 'Generates authorization to copy a document model to this location with

    specified modelId and optional description.'
- info:
    name: DocumentModels_BuildModel
    type: http
  http:
    method: POST
    url: '{{baseUrl}}/documentModels:build'
    params:
    - name: api-version
      value: ''
      type: query
      description: The API version to use for this operation.
  docs: Builds a custom document analysis model.
- info:
    name: DocumentModels_ComposeModel
    type: http
  http:
    method: POST
    url: '{{baseUrl}}/documentModels:compose'
    params:
    - name: api-version
      value: ''
      type: query
      description: The API version to use for this operation.
  docs: Creates a new document model from document types of existing document models.
- info:
    name: MiscellaneousOperations_GetResourceDetails
    type: http
  http:
    method: GET
    url: '{{baseUrl}}/info'
    params:
    - name: api-version
      value: ''
      type: query
      description: The API version to use for this operation.
  docs: Return information about the current resource.
- info:
    name: MiscellaneousOperations_ListOperations
    type: http
  http:
    method: GET
    url: '{{baseUrl}}/operations'
    headers:
    - name: x-ms-client-request-id
      value: ''
    params:
    - name: api-version
      value: ''
      type: query
      description: The API version to use for this operation.
  docs: Lists all operations.
- info:
    name: MiscellaneousOperations_GetDocumentModelBuildOperation
    type: http
  http:
    method: GET
    url: '{{baseUrl}}/operations/:operationId'
    headers:
    - name: x-ms-client-request-id
      value: ''
    params:
    - name: api-version
      value: ''
      type: query
      description: The API version to use for this operation.
    - name: operationId
      value: ''
      type: path
      description: Operation ID
  docs: Gets operation info.
bundled: true