Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.
All 92 tools →
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/azure-document-intelligence-documentclassifiers-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"
Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: Document Intelligence (formerly Form Recognizer) Document Classifiers API
version: '2024-11-30'
description: Extracts content, layout, and structured data from documents.
x-typespec-generated:
- emitter: '@azure-tools/typespec-autorest'
servers:
- url: https://<your-resource>.cognitiveservices.azure.com/
security:
- ApiKeyAuth: []
- OAuth2Auth:
- https://cognitiveservices.azure.com/.default
tags:
- name: DocumentClassifiers
paths:
/documentClassifiers:
get:
operationId: DocumentClassifiers_ListClassifiers
description: List all document classifiers.
parameters:
- $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter'
- $ref: '#/components/parameters/Azure.Core.ClientRequestIdHeader'
responses:
'200':
description: The request has succeeded.
headers:
x-ms-client-request-id:
description: An opaque, globally-unique, client-generated string identifier for the request.
schema:
type: string
format: uuid
content:
application/json:
schema:
$ref: '#/components/schemas/PagedDocumentClassifierDetails'
default:
description: An unexpected error response.
content:
application/json:
schema:
$ref: '#/components/schemas/DocumentIntelligenceErrorResponse'
x-ms-examples:
Get Document Classifiers:
$ref: ./examples/GetDocumentClassifiers.json
x-ms-pageable:
nextLinkName: nextLink
tags:
- DocumentClassifiers
/documentClassifiers/{classifierId}:
get:
operationId: DocumentClassifiers_GetClassifier
description: Gets detailed document classifier information.
parameters:
- $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter'
- name: classifierId
in: path
description: Unique document classifier name.
required: true
schema:
type: string
maxLength: 64
pattern: ^[a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}$
- $ref: '#/components/parameters/Azure.Core.ClientRequestIdHeader'
responses:
'200':
description: The request has succeeded.
headers:
x-ms-client-request-id:
description: An opaque, globally-unique, client-generated string identifier for the request.
schema:
type: string
format: uuid
content:
application/json:
schema:
$ref: '#/components/schemas/DocumentClassifierDetails'
default:
description: An unexpected error response.
content:
application/json:
schema:
$ref: '#/components/schemas/DocumentIntelligenceErrorResponse'
x-ms-examples:
Get Document Classifier:
$ref: ./examples/GetDocumentClassifier.json
tags:
- DocumentClassifiers
delete:
operationId: DocumentClassifiers_DeleteClassifier
description: Deletes document classifier.
parameters:
- $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter'
- name: classifierId
in: path
description: Unique document classifier name.
required: true
schema:
type: string
maxLength: 64
pattern: ^[a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}$
- $ref: '#/components/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:
description: An opaque, globally-unique, client-generated string identifier for the request.
schema:
type: string
format: uuid
default:
description: An unexpected error response.
content:
application/json:
schema:
$ref: '#/components/schemas/DocumentIntelligenceErrorResponse'
x-ms-examples:
Delete Document Classifier:
$ref: ./examples/DeleteDocumentClassifier.json
tags:
- DocumentClassifiers
/documentClassifiers/{classifierId}:analyze:
post:
operationId: DocumentClassifiers_ClassifyDocumentFromStream
description: Classifies document with document classifier.
parameters:
- $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter'
- $ref: '#/components/parameters/DocumentClassifierAnalyzeRequestParams.classifierId'
- $ref: '#/components/parameters/DocumentClassifierAnalyzeRequestParams.stringIndexType'
- $ref: '#/components/parameters/DocumentClassifierAnalyzeRequestParams.split'
- $ref: '#/components/parameters/DocumentClassifierAnalyzeRequestParams.pages'
- $ref: '#/components/parameters/AnalyzeFromStreamRequestParams.input'
responses:
'202':
description: The request has been accepted for processing, but processing has not yet completed.
headers:
Operation-Location:
description: The location of an instance of AnalyzeOperation
schema:
type: string
format: uri
Retry-After:
description: The Retry-After header can indicate how long the client should wait before polling the operation status.
schema:
type: integer
format: int32
default:
description: An unexpected error response.
content:
application/json:
schema:
$ref: '#/components/schemas/DocumentIntelligenceErrorResponse'
x-ms-examples:
Classify Document from Url:
$ref: ./examples/ClassifyDocument_Stream.json
x-ms-long-running-operation: true
tags:
- DocumentClassifiers
/documentClassifiers/{classifierId}:copyTo:
post:
operationId: DocumentClassifiers_CopyClassifierTo
description: Copies document classifier to the target resource, region, and classifierId.
parameters:
- $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter'
- name: classifierId
in: path
description: Unique document classifier name.
required: true
schema:
type: string
maxLength: 64
pattern: ^[a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}$
responses:
'202':
description: The request has been accepted for processing, but processing has not yet completed.
headers:
Operation-Location:
description: The location of an instance of DocumentClassifierCopyToOperationDetails
schema:
type: string
format: uri
Retry-After:
description: The Retry-After header can indicate how long the client should wait before polling the operation status.
schema:
type: integer
format: int32
default:
description: An unexpected error response.
content:
application/json:
schema:
$ref: '#/components/schemas/DocumentIntelligenceErrorResponse'
x-ms-examples:
Copy Document Classifier To:
$ref: ./examples/CopyDocumentClassifierTo.json
x-ms-long-running-operation: true
tags:
- DocumentClassifiers
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ClassifierCopyAuthorization'
description: Copy to request parameters.
required: true
/documentClassifiers/{classifierId}/analyzeResults/{resultId}:
get:
operationId: DocumentClassifiers_GetClassifyResult
description: Gets the result of document classifier.
parameters:
- $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter'
- name: classifierId
in: path
description: Unique document classifier name.
required: true
schema:
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
schema:
type: string
format: uuid
responses:
'200':
description: The request has succeeded.
content:
application/json:
schema:
$ref: '#/components/schemas/AnalyzeOperation'
default:
description: An unexpected error response.
content:
application/json:
schema:
$ref: '#/components/schemas/DocumentIntelligenceErrorResponse'
x-ms-examples:
Get Classify Document Result:
$ref: ./examples/GetClassifyDocumentResult.json
tags:
- DocumentClassifiers
components:
schemas:
DocumentSelectionMark:
type: object
description: 'A selection mark object representing check boxes, radio buttons, and other
elements indicating a selection.'
properties:
state:
$ref: '#/components/schemas/DocumentSelectionMarkState'
description: State of the selection mark.
polygon:
type: array
description: 'Bounding polygon of the selection mark, with coordinates specified relative
to the top-left of the page. The numbers represent the x, y values of the
polygon vertices, clockwise from the left (-180 degrees inclusive) relative
to the element orientation.'
items:
type: number
format: float
span:
$ref: '#/components/schemas/DocumentSpan'
description: Location of the selection mark in the reading order concatenated content.
confidence:
type: number
format: float
description: Confidence of correctly extracting the selection mark.
minimum: 0
maximum: 1
required:
- state
- span
- confidence
DocumentTableCell:
type: object
description: An object representing the location and content of a table cell.
properties:
kind:
type: string
description: Table cell kind.
default: content
enum:
- content
- rowHeader
- columnHeader
- stubHead
- description
x-ms-enum:
name: DocumentTableCellKind
modelAsString: true
values:
- name: content
value: content
description: Contains the main content/data.
- name: rowHeader
value: rowHeader
description: Describes the content of the row.
- name: columnHeader
value: columnHeader
description: Describes the content of the column.
- name: stubHead
value: stubHead
description: Describes the row headers, usually located at the top left corner of a table.
- name: description
value: description
description: Describes the content in (parts of) the table.
rowIndex:
type: integer
format: int32
description: Row index of the cell.
columnIndex:
type: integer
format: int32
description: Column index of the cell.
rowSpan:
type: integer
format: int32
description: Number of rows spanned by this cell.
default: 1
minimum: 1
columnSpan:
type: integer
format: int32
description: Number of columns spanned by this cell.
default: 1
minimum: 1
content:
type: string
description: Concatenated content of the table cell in reading order.
boundingRegions:
type: array
description: Bounding regions covering the table cell.
items:
$ref: '#/components/schemas/BoundingRegion'
spans:
type: array
description: Location of the table cell in the reading order concatenated content.
items:
$ref: '#/components/schemas/DocumentSpan'
elements:
type: array
description: Child elements of the table cell.
items:
$ref: '#/components/schemas/DocumentElement'
required:
- rowIndex
- columnIndex
- content
- spans
DocumentFontStyle:
type: string
description: Font style.
enum:
- normal
- italic
x-ms-enum:
name: DocumentFontStyle
modelAsString: true
values:
- name: normal
value: normal
description: Characters are represented normally.
- name: italic
value: italic
description: Characters are visually slanted to the right.
DocumentField:
type: object
description: An object representing the content and location of a field value.
properties:
type:
$ref: '#/components/schemas/DocumentFieldType'
description: Data type of the field value.
valueString:
type: string
description: String value.
valueDate:
type: string
format: date
description: Date value in YYYY-MM-DD format (ISO 8601).
valueTime:
type: string
format: time
description: Time value in hh:mm:ss format (ISO 8601).
valuePhoneNumber:
type: string
description: Phone number value in E.164 format (ex. +19876543210).
valueNumber:
type: number
format: double
description: Floating point value.
valueInteger:
type: integer
format: int64
description: Integer value.
valueSelectionMark:
$ref: '#/components/schemas/DocumentSelectionMarkState'
description: Selection mark value.
valueSignature:
$ref: '#/components/schemas/DocumentSignatureType'
description: Presence of signature.
valueCountryRegion:
type: string
description: 3-letter country code value (ISO 3166-1 alpha-3).
valueArray:
type: array
description: Array of field values.
items:
$ref: '#/components/schemas/DocumentField'
valueObject:
type: object
description: Dictionary of named field values.
additionalProperties:
$ref: '#/components/schemas/DocumentField'
valueCurrency:
$ref: '#/components/schemas/CurrencyValue'
description: Currency value.
valueAddress:
$ref: '#/components/schemas/AddressValue'
description: Address value.
valueBoolean:
type: boolean
description: Boolean value.
valueSelectionGroup:
type: array
description: Selection group value.
items:
type: string
content:
type: string
description: Field content.
boundingRegions:
type: array
description: Bounding regions covering the field.
items:
$ref: '#/components/schemas/BoundingRegion'
spans:
type: array
description: Location of the field in the reading order concatenated content.
items:
$ref: '#/components/schemas/DocumentSpan'
confidence:
type: number
format: float
description: Confidence of correctly extracting the field.
minimum: 0
maximum: 1
required:
- type
DocumentIntelligenceOperationStatus:
type: string
description: Operation status.
enum:
- notStarted
- running
- failed
- succeeded
- canceled
- skipped
x-ms-enum:
name: DocumentIntelligenceOperationStatus
modelAsString: true
values:
- name: notStarted
value: notStarted
description: The operation has not started yet.
- name: running
value: running
description: The operation is in progress.
- name: failed
value: failed
description: The operation has failed.
- name: succeeded
value: succeeded
description: The operation has succeeded.
- name: canceled
value: canceled
description: The operation has been canceled.
- name: skipped
value: skipped
description: The operation has been skipped.
DocumentBarcodeKind:
type: string
description: Barcode kind.
enum:
- QRCode
- PDF417
- UPCA
- UPCE
- Code39
- Code128
- EAN8
- EAN13
- DataBar
- Code93
- Codabar
- DataBarExpanded
- ITF
- MicroQRCode
- Aztec
- DataMatrix
- MaxiCode
x-ms-enum:
name: DocumentBarcodeKind
modelAsString: true
values:
- name: QRCode
value: QRCode
description: QR code, as defined in ISO/IEC 18004:2015.
- name: PDF417
value: PDF417
description: PDF417, as defined in ISO 15438.
- name: UPCA
value: UPCA
description: GS1 12-digit Universal Product Code.
- name: UPCE
value: UPCE
description: GS1 6-digit Universal Product Code.
- name: Code39
value: Code39
description: Code 39 barcode, as defined in ISO/IEC 16388:2007.
- name: Code128
value: Code128
description: Code 128 barcode, as defined in ISO/IEC 15417:2007.
- name: EAN8
value: EAN8
description: GS1 8-digit International Article Number (European Article Number).
- name: EAN13
value: EAN13
description: GS1 13-digit International Article Number (European Article Number).
- name: DataBar
value: DataBar
description: GS1 DataBar barcode.
- name: Code93
value: Code93
description: Code 93 barcode, as defined in ANSI/AIM BC5-1995.
- name: Codabar
value: Codabar
description: Codabar barcode, as defined in ANSI/AIM BC3-1995.
- name: DataBarExpanded
value: DataBarExpanded
description: GS1 DataBar Expanded barcode.
- name: ITF
value: ITF
description: Interleaved 2 of 5 barcode, as defined in ANSI/AIM BC2-1995.
- name: MicroQRCode
value: MicroQRCode
description: Micro QR code, as defined in ISO/IEC 23941:2022.
- name: Aztec
value: Aztec
description: Aztec code, as defined in ISO/IEC 24778:2008.
- name: DataMatrix
value: DataMatrix
description: Data matrix code, as defined in ISO/IEC 16022:2006.
- name: MaxiCode
value: MaxiCode
description: MaxiCode, as defined in ISO/IEC 16023:2000.
DocumentFootnote:
type: object
description: A footnote object describing a table or figure.
properties:
content:
type: string
description: Content of the footnote.
boundingRegions:
type: array
description: Bounding regions covering the footnote.
items:
$ref: '#/components/schemas/BoundingRegion'
spans:
type: array
description: Location of the footnote in the reading order concatenated content.
items:
$ref: '#/components/schemas/DocumentSpan'
elements:
type: array
description: Child elements of the footnote.
items:
$ref: '#/components/schemas/DocumentElement'
required:
- content
- spans
PagedDocumentClassifierDetails:
type: object
description: Paged collection of DocumentClassifierDetails items
properties:
value:
type: array
description: The DocumentClassifierDetails items on this page
items:
$ref: '#/components/schemas/DocumentClassifierDetails'
nextLink:
type: string
format: uri
description: The link to the next page of items
required:
- value
DocumentTable:
type: object
description: A table object consisting table cells arranged in a rectangular layout.
properties:
rowCount:
type: integer
format: int32
description: Number of rows in the table.
minimum: 1
columnCount:
type: integer
format: int32
description: Number of columns in the table.
minimum: 1
cells:
type: array
description: Cells contained within the table.
items:
$ref: '#/components/schemas/DocumentTableCell'
boundingRegions:
type: array
description: Bounding regions covering the table.
items:
$ref: '#/components/schemas/BoundingRegion'
spans:
type: array
description: Location of the table in the reading order concatenated content.
items:
$ref: '#/components/schemas/DocumentSpan'
caption:
$ref: '#/components/schemas/DocumentCaption'
description: Caption associated with the table.
footnotes:
type: array
description: List of footnotes associated with the table.
items:
$ref: '#/components/schemas/DocumentFootnote'
required:
- rowCount
- columnCount
- cells
- spans
DocumentPage:
type: object
description: Content and layout elements extracted from a page from the input.
properties:
pageNumber:
type: integer
format: int32
description: 1-based page number in the input document.
minimum: 1
angle:
type: number
format: float
description: 'The general orientation of the content in clockwise direction, measured in
degrees between (-180, 180].'
maximum: 180
width:
type: number
format: float
description: The width of the image/PDF in pixels/inches, respectively.
minimum: 0
height:
type: number
format: float
description: The height of the image/PDF in pixels/inches, respectively.
minimum: 0
unit:
$ref: '#/components/schemas/LengthUnit'
description: 'The unit used by the width, height, and polygon properties. For images, the
unit is "pixel". For PDF, the unit is "inch".'
spans:
type: array
description: Location of the page in the reading order concatenated content.
items:
$ref: '#/components/schemas/DocumentSpan'
words:
type: array
description: Extracted words from the page.
items:
$ref: '#/components/schemas/DocumentWord'
selectionMarks:
type: array
description: Extracted selection marks from the page.
items:
$ref: '#/components/schemas/DocumentSelectionMark'
lines:
type: array
description: 'Extracted lines from the page, potentially containing both textual and visual
elements.'
items:
$ref: '#/components/schemas/DocumentLine'
barcodes:
type: array
description: Extracted barcodes from the page.
items:
$ref: '#/components/schemas/DocumentBarcode'
formulas:
type: array
description: Extracted formulas from the page.
items:
$ref: '#/components/schemas/DocumentFormula'
required:
- pageNumber
- spans
DocumentWord:
type: object
description: 'A word object consisting of a contiguous sequence of characters. For non-space
delimited languages, such as Chinese, Japanese, and Korean, each character is
represented as its own word.'
properties:
content:
type: string
description: Text content of the word.
polygon:
type: array
description: 'Bounding polygon of the word, with coordinates specified relative to the
top-left of the page. The numbers represent the x, y values of the polygon
vertices, clockwise from the left (-180 degrees inclusive) relative to the
element orientation.'
items:
type: number
format: float
span:
$ref: '#/components/schemas/DocumentSpan'
description: Location of the word in the reading order concatenated content.
confidence:
type: number
format: float
description: Confidence of correctly extracting the word.
minimum: 0
maximum: 1
required:
- content
- span
- confidence
AddressValue:
type: object
description: Address field value.
properties:
houseNumber:
type: string
description: House or building number.
poBox:
type: string
description: Post office box number.
road:
type: string
description: Street name.
city:
type: string
description: Name of city, town, village, etc.
state:
type: string
description: First-level administrative division.
postalCode:
type: string
description: Postal code used for mail sorting.
countryRegion:
type: string
description: Country/region.
streetAddress:
type: string
description: Street-level address, excluding city, state, countryRegion, and postalCode.
unit:
type: string
description: Apartment or office number
cityDistrict:
type: string
description: 'Districts or boroughs within a city, such as Brooklyn in New York City or City
of Westminster in London.'
stateDistrict:
type: string
description: Second-level administrative division used in certain locales.
suburb:
type: string
description: Unofficial neighborhood name, like Chinatown.
house:
type: string
description: Build name, such as World Trade Center.
level:
type: string
description: Floor number, such as 3F.
DocumentIntelligenceInnerError:
type: object
description: An object containing more specific information about the error.
properties:
code:
type: string
description: One of a server-defined set of error codes.
message:
type: string
description: A human-readable representation of the error.
innererror:
$ref: '#/components/schemas/DocumentIntelligenceInnerError'
description: Inner error.
DocumentFigure:
type: object
description: An object representing a figure in the document.
properties:
boundingRegions:
type: array
description: Bounding regions covering the figure.
items:
$ref: '#/components/schemas/BoundingRegion'
spans:
type: array
description: Location of the figure in the reading order concatenated content.
items:
$ref: '#/components/schemas/DocumentSpan'
elements:
type: array
description: Child elements of the figure, excluding any caption or footnotes.
items:
$ref: '#/components/schemas/DocumentElement'
caption:
$ref: '#/components/schemas/DocumentCaption'
description: Caption associated with the figure.
footnotes:
type: array
description: List of footnotes associated with the figure.
items:
$ref: '#/components/schemas/DocumentFootnote'
id:
type: string
description: Figure ID.
required:
- spans
ClassifierDocumentTypeDetails:
type: object
description: Classifier document type info.
properties:
sourceKind:
$ref: '#/components/schemas/ContentSourceKind'
description: Type of training data source.
azureBlobSource:
$ref: '#/components/schemas/AzureBlobContentSource'
description: 'Azure Blob Storage location containing the training data for a classifier
document type. Either azureBlobSource or azureBlobFileListSource must be
specified.'
azureBlobFileListSource:
$ref: '#/components/schemas/AzureBlobFileListContentSource'
description: 'Azure Blob Storage file list specifying the training data for a classifier
document type. Either azureBlobSource or azureBlobFileListSource must be
specified.'
DocumentBarcode:
type: object
description: A barcode object.
properties:
kind:
$ref: '#/components/schemas/DocumentBarcodeKind'
description: Barcode kind.
value:
type: string
description: Barcode value.
polygon:
type: array
description: 'Bounding polygon of the barcode, with coordinates specified relative to the
top-left of the page. The numbers represent the x, y values of the polygon
vertices, clockwise from the left (-180 degrees inclusive) relative to the
element orientation.'
items:
type: number
format: float
span:
$ref: '#/components/schemas/DocumentSpan'
description: Location of the barcode in the reading order concatenated content.
confidence:
type: number
format: float
description: Confidence of correctly extracting the barcode.
minimum: 0
maximum: 1
required:
- kind
- value
- span
- confidence
DocumentSelectionMarkState:
type: string
description: State of the selection mark.
enum:
- selected
- unselected
x-ms-enum:
name: DocumentSelectionMarkState
modelAsString: true
values:
- name: selected
value: selected
description: 'The selection mark is selected, often indicated by a check ✓ or cross X inside
the selection mark.'
- name: unselected
value: unselected
description: The selection mark is not selected.
AzureBlobContentSource:
type: object
description: Azure Blob Storage content.
properties:
containerUrl:
type: string
format: uri
description: Azure Blob Storage container URL.
prefix:
type: string
description: Blob name prefix.
required:
- containerUrl
DocumentSection:
type: object
description: An object representing a section in the document.
properties:
spans:
type: array
description: Location of the section in the reading order concatenated content.
items:
$ref: '#/components/schemas/DocumentSpan'
elements:
type: array
description: Child elements of the section.
items:
$ref: '#/components/schemas/DocumentElement'
required:
- spans
DocumentFontWeight:
type: string
description: Font weight.
enum:
- normal
- bold
x-ms-enum:
name: DocumentFontWeight
modelAsString: true
values:
- name: normal
value: normal
description: Characters are represented normally.
- name: bold
value: bold
description: Characters are represented with thicker strokes.
DocumentLine:
type: object
description: 'A content line object consisting of an adjacent sequence of content elements
# --- truncated at 32 KB (70 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/azure-document-intelligence/refs/heads/main/openapi/azure-document-intelligence-documentclassifiers-api-openapi.yml