Azure AI Document Intelligence
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 Extractors. Authenticated via Azure subscription key or Microsoft Entra ID (formerly Azure AD).
Documentation GitHub OpenAPI
OpenAPI Specification

{
  "swagger": "2.0",
  "info": {
    "title": "Document Intelligence (formerly Form Recognizer)",
    "version": "2024-11-30",
    "description": "Extracts content, layout, and structured data from documents.",
    "x-typespec-generated": [
      {
        "emitter": "@azure-tools/typespec-autorest"
      }
    ]
  },
  "schemes": [
    "https"
  ],
  "x-ms-parameterized-host": {
    "hostTemplate": "{endpoint}/documentintelligence",
    "useSchemePrefix": false,
    "parameters": [
      {
        "name": "endpoint",
        "in": "path",
        "description": "The Document Intelligence service endpoint.",
        "required": true,
        "type": "string",
        "format": "uri",
        "x-ms-skip-url-encoding": true
      }
    ]
  },
  "produces": [
    "application/json"
  ],
  "consumes": [
    "application/json"
  ],
  "security": [
    {
      "ApiKeyAuth": []
    },
    {
      "OAuth2Auth": [
        "https://cognitiveservices.azure.com/.default"
      ]
    }
  ],
  "securityDefinitions": {
    "ApiKeyAuth": {
      "type": "apiKey",
      "name": "Ocp-Apim-Subscription-Key",
      "in": "header"
    },
    "OAuth2Auth": {
      "type": "oauth2",
      "flow": "accessCode",
      "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize",
      "scopes": {
        "https://cognitiveservices.azure.com/.default": ""
      },
      "tokenUrl": "https://login.microsoftonline.com/common/oauth2/token"
    }
  },
  "tags": [],
  "paths": {
    "/documentClassifiers": {
      "get": {
        "operationId": "DocumentClassifiers_ListClassifiers",
        "description": "List all document classifiers.",
        "parameters": [
          {
            "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter"
          },
          {
            "$ref": "#/parameters/Azure.Core.ClientRequestIdHeader"
          }
        ],
        "responses": {
          "200": {
            "description": "The request has succeeded.",
            "schema": {
              "$ref": "#/definitions/PagedDocumentClassifierDetails"
            },
            "headers": {
              "x-ms-client-request-id": {
                "type": "string",
                "format": "uuid",
                "description": "An opaque, globally-unique, client-generated string identifier for the request."
              }
            }
          },
          "default": {
            "description": "An unexpected error response.",
            "schema": {
              "$ref": "#/definitions/DocumentIntelligenceErrorResponse"
            }
          }
        },
        "x-ms-examples": {
          "Get Document Classifiers": {
            "$ref": "./examples/GetDocumentClassifiers.json"
          }
        },
        "x-ms-pageable": {
          "nextLinkName": "nextLink"
        }
      }
    },
    "/documentClassifiers/{classifierId}": {
      "get": {
        "operationId": "DocumentClassifiers_GetClassifier",
        "description": "Gets detailed document classifier information.",
        "parameters": [
          {
            "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter"
          },
          {
            "name": "classifierId",
            "in": "path",
            "description": "Unique document classifier name.",
            "required": true,
            "type": "string",
            "maxLength": 64,
            "pattern": "^[a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}$"
          },
          {
            "$ref": "#/parameters/Azure.Core.ClientRequestIdHeader"
          }
        ],
        "responses": {
          "200": {
            "description": "The request has succeeded.",
            "schema": {
              "$ref": "#/definitions/DocumentClassifierDetails"
            },
            "headers": {
              "x-ms-client-request-id": {
                "type": "string",
                "format": "uuid",
                "description": "An opaque, globally-unique, client-generated string identifier for the request."
              }
            }
          },
          "default": {
            "description": "An unexpected error response.",
            "schema": {
              "$ref": "#/definitions/DocumentIntelligenceErrorResponse"
            }
          }
        },
        "x-ms-examples": {
          "Get Document Classifier": {
            "$ref": "./examples/GetDocumentClassifier.json"
          }
        }
      },
      "delete": {
        "operationId": "DocumentClassifiers_DeleteClassifier",
        "description": "Deletes document classifier.",
        "parameters": [
          {
            "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter"
          },
          {
            "name": "classifierId",
            "in": "path",
            "description": "Unique document classifier name.",
            "required": true,
            "type": "string",
            "maxLength": 64,
            "pattern": "^[a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}$"
          },
          {
            "$ref": "#/parameters/Azure.Core.ClientRequestIdHeader"
          }
        ],
        "responses": {
          "204": {
            "description": "There is no content to send for this request, but the headers may be useful. ",
            "headers": {
              "x-ms-client-request-id": {
                "type": "string",
                "format": "uuid",
                "description": "An opaque, globally-unique, client-generated string identifier for the request."
              }
            }
          },
          "default": {
            "description": "An unexpected error response.",
            "schema": {
              "$ref": "#/definitions/DocumentIntelligenceErrorResponse"
            }
          }
        },
        "x-ms-examples": {
          "Delete Document Classifier": {
            "$ref": "./examples/DeleteDocumentClassifier.json"
          }
        }
      }
    },
    "/documentClassifiers/{classifierId}:analyze": {
      "post": {
        "operationId": "DocumentClassifiers_ClassifyDocumentFromStream",
        "description": "Classifies document with document classifier.",
        "consumes": [
          "application/octet-stream",
          "application/pdf",
          "image/jpeg",
          "image/png",
          "image/tiff",
          "image/bmp",
          "image/heif",
          "text/html",
          "application/vnd.openxmlformats-officedocument.wordprocessingml.document",
          "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet",
          "application/vnd.openxmlformats-officedocument.presentationml.presentation"
        ],
        "parameters": [
          {
            "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter"
          },
          {
            "$ref": "#/parameters/DocumentClassifierAnalyzeRequestParams.classifierId"
          },
          {
            "$ref": "#/parameters/DocumentClassifierAnalyzeRequestParams.stringIndexType"
          },
          {
            "$ref": "#/parameters/DocumentClassifierAnalyzeRequestParams.split"
          },
          {
            "$ref": "#/parameters/DocumentClassifierAnalyzeRequestParams.pages"
          },
          {
            "$ref": "#/parameters/AnalyzeFromStreamRequestParams.input"
          }
        ],
        "responses": {
          "202": {
            "description": "The request has been accepted for processing, but processing has not yet completed.",
            "headers": {
              "Operation-Location": {
                "type": "string",
                "format": "uri",
                "description": "The location of an instance of AnalyzeOperation"
              },
              "Retry-After": {
                "type": "integer",
                "format": "int32",
                "description": "The Retry-After header can indicate how long the client should wait before polling the operation status."
              }
            }
          },
          "default": {
            "description": "An unexpected error response.",
            "schema": {
              "$ref": "#/definitions/DocumentIntelligenceErrorResponse"
            }
          }
        },
        "x-ms-examples": {
          "Classify Document from Url": {
            "$ref": "./examples/ClassifyDocument_Stream.json"
          }
        },
        "x-ms-long-running-operation": true
      }
    },
    "/documentClassifiers/{classifierId}:copyTo": {
      "post": {
        "operationId": "DocumentClassifiers_CopyClassifierTo",
        "description": "Copies document classifier to the target resource, region, and classifierId.",
        "parameters": [
          {
            "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter"
          },
          {
            "name": "classifierId",
            "in": "path",
            "description": "Unique document classifier name.",
            "required": true,
            "type": "string",
            "maxLength": 64,
            "pattern": "^[a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}$"
          },
          {
            "name": "copyToRequest",
            "in": "body",
            "description": "Copy to request parameters.",
            "required": true,
            "schema": {
              "$ref": "#/definitions/ClassifierCopyAuthorization"
            }
          }
        ],
        "responses": {
          "202": {
            "description": "The request has been accepted for processing, but processing has not yet completed.",
            "headers": {
              "Operation-Location": {
                "type": "string",
                "format": "uri",
                "description": "The location of an instance of DocumentClassifierCopyToOperationDetails"
              },
              "Retry-After": {
                "type": "integer",
                "format": "int32",
                "description": "The Retry-After header can indicate how long the client should wait before polling the operation status."
              }
            }
          },
          "default": {
            "description": "An unexpected error response.",
            "schema": {
              "$ref": "#/definitions/DocumentIntelligenceErrorResponse"
            }
          }
        },
        "x-ms-examples": {
          "Copy Document Classifier To": {
            "$ref": "./examples/CopyDocumentClassifierTo.json"
          }
        },
        "x-ms-long-running-operation": true
      }
    },
    "/documentClassifiers/{classifierId}/analyzeResults/{resultId}": {
      "get": {
        "operationId": "DocumentClassifiers_GetClassifyResult",
        "description": "Gets the result of document classifier.",
        "parameters": [
          {
            "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter"
          },
          {
            "name": "classifierId",
            "in": "path",
            "description": "Unique document classifier name.",
            "required": true,
            "type": "string",
            "maxLength": 64,
            "pattern": "^[a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}$"
          },
          {
            "name": "resultId",
            "in": "path",
            "description": "Analyze operation result ID.",
            "required": true,
            "type": "string",
            "format": "uuid"
          }
        ],
        "responses": {
          "200": {
            "description": "The request has succeeded.",
            "schema": {
              "$ref": "#/definitions/AnalyzeOperation"
            }
          },
          "default": {
            "description": "An unexpected error response.",
            "schema": {
              "$ref": "#/definitions/DocumentIntelligenceErrorResponse"
            }
          }
        },
        "x-ms-examples": {
          "Get Classify Document Result": {
            "$ref": "./examples/GetClassifyDocumentResult.json"
          }
        }
      }
    },
    "/documentClassifiers:authorizeCopy": {
      "post": {
        "operationId": "DocumentClassifiers_AuthorizeClassifierCopy",
        "description": "Generates authorization to copy a document classifier to this location with\nspecified classifierId and optional description.",
        "parameters": [
          {
            "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter"
          },
          {
            "name": "authorizeCopyRequest",
            "in": "body",
            "description": "Authorize copy request parameters.",
            "required": true,
            "schema": {
              "$ref": "#/definitions/AuthorizeClassifierCopyRequest"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "The request has succeeded.",
            "schema": {
              "$ref": "#/definitions/ClassifierCopyAuthorization"
            }
          },
          "default": {
            "description": "An unexpected error response.",
            "schema": {
              "$ref": "#/definitions/DocumentIntelligenceErrorResponse"
            }
          }
        },
        "x-ms-examples": {
          "Authorize Copy of Document Classifier": {
            "$ref": "./examples/AuthorizeCopyDocumentClassifier.json"
          }
        }
      }
    },
    "/documentClassifiers:build": {
      "post": {
        "operationId": "DocumentClassifiers_BuildClassifier",
        "description": "Builds a custom document classifier.",
        "parameters": [
          {
            "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter"
          },
          {
            "name": "buildRequest",
            "in": "body",
            "description": "Build request parameters.",
            "required": true,
            "schema": {
              "$ref": "#/definitions/BuildDocumentClassifierRequest"
            }
          }
        ],
        "responses": {
          "202": {
            "description": "The request has been accepted for processing, but processing has not yet completed.",
            "headers": {
              "Operation-Location": {
                "type": "string",
                "format": "uri",
                "description": "The location of an instance of DocumentClassifierBuildOperationDetails"
              },
              "Retry-After": {
                "type": "integer",
                "format": "int32",
                "description": "The Retry-After header can indicate how long the client should wait before polling the operation status."
              }
            }
          },
          "default": {
            "description": "An unexpected error response.",
            "schema": {
              "$ref": "#/definitions/DocumentIntelligenceErrorResponse"
            }
          }
        },
        "x-ms-examples": {
          "Build Document Classifier": {
            "$ref": "./examples/BuildDocumentClassifier.json"
          }
        },
        "x-ms-long-running-operation": true
      }
    },
    "/documentModels": {
      "get": {
        "operationId": "DocumentModels_ListModels",
        "description": "List all document models",
        "parameters": [
          {
            "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter"
          },
          {
            "$ref": "#/parameters/Azure.Core.ClientRequestIdHeader"
          }
        ],
        "responses": {
          "200": {
            "description": "The request has succeeded.",
            "schema": {
              "$ref": "#/definitions/PagedDocumentModelDetails"
            },
            "headers": {
              "x-ms-client-request-id": {
                "type": "string",
                "format": "uuid",
                "description": "An opaque, globally-unique, client-generated string identifier for the request."
              }
            }
          },
          "default": {
            "description": "An unexpected error response.",
            "schema": {
              "$ref": "#/definitions/DocumentIntelligenceErrorResponse"
            }
          }
        },
        "x-ms-examples": {
          "Get Document Models": {
            "$ref": "./examples/GetDocumentModels.json"
          }
        },
        "x-ms-pageable": {
          "nextLinkName": "nextLink"
        }
      }
    },
    "/documentModels/{modelId}:analyze": {
      "post": {
        "operationId": "DocumentModels_AnalyzeDocumentFromStream",
        "description": "Analyzes document with document model.",
        "consumes": [
          "application/octet-stream",
          "application/pdf",
          "image/jpeg",
          "image/png",
          "image/tiff",
          "image/bmp",
          "image/heif",
          "text/html",
          "application/vnd.openxmlformats-officedocument.wordprocessingml.document",
          "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet",
          "application/vnd.openxmlformats-officedocument.presentationml.presentation"
        ],
        "parameters": [
          {
            "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter"
          },
          {
            "$ref": "#/parameters/DocumentModelAnalyzeRequestParams.modelId"
          },
          {
            "$ref": "#/parameters/DocumentModelAnalyzeRequestParams.pages"
          },
          {
            "$ref": "#/parameters/DocumentModelAnalyzeRequestParams.locale"
          },
          {
            "$ref": "#/parameters/DocumentModelAnalyzeRequestParams.stringIndexType"
          },
          {
            "$ref": "#/parameters/DocumentModelAnalyzeRequestParams.features"
          },
          {
            "$ref": "#/parameters/DocumentModelAnalyzeRequestParams.queryFields"
          },
          {
            "$ref": "#/parameters/DocumentModelAnalyzeRequestParams.outputContentFormat"
          },
          {
            "$ref": "#/parameters/DocumentModelAnalyzeRequestParams.output"
          },
          {
            "$ref": "#/parameters/AnalyzeFromStreamRequestParams.input"
          }
        ],
        "responses": {
          "202": {
            "description": "The request has been accepted for processing, but processing has not yet completed.",
            "headers": {
              "Operation-Location": {
                "type": "string",
                "format": "uri",
                "description": "The location of an instance of AnalyzeOperation"
              },
              "Retry-After": {
                "type": "integer",
                "format": "int32",
                "description": "The Retry-After header can indicate how long the client should wait before polling the operation status."
              }
            }
          },
          "default": {
            "description": "An unexpected error response.",
            "schema": {
              "$ref": "#/definitions/DocumentIntelligenceErrorResponse"
            }
          }
        },
        "x-ms-examples": {
          "Analyze Document from Url": {
            "$ref": "./examples/AnalyzeDocument_Stream.json"
          }
        },
        "x-ms-long-running-operation": true
      }
    },
    "/documentModels/{modelId}:analyzeBatch": {
      "post": {
        "operationId": "DocumentModels_AnalyzeBatchDocuments",
        "description": "Analyzes batch documents with document model.",
        "parameters": [
          {
            "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter"
          },
          {
            "$ref": "#/parameters/DocumentModelAnalyzeRequestParams.modelId"
          },
          {
            "$ref": "#/parameters/DocumentModelAnalyzeRequestParams.pages"
          },
          {
            "$ref": "#/parameters/DocumentModelAnalyzeRequestParams.locale"
          },
          {
            "$ref": "#/parameters/DocumentModelAnalyzeRequestParams.stringIndexType"
          },
          {
            "$ref": "#/parameters/DocumentModelAnalyzeRequestParams.features"
          },
          {
            "$ref": "#/parameters/DocumentModelAnalyzeRequestParams.queryFields"
          },
          {
            "$ref": "#/parameters/DocumentModelAnalyzeRequestParams.outputContentFormat"
          },
          {
            "$ref": "#/parameters/DocumentModelAnalyzeRequestParams.output"
          },
          {
            "name": "analyzeBatchRequest",
            "in": "body",
            "description": "Analyze batch request parameters.",
            "required": true,
            "schema": {
              "$ref": "#/definitions/AnalyzeBatchDocumentsRequest"
            }
          }
        ],
        "responses": {
          "202": {
            "description": "The request has been accepted for processing, but processing has not yet completed.",
            "headers": {
              "Operation-Location": {
                "type": "string",
                "format": "uri",
                "description": "The location of an instance of AnalyzeBatchOperation"
              },
              "Retry-After": {
                "type": "integer",
                "format": "int32",
                "description": "The Retry-After header can indicate how long the client should wait before polling the operation status."
              }
            }
          },
          "default": {
            "description": "An unexpected error response.",
            "schema": {
              "$ref": "#/definitions/DocumentIntelligenceErrorResponse"
            }
          }
        },
        "x-ms-examples": {
          "Analyze Batch Documents": {
            "$ref": "./examples/AnalyzeBatchDocuments.json"
          }
        },
        "x-ms-long-running-operation": true
      }
    },
    "/documentModels/{modelId}": {
      "get": {
        "operationId": "DocumentModels_GetModel",
        "description": "Gets detailed document model information.",
        "parameters": [
          {
            "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter"
          },
          {
            "name": "modelId",
            "in": "path",
            "description": "Unique document model name.",
            "required": true,
            "type": "string",
            "pattern": "^[a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}$"
          },
          {
            "$ref": "#/parameters/Azure.Core.ClientRequestIdHeader"
          }
        ],
        "responses": {
          "200": {
            "description": "The request has succeeded.",
            "schema": {
              "$ref": "#/definitions/DocumentModelDetails"
            },
            "headers": {
              "x-ms-client-request-id": {
                "type": "string",
                "format": "uuid",
                "description": "An opaque, globally-unique, client-generated string identifier for the request."
              }
            }
          },
          "default": {
            "description": "An unexpected error response.",
            "schema": {
              "$ref": "#/definitions/DocumentIntelligenceErrorResponse"
            }
          }
        },
        "x-ms-examples": {
          "Get Custom Document Model": {
            "$ref": "./examples/GetDocumentModel_Custom.json"
          },
          "Get Prebuilt Document Model": {
            "$ref": "./examples/GetDocumentModel_Prebuilt.json"
          }
        }
      },
      "delete": {
        "operationId": "DocumentModels_DeleteModel",
        "description": "Deletes document model.",
        "parameters": [
          {
            "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter"
          },
          {
            "name": "modelId",
            "in": "path",
            "description": "Unique document model name.",
            "required": true,
            "type": "string",
            "pattern": "^[a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}$"
          },
          {
            "$ref": "#/parameters/Azure.Core.ClientRequestIdHeader"
          }
        ],
        "responses": {
          "204": {
            "description": "There is no content to send for this request, but the headers may be useful. ",
            "headers": {
              "x-ms-client-request-id": {
                "type": "string",
                "format": "uuid",
                "description": "An opaque, globally-unique, client-generated string identifier for the request."
              }
            }
          },
          "default": {
            "description": "An unexpected error response.",
            "schema": {
              "$ref": "#/definitions/DocumentIntelligenceErrorResponse"
            }
          }
        },
        "x-ms-examples": {
          "Delete Document Model": {
            "$ref": "./examples/DeleteDocumentModel.json"
          }
        }
      }
    },
    "/documentModels/{modelId}:copyTo": {
      "post": {
        "operationId": "DocumentModels_CopyModelTo",
        "description": "Copies document model to the target resource, region, and modelId.",
        "parameters": [
          {
            "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter"
          },
          {
            "name": "modelId",
            "in": "path",
            "description": "Unique document model name.",
            "required": true,
            "type": "string",
            "maxLength": 64,
            "pattern": "^[a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}$"
          },
          {
            "name": "copyToRequest",
            "in": "body",
            "description": "Copy to request parameters.",
            "required": true,
            "schema": {
              "$ref": "#/definitions/ModelCopyAuthorization"
            }
          }
        ],
        "responses": {
          "202": {
            "description": "The request has been accepted for processing, but processing has not yet completed.",
            "headers": {
              "Operation-Location": {
                "type": "string",
                "format": "uri",
                "description": "The location of an instance of DocumentModelCopyToOperationDetails"
              },
              "Retry-After": {
                "type": "integer",
                "format": "int32",
                "description": "The Retry-After header can indicate how long the client should wait before polling the operation status."
              }
            }
          },
          "default": {
            "description": "An unexpected error response.",
            "schema": {
              "$ref": "#/definitions/DocumentIntelligenceErrorResponse"
            }
          }
        },
        "x-ms-examples": {
          "Copy Document Model To": {
            "$ref": "./examples/CopyDocumentModelTo.json"
          }
        },
        "x-ms-long-running-operation": true
      }
    },
    "/documentModels/{modelId}/analyzeBatchResults": {
      "get": {
        "operationId": "DocumentModels_ListAnalyzeBatchResults",
        "description": "List batch document analysis results.",
        "parameters": [
          {
            "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter"
          },
          {
            "name": "modelId",
            "in": "path",
            "description": "Unique document model name.",
            "required": true,
            "type": "string",
            "maxLength": 64,
            "pattern": "^[a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}$"
          }
        ],
        "responses": {
          "200": {
            "description": "The request has succeeded.",
            "schema": {
              "$ref": "#/definitions/PagedAnalyzeBatchOperation"
            }
          },
          "default": {
            "description": "An unexpected error response.",
            "schema": {
              "$ref": "#/definitions/DocumentIntelligenceErrorResponse"
            }
          }
        },
        "x-ms-examples": {
          "List Analyze Batch Documents Results": {
            "$ref": "./examples/GetAnalyzeBatchDocumentsResults.json"
          }
        },
        "x-ms-pageable": {
          "nextLinkName": "nextLink"
        }
      }
    },
    "/documentModels/{modelId}/analyzeBatchResults/{resultId}": {
      "get": {
        "operationId": "DocumentModels_GetAnalyzeBatchResult",
        "description": "Gets the result of batch document analysis.",
        "parameters": [
          {
            "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter"
          },
          {
            "name": "modelId",
            "in": "path",
            "description": "Unique document model name.",
            "required": true,
            "type": "string",
            "maxLength": 64,
            "pattern": "^[a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}$"
          },
          {
            "name": "resultId",
            "in": "path",
            "description": "Analyze batch operation result ID.",
            "required": true,
            "type": "string",
            "format": "uuid"
          }
        ],
        "responses": {
          "200": {
            "description": "The request has succeeded.",
            "schema": {
              "$ref": "#/definitions/AnalyzeBatchOperation"
            }
          },
          "default": {
            "description": "An unexpected error response.",
            "schema": {
              "$ref": "#/definitions/DocumentIntelligenceErrorResponse"
            }
          }
        },
        "x-ms-examples": {
          "Get Analyze Batch Documents Result": {
            "$ref": "./examples/GetAnalyzeBatchDocumentsResult.json"
          }
        }
      },
      "delete": {
        "operationId": "DocumentModels_DeleteAnalyzeBatchResult",
        "description": "Mark the batch document analysis result for deletion.",
        "parameters": [
          {
            "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter"
          },
          {
            "name": "modelId",
            "in": "path",
            "description": "Unique document model name.",
            "required": true,
            "type": "string",
            "maxLength": 64,
            "pattern": "^[a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}$"
          },
          {
            "name": "resultId",
            "in": "path",
            "description": "Analyze batch operation result ID.",
            "required": true,
            "type": "string",
            "format": "uuid"
          }
        ],
        "responses": {
          "204": {
            "description": "There is no content to send for this request, but the headers may be useful."
          },
          "default": {
            "description": "An unexpected error response.",
            "schema": {
              "$ref": "#/definitions/DocumentIntelligenceErrorResponse"
            }
          }
        },
        "x-ms-examples": {
          "Delete Analyze Batch Documents Result": {
            "$ref": "./examples/DeleteAnalyzeBatchDocumentsResult.json"
          }
        }
      }
    },
    "/documentModels/{modelId}/analyzeResults/{resultId}": {
      "get": {
        "operationId": "DocumentModels_GetAnalyzeResult",
        "description": "Gets the result of document analysis.",
        "parameters": [
          {
            "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter"
          },
          {
            "name": "modelId",
            "in": "path",
            "description": "Unique document model name.",
            "required": true,
            "type": "string",
            "maxLength": 64,
            "pattern": "^[a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}$"
          },
          {
            "name": "resultId",
            "in": "path",
            "description": "Analyze operation result ID.",
            "required": true,
            "type": "string",
            "format": "uuid"
          }
        ],
        "responses": {
          "200": {
            "description": "The request has succeeded.",
            "schema": {
              "$ref": "#/definitions/AnalyzeOperation"
            }
          },
          "default": {
            "description": "An unexpected error response.",
            "schema": {
              "$ref": "#/definitions/DocumentIntelligenceErrorResponse"
            }
          }
        },
        "x-ms-examples": {
          "Get Analyze Document Result": {
            "$ref": "./examples/GetAnalyzeDocumentResult.json"
          }
        }
      },
      "delete": {
        "operationId": "DocumentModels_DeleteAnalyzeResult",
        "description": "Mark the result of document analysis for deletion.",
        "parameters": [
          {
            "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter"
          },
          {
            "name": "modelId",
            "in": "path",
  

# --- truncated at 32 KB (157 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/azure-document-intelligence/refs/heads/main/openapi/azure-document-intelligence-openapi.json
Azure AI Document Intelligence REST API

Documentation

Specifications

SDKs

Other Resources

OpenAPI Specification
