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 Documents API

The Documents API from Microsoft Azure — 9 operation(s) for documents.

Microsoft Azure Documents 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 Documents. 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 9 operations across 9 paths, and defines 17 schemas. It is described by OpenAPI 3.2.0, at version 2020-08-01-preview.

9 operations 9 paths 17 schemas 5 GET4 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 9

Across 9 paths, the API surfaces 9 operations — 5 GET, 4 POST. Each is listed below with its method, path, parameters, and response codes.

Documents 9
GET
/docs/$count
Microsoft Azure Get Docs $count
microsoftAzureDocumentsCount 2 params → 200
GET
/docs
Microsoft Azure Get Docs
microsoftAzureDocumentsSearchget 19 params → 200
POST
/docs/search.post.search
Microsoft Azure Post Docs Search Post Search
microsoftAzureDocumentsSearchpost 2 params body → 200
GET
/docs('{key}')
Microsoft Azure Get Docs Key
microsoftAzureDocumentsGet 4 params → 200
GET
/docs/search.suggest
Microsoft Azure Get Docs Search Suggest
microsoftAzureDocumentsSuggestget 13 params → 200
POST
/docs/search.post.suggest
Microsoft Azure Post Docs Search Post Suggest
microsoftAzureDocumentsSuggestpost 2 params body → 200
POST
/docs/search.index
Microsoft Azure Post Docs Search Index
microsoftAzureDocumentsIndex 2 params body → 200207
GET
/docs/search.autocomplete
Microsoft Azure Get Docs Search Autocomplete
microsoftAzureDocumentsAutocompleteget 12 params → 200
POST
/docs/search.post.autocomplete
Microsoft Azure Post Docs Search Post Autocomplete
microsoftAzureDocumentsAutocompletepost 2 params body → 200

Schemas 17

The contract defines 17 schemas that model the data the API accepts and returns. The most detailed are SearchRequest (17 properties), SuggestRequest (11 properties), AutocompleteRequest (10 properties), DocumentSearchResult (6 properties). Each schema is shown below with its type and property counts.

AutocompleteMode
string
Specifies the mode for Autocomplete. The default is 'oneTerm'. Use 'twoTerms' to get shingles and 'oneTermWithContext' to use the current context in producing…
IndexAction
object
Represents an index action that operates on a document.
1 property
SuggestResult
object
A result containing a document found by a suggestion query, plus associated metadata.
1 property
SearchMode
string
Specifies whether any or all of the search terms must be matched in order to count the document as a match.
SearchRequest
object
Parameters for filtering, sorting, faceting, paging, and other search query behaviors.
17 properties
IndexingResult
object
Status of an indexing operation for a single document.
4 properties
FacetResult
object
A single bucket of a facet query result. Reports the number of documents with a field value falling within a particular range or having a particular value or i…
1 property
IndexBatch
object
Contains a batch of document write actions to send to the Azure Search index.
1 property 1 required
SearchResult
object
Contains a document found by a search query, plus associated metadata.
2 properties
SuggestRequest
object
Parameters for filtering, sorting, fuzzy matching, and other suggestions query behaviors.
11 properties
DocumentSearchResult
object
Response containing search results from an Azure Search index.
6 properties
AutocompleteResult
object
The result of Autocomplete query.
1 property
AutocompleteItem
object
The result of Autocomplete requests.
2 properties
AutocompleteRequest
object
Parameters for fuzzy matching, and other autocomplete query behaviors.
10 properties
QueryType
string
Specifies the syntax of the search query. The default is 'simple'. Use 'full' if your query uses the Lucene query syntax.
DocumentIndexResult
object
Response containing the status of operations for all documents in the indexing request.
1 property
DocumentSuggestResult
object
Response containing suggestion query results from an Azure Search index.
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

microsoft-azure-documents-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 Documents 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.