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

The Knowledgebases API from Microsoft Azure — 6 operation(s) for knowledgebases.

Microsoft Azure Knowledgebases 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 Knowledge Bases. 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 10 operations across 6 paths, and defines 32 schemas. It is described by OpenAPI 3.2.0, at version 2020-08-01-preview.

10 operations 6 paths 32 schemas 1 DELETE3 GET1 PATCH4 POST1 PUT

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 10

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

Knowledgebases 10
GET
/knowledgebases
Microsoft Azure Gets All Knowledgebases For A User
microsoftAzureKnowledgebaseListall → 200default
GET
/knowledgebases/{kbId}
Microsoft Azure Gets Details Of A Specific Knowledgebase
microsoftAzureKnowledgebaseGetdetails 1 param → 200default
DELETE
/knowledgebases/{kbId}
Microsoft Azure Deletes The Knowledgebase And All Its Data
microsoftAzureKnowledgebaseDelete 1 param → 204default
POST
/knowledgebases/{kbId}
Microsoft Azure Publishes All Changes In Test Index Of A Knowledgebase To Its Prod Index
microsoftAzureKnowledgebasePublish 1 param → 204default
PUT
/knowledgebases/{kbId}
Microsoft Azure Replace Knowledgebase Contents
microsoftAzureKnowledgebaseReplace 2 params → 204default
PATCH
/knowledgebases/{kbId}
Microsoft Azure Asynchronous Operation To Modify A Knowledgebase
microsoftAzureKnowledgebaseUpdate 2 params → 202default
POST
/knowledgebases/create
Microsoft Azure Asynchronous Operation To Create A New Knowledgebase
microsoftAzureKnowledgebaseCreate 1 param → 202default
GET
/knowledgebases/{kbId}/{environment}/qna
Microsoft Azure Download The Knowledgebase
microsoftAzureKnowledgebaseDownload 4 params → 200default
POST
/knowledgebases/{kbId}/generateAnswer
Microsoft Azure Generateanswer Call To Query Knowledgebase Qna Maker Managed
microsoftAzureKnowledgebaseGenerateanswer 2 params → 200default
POST
/knowledgebases/{kbId}/train
Microsoft Azure Train Call To Add Suggestions To Knowledgebase Qnamaker Managed
microsoftAzureKnowledgebaseTrain 2 params → 204default

Schemas 32

The contract defines 32 schemas that model the data the API accepts and returns. The most detailed are QueryDTO (11 properties), CreateKbDTO (9 properties), KnowledgebaseDTO (9 properties), QnASearchResult (8 properties). Each schema is shown below with its type and property counts.

AnswerSpanRequestDTO
object
To configure Answer span prediction feature.
3 properties
QnADTO
object
Q-A object.
7 properties 2 required
Error
object
The error object. As per Microsoft One API guidelines - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md7102-error-condition-responses.
5 properties 1 required
QueryContextDTO
object
Context object with previous QnA's information.
2 properties
QueryDTO
object
POST body schema to query the knowledgebase.
11 properties
DeleteKbContentsDTO
object
PATCH body schema of Delete Operation in UpdateKb
2 properties
UpdateQuestionsDTO
object
PATCH Body schema for Update Kb which contains list of questions to be added and deleted
2 properties
Operation
object
Record to track long running operation.
7 properties
ErrorCode
string
Human readable error code.
MetadataDTO
object
Name - value pair of metadata.
2 properties 2 required
AnswerSpanResponseDTO
object
Answer span object of QnA.
4 properties
CreateKbInputDTO
object
Input to create KB.
3 properties
InnerErrorModel
object
An object containing more specific information about the error. As per Microsoft One API guidelines - https://github.com/Microsoft/api-guidelines/blob/vNext/Gu…
2 properties
UpdateContextDTO
object
Update Body schema to represent context to be updated
3 properties
FeedbackRecordDTO
object
Active learning feedback record.
3 properties
FileDTO
object
DTO to hold details of uploaded files.
2 properties 2 required
ContextDTO
object
Context associated with Qna.
2 properties
ReplaceKbDTO
object
Post body schema for Replace KB operation.
1 property 1 required
FeedbackRecordsDTO
object
Active learning feedback records.
1 property
KnowledgebasesDTO
object
Collection of knowledgebases owned by a user.
1 property
KnowledgebaseDTO
object
Response schema for CreateKb operation.
9 properties
UpdateKbContentsDTO
object
PATCH body schema for Update operation in Update Kb
4 properties
UpdateMetadataDTO
object
PATCH Body schema to represent list of Metadata to be updated
2 properties
ErrorResponse
object
Error response. As per Microsoft One API guidelines - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md7102-error-condition-responses.
1 property
CreateKbDTO
object
Post body schema for CreateKb operation.
9 properties 1 required
QnASearchResult
object
Represents Search Result.
8 properties
QnASearchResultList
object
Represents List of Question Answers.
1 property
QnADocumentsDTO
object
List of QnADTO
1 property
PromptDTO
object
Prompt for an answer.
4 properties
UpdateQnaDTO
object
PATCH Body schema for Update Qna List
6 properties
OperationState
string
Enumeration of operation states.
UpdateKbOperationDTO
object
Contains list of QnAs to be updated
5 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

microsoft-azure-knowledgebases-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 Knowledgebases 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.