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

The Authoring API from Microsoft Azure — 96 operation(s) for authoring.

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

113 operations 96 paths 171 schemas 8 DELETE68 GET5 PATCH27 POST5 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 113

Across 96 paths, the API surfaces 113 operations — 8 DELETE, 68 GET, 5 PATCH, 27 POST, 5 PUT. Each is listed below with its method, path, parameters, and response codes.

Authoring 113
GET
/authoring/analyze-conversations/projects
Microsoft Azure Get Authoring Analyze Conversations Projects
microsoftAzureConversationalanalysisauthoringListprojects 4 params → 200default
PATCH
/authoring/analyze-conversations/projects/{projectName}
Microsoft Azure Patch Authoring Analyze Conversations Projects Projectname
microsoftAzureConversationalanalysisauthoringCreateproject 2 params body → 200201default
GET
/authoring/analyze-conversations/projects/{projectName}
Microsoft Azure Get Authoring Analyze Conversations Projects Projectname
microsoftAzureConversationalanalysisauthoringGetproject 2 params → 200default
DELETE
/authoring/analyze-conversations/projects/{projectName}
Microsoft Azure Delete Authoring Analyze Conversations Projects Projectname
microsoftAzureConversationalanalysisauthoringDeleteproject 2 params → 202default
POST
/authoring/analyze-conversations/projects/{projectName}/:authorize-copy
Microsoft Azure Post Authoring Analyze Conversations Projects Projectname :authorize Copy
microsoftAzureConversationalanalysisauthoringCopyprojectauthorization 2 params body → 200default
POST
/authoring/analyze-conversations/projects/{projectName}/:copy
Microsoft Azure Post Authoring Analyze Conversations Projects Projectname :copy
microsoftAzureConversationalanalysisauthoringCopyproject 2 params body → 202default
POST
/authoring/analyze-conversations/projects/{projectName}/:export
Microsoft Azure Post Authoring Analyze Conversations Projects Projectname :export
microsoftAzureConversationalanalysisauthoringExport 6 params → 202default
POST
/authoring/analyze-conversations/projects/{projectName}/:import
Microsoft Azure Post Authoring Analyze Conversations Projects Projectname :import
microsoftAzureConversationalanalysisauthoringImport 3 params body → 202default
POST
/authoring/analyze-conversations/projects/{projectName}/:train
Microsoft Azure Post Authoring Analyze Conversations Projects Projectname :train
microsoftAzureConversationalanalysisauthoringTrain 2 params body → 202default
GET
/authoring/analyze-conversations/projects/{projectName}/copy/jobs/{jobId}
Microsoft Azure Get Authoring Analyze Conversations Projects Projectname Copy Jobs Jobid
microsoftAzureConversationalanalysisauthoringGetcopyprojectstatus 3 params → 200default
GET
/authoring/analyze-conversations/projects/{projectName}/deployments
Microsoft Azure Get Authoring Analyze Conversations Projects Projectname Deployments
microsoftAzureConversationalanalysisauthoringListdeployments 5 params → 200default
POST
/authoring/analyze-conversations/projects/{projectName}/deployments/:swap
Microsoft Azure Post Authoring Analyze Conversations Projects Projectname Deployments :swap
microsoftAzureConversationalanalysisauthoringSwapdeployments 2 params body → 202default
GET
/authoring/analyze-conversations/projects/{projectName}/deployments/{deploymentName}
Microsoft Azure Get Authoring Analyze Conversations Projects Projectname Deployments Deploymentname
microsoftAzureConversationalanalysisauthoringGetdeployment 3 params → 200default
PUT
/authoring/analyze-conversations/projects/{projectName}/deployments/{deploymentName}
Microsoft Azure Put Authoring Analyze Conversations Projects Projectname Deployments Deploymentname
microsoftAzureConversationalanalysisauthoringDeployproject 3 params body → 202default
DELETE
/authoring/analyze-conversations/projects/{projectName}/deployments/{deploymentName}
Microsoft Azure Delete Authoring Analyze Conversations Projects Projectname Deployments Deploymentname
microsoftAzureConversationalanalysisauthoringDeletedeployment 3 params → 202default
POST
/authoring/analyze-conversations/projects/{projectName}/deployments/{deploymentName}/:delete-from-resources
Microsoft Azure Post Authoring Analyze Conversations Projects Projectname Deployments Deploymentname :delete From Resources
microsoftAzureConversationalanalysisauthoringDeletedeploymentfromresources 3 params body → 202default
GET
/authoring/analyze-conversations/projects/{projectName}/deployments/{deploymentName}/delete-from-resources/jobs/{jobId}
Microsoft Azure Get Authoring Analyze Conversations Projects Projectname Deployments Deploymentname Delete From Resources Jobs Jobid
microsoftAzureConversationalanalysisauthoringGetdeploymentdeletefromresourcesstatus 4 params → 200default
GET
/authoring/analyze-conversations/projects/{projectName}/deployments/{deploymentName}/jobs/{jobId}
Microsoft Azure Get Authoring Analyze Conversations Projects Projectname Deployments Deploymentname Jobs Jobid
microsoftAzureConversationalanalysisauthoringGetdeploymentstatus 4 params → 200default
GET
/authoring/analyze-conversations/projects/{projectName}/deployments/swap/jobs/{jobId}
Microsoft Azure Get Authoring Analyze Conversations Projects Projectname Deployments Swap Jobs Jobid
microsoftAzureConversationalanalysisauthoringGetswapdeploymentsstatus 3 params → 200default
GET
/authoring/analyze-conversations/projects/{projectName}/export/jobs/{jobId}
Microsoft Azure Get Authoring Analyze Conversations Projects Projectname Export Jobs Jobid
microsoftAzureConversationalanalysisauthoringGetexportstatus 3 params → 200default
GET
/authoring/analyze-conversations/projects/{projectName}/import/jobs/{jobId}
Microsoft Azure Get Authoring Analyze Conversations Projects Projectname Import Jobs Jobid
microsoftAzureConversationalanalysisauthoringGetimportstatus 3 params → 200default
GET
/authoring/analyze-conversations/projects/{projectName}/models
Microsoft Azure Get Authoring Analyze Conversations Projects Projectname Models
microsoftAzureConversationalanalysisauthoringListtrainedmodels 5 params → 200default
GET
/authoring/analyze-conversations/projects/{projectName}/models/{trainedModelLabel}
Microsoft Azure Get Authoring Analyze Conversations Projects Projectname Models Trainedmodellabel
microsoftAzureConversationalanalysisauthoringGettrainedmodel 3 params → 200default
DELETE
/authoring/analyze-conversations/projects/{projectName}/models/{trainedModelLabel}
Microsoft Azure Delete Authoring Analyze Conversations Projects Projectname Models Trainedmodellabel
microsoftAzureConversationalanalysisauthoringDeletetrainedmodel 3 params → 204default
POST
/authoring/analyze-conversations/projects/{projectName}/models/{trainedModelLabel}/:evaluate
Microsoft Azure Post Authoring Analyze Conversations Projects Projectname Models Trainedmodellabel :evaluate
microsoftAzureConversationalanalysisauthoringEvaluatemodel 3 params body → 202default
POST
/authoring/analyze-conversations/projects/{projectName}/models/{trainedModelLabel}/:load-snapshot
Microsoft Azure Post Authoring Analyze Conversations Projects Projectname Models Trainedmodellabel :load Snapshot
microsoftAzureConversationalanalysisauthoringLoadsnapshot 3 params → 202default
GET
/authoring/analyze-conversations/projects/{projectName}/models/{trainedModelLabel}/evaluate/jobs/{jobId}
Microsoft Azure Get Authoring Analyze Conversations Projects Projectname Models Trainedmodellabel Evaluate Jobs Jobid
microsoftAzureConversationalanalysisauthoringGetevaluationstatus 4 params → 200default
GET
/authoring/analyze-conversations/projects/{projectName}/models/{trainedModelLabel}/evaluation/result
Microsoft Azure Get Authoring Analyze Conversations Projects Projectname Models Trainedmodellabel Evaluation Result
microsoftAzureConversationalanalysisauthoringGetmodelevaluationresults 7 params → 200default
GET
/authoring/analyze-conversations/projects/{projectName}/models/{trainedModelLabel}/evaluation/summary-result
Microsoft Azure Get Authoring Analyze Conversations Projects Projectname Models Trainedmodellabel Evaluation Summary Result
microsoftAzureConversationalanalysisauthoringGetmodelevaluationsummary 3 params → 200default
GET
/authoring/analyze-conversations/projects/{projectName}/models/{trainedModelLabel}/load-snapshot/jobs/{jobId}
Microsoft Azure Get Authoring Analyze Conversations Projects Projectname Models Trainedmodellabel Load Snapshot Jobs Jobid
microsoftAzureConversationalanalysisauthoringGetloadsnapshotstatus 4 params → 200default
GET
/authoring/analyze-conversations/projects/{projectName}/resources
Microsoft Azure Get Authoring Analyze Conversations Projects Projectname Resources
microsoftAzureConversationalanalysisauthoringListdeploymentresources 5 params → 200default
POST
/authoring/analyze-conversations/projects/{projectName}/resources/:assign
Microsoft Azure Post Authoring Analyze Conversations Projects Projectname Resources :assign
microsoftAzureConversationalanalysisauthoringAssigndeploymentresources 2 params body → 202default
POST
/authoring/analyze-conversations/projects/{projectName}/resources/:unassign
Microsoft Azure Post Authoring Analyze Conversations Projects Projectname Resources :unassign
microsoftAzureConversationalanalysisauthoringUnassigndeploymentresources 2 params body → 202default
GET
/authoring/analyze-conversations/projects/{projectName}/resources/assign/jobs/{jobId}
Microsoft Azure Get Authoring Analyze Conversations Projects Projectname Resources Assign Jobs Jobid
microsoftAzureConversationalanalysisauthoringGetassigndeploymentresourcesstatus 3 params → 200default
GET
/authoring/analyze-conversations/projects/{projectName}/resources/unassign/jobs/{jobId}
Microsoft Azure Get Authoring Analyze Conversations Projects Projectname Resources Unassign Jobs Jobid
microsoftAzureConversationalanalysisauthoringGetunassigndeploymentresourcesstatus 3 params → 200default
GET
/authoring/analyze-conversations/projects/{projectName}/train/jobs
Microsoft Azure Get Authoring Analyze Conversations Projects Projectname Train Jobs
microsoftAzureConversationalanalysisauthoringListtrainingjobs 5 params → 200default
GET
/authoring/analyze-conversations/projects/{projectName}/train/jobs/{jobId}
Microsoft Azure Get Authoring Analyze Conversations Projects Projectname Train Jobs Jobid
microsoftAzureConversationalanalysisauthoringGettrainingstatus 3 params → 200default
POST
/authoring/analyze-conversations/projects/{projectName}/train/jobs/{jobId}/:cancel
Microsoft Azure Post Authoring Analyze Conversations Projects Projectname Train Jobs Jobid :cancel
microsoftAzureConversationalanalysisauthoringCanceltrainingjob 3 params → 202default
GET
/authoring/analyze-conversations/projects/global/deletion-jobs/{jobId}
Microsoft Azure Get Authoring Analyze Conversations Projects Global Deletion Jobs Jobid
microsoftAzureConversationalanalysisauthoringGetprojectdeletionstatus 2 params → 200default
GET
/authoring/analyze-conversations/projects/global/deployments/resources
Microsoft Azure Get Authoring Analyze Conversations Projects Global Deployments Resources
microsoftAzureConversationalanalysisauthoringListassignedresourcedeployments 4 params → 200default
GET
/authoring/analyze-conversations/projects/global/languages
Microsoft Azure Get Authoring Analyze Conversations Projects Global Languages
microsoftAzureConversationalanalysisauthoringGetsupportedlanguages 5 params → 200default
GET
/authoring/analyze-conversations/projects/global/prebuilt-entities
Microsoft Azure Get Authoring Analyze Conversations Projects Global Prebuilt Entities
microsoftAzureConversationalanalysisauthoringGetsupportedprebuiltentities 6 params → 200default
GET
/authoring/analyze-conversations/projects/global/training-config-versions
Microsoft Azure Get Authoring Analyze Conversations Projects Global Training Config Versions
microsoftAzureConversationalanalysisauthoringListtrainingconfigversions 5 params → 200default
GET
/authoring/analyze-text/projects
Microsoft Azure Get Authoring Analyze Text Projects
microsoftAzureTextanalysisauthoringListprojects 4 params → 200default
PATCH
/authoring/analyze-text/projects/{projectName}
Microsoft Azure Patch Authoring Analyze Text Projects Projectname
microsoftAzureTextanalysisauthoringCreateproject 2 params body → 200201default
GET
/authoring/analyze-text/projects/{projectName}
Microsoft Azure Get Authoring Analyze Text Projects Projectname
microsoftAzureTextanalysisauthoringGetproject 2 params → 200default
DELETE
/authoring/analyze-text/projects/{projectName}
Microsoft Azure Delete Authoring Analyze Text Projects Projectname
microsoftAzureTextanalysisauthoringDeleteproject 2 params → 202default
POST
/authoring/analyze-text/projects/{projectName}/:authorize-copy
Microsoft Azure Post Authoring Analyze Text Projects Projectname :authorize Copy
microsoftAzureTextanalysisauthoringCopyprojectauthorization 2 params body → 200default
POST
/authoring/analyze-text/projects/{projectName}/:copy
Microsoft Azure Post Authoring Analyze Text Projects Projectname :copy
microsoftAzureTextanalysisauthoringCopyproject 2 params body → 202default
POST
/authoring/analyze-text/projects/{projectName}/:export
Microsoft Azure Post Authoring Analyze Text Projects Projectname :export
microsoftAzureTextanalysisauthoringExport 5 params → 202default
POST
/authoring/analyze-text/projects/{projectName}/:import
Microsoft Azure Post Authoring Analyze Text Projects Projectname :import
microsoftAzureTextanalysisauthoringImport 3 params body → 202default
POST
/authoring/analyze-text/projects/{projectName}/:train
Microsoft Azure Post Authoring Analyze Text Projects Projectname :train
microsoftAzureTextanalysisauthoringTrain 2 params body → 202default
GET
/authoring/analyze-text/projects/{projectName}/copy/jobs/{jobId}
Microsoft Azure Get Authoring Analyze Text Projects Projectname Copy Jobs Jobid
microsoftAzureTextanalysisauthoringGetcopyprojectstatus 3 params → 200default
GET
/authoring/analyze-text/projects/{projectName}/deployments
Microsoft Azure Get Authoring Analyze Text Projects Projectname Deployments
microsoftAzureTextanalysisauthoringListdeployments 5 params → 200default
POST
/authoring/analyze-text/projects/{projectName}/deployments/:swap
Microsoft Azure Post Authoring Analyze Text Projects Projectname Deployments :swap
microsoftAzureTextanalysisauthoringSwapdeployments 2 params body → 202default
GET
/authoring/analyze-text/projects/{projectName}/deployments/{deploymentName}
Microsoft Azure Get Authoring Analyze Text Projects Projectname Deployments Deploymentname
microsoftAzureTextanalysisauthoringGetdeployment 3 params → 200default
PUT
/authoring/analyze-text/projects/{projectName}/deployments/{deploymentName}
Microsoft Azure Put Authoring Analyze Text Projects Projectname Deployments Deploymentname
microsoftAzureTextanalysisauthoringDeployproject 3 params body → 202default
DELETE
/authoring/analyze-text/projects/{projectName}/deployments/{deploymentName}
Microsoft Azure Delete Authoring Analyze Text Projects Projectname Deployments Deploymentname
microsoftAzureTextanalysisauthoringDeletedeployment 3 params → 202default
POST
/authoring/analyze-text/projects/{projectName}/deployments/{deploymentName}/:delete-from-resources
Microsoft Azure Post Authoring Analyze Text Projects Projectname Deployments Deploymentname :delete From Resources
microsoftAzureTextanalysisauthoringDeletedeploymentfromresources 3 params body → 202default
GET
/authoring/analyze-text/projects/{projectName}/deployments/{deploymentName}/delete-from-resources/jobs/{jobId}
Microsoft Azure Get Authoring Analyze Text Projects Projectname Deployments Deploymentname Delete From Resources Jobs Jobid
microsoftAzureTextanalysisauthoringGetdeploymentdeletefromresourcesstatus 4 params → 200default
GET
/authoring/analyze-text/projects/{projectName}/deployments/{deploymentName}/jobs/{jobId}
Microsoft Azure Get Authoring Analyze Text Projects Projectname Deployments Deploymentname Jobs Jobid
microsoftAzureTextanalysisauthoringGetdeploymentstatus 4 params → 200default
GET
/authoring/analyze-text/projects/{projectName}/deployments/swap/jobs/{jobId}
Microsoft Azure Get Authoring Analyze Text Projects Projectname Deployments Swap Jobs Jobid
microsoftAzureTextanalysisauthoringGetswapdeploymentsstatus 3 params → 200default
GET
/authoring/analyze-text/projects/{projectName}/export/jobs/{jobId}
Microsoft Azure Get Authoring Analyze Text Projects Projectname Export Jobs Jobid
microsoftAzureTextanalysisauthoringGetexportstatus 3 params → 200default
GET
/authoring/analyze-text/projects/{projectName}/exported-models
Microsoft Azure Get Authoring Analyze Text Projects Projectname Exported Models
microsoftAzureTextanalysisauthoringListexportedmodels 5 params → 200default
GET
/authoring/analyze-text/projects/{projectName}/exported-models/{exportedModelName}
Microsoft Azure Get Authoring Analyze Text Projects Projectname Exported Models Exportedmodelname
microsoftAzureTextanalysisauthoringGetexportedmodel 3 params → 200default
DELETE
/authoring/analyze-text/projects/{projectName}/exported-models/{exportedModelName}
Microsoft Azure Delete Authoring Analyze Text Projects Projectname Exported Models Exportedmodelname
microsoftAzureTextanalysisauthoringDeleteexportedmodel 3 params → 202default
PUT
/authoring/analyze-text/projects/{projectName}/exported-models/{exportedModelName}
Microsoft Azure Put Authoring Analyze Text Projects Projectname Exported Models Exportedmodelname
microsoftAzureTextanalysisauthoringCreateorupdateexportedmodel 3 params body → 202default
GET
/authoring/analyze-text/projects/{projectName}/exported-models/{exportedModelName}/jobs/{jobId}
Microsoft Azure Get Authoring Analyze Text Projects Projectname Exported Models Exportedmodelname Jobs Jobid
microsoftAzureTextanalysisauthoringGetexportedmodeljobstatus 4 params → 200default
GET
/authoring/analyze-text/projects/{projectName}/exported-models/{exportedModelName}/manifest
Microsoft Azure Get Authoring Analyze Text Projects Projectname Exported Models Exportedmodelname Manifest
microsoftAzureTextanalysisauthoringGetexportedmodelmanifest 3 params → 200default
GET
/authoring/analyze-text/projects/{projectName}/import/jobs/{jobId}
Microsoft Azure Get Authoring Analyze Text Projects Projectname Import Jobs Jobid
microsoftAzureTextanalysisauthoringGetimportstatus 3 params → 200default
GET
/authoring/analyze-text/projects/{projectName}/models
Microsoft Azure Get Authoring Analyze Text Projects Projectname Models
microsoftAzureTextanalysisauthoringListtrainedmodels 5 params → 200default
GET
/authoring/analyze-text/projects/{projectName}/models/{trainedModelLabel}
Microsoft Azure Get Authoring Analyze Text Projects Projectname Models Trainedmodellabel
microsoftAzureTextanalysisauthoringGettrainedmodel 3 params → 200default
DELETE
/authoring/analyze-text/projects/{projectName}/models/{trainedModelLabel}
Microsoft Azure Delete Authoring Analyze Text Projects Projectname Models Trainedmodellabel
microsoftAzureTextanalysisauthoringDeletetrainedmodel 3 params → 204default
POST
/authoring/analyze-text/projects/{projectName}/models/{trainedModelLabel}/:evaluate
Microsoft Azure Post Authoring Analyze Text Projects Projectname Models Trainedmodellabel :evaluate
microsoftAzureTextanalysisauthoringEvaluatemodel 3 params body → 202default
POST
/authoring/analyze-text/projects/{projectName}/models/{trainedModelLabel}/:load-snapshot
Microsoft Azure Post Authoring Analyze Text Projects Projectname Models Trainedmodellabel :load Snapshot
microsoftAzureTextanalysisauthoringLoadsnapshot 3 params → 202default
GET
/authoring/analyze-text/projects/{projectName}/models/{trainedModelLabel}/evaluate/jobs/{jobId}
Microsoft Azure Get Authoring Analyze Text Projects Projectname Models Trainedmodellabel Evaluate Jobs Jobid
microsoftAzureTextanalysisauthoringGetevaluationstatus 4 params → 200default
GET
/authoring/analyze-text/projects/{projectName}/models/{trainedModelLabel}/evaluation/result
Microsoft Azure Get Authoring Analyze Text Projects Projectname Models Trainedmodellabel Evaluation Result
microsoftAzureTextanalysisauthoringGetmodelevaluationresults 7 params → 200default
GET
/authoring/analyze-text/projects/{projectName}/models/{trainedModelLabel}/evaluation/summary-result
Microsoft Azure Get Authoring Analyze Text Projects Projectname Models Trainedmodellabel Evaluation Summary Result
microsoftAzureTextanalysisauthoringGetmodelevaluationsummary 3 params → 200default
GET
/authoring/analyze-text/projects/{projectName}/models/{trainedModelLabel}/load-snapshot/jobs/{jobId}
Microsoft Azure Get Authoring Analyze Text Projects Projectname Models Trainedmodellabel Load Snapshot Jobs Jobid
microsoftAzureTextanalysisauthoringGetloadsnapshotstatus 4 params → 200default
GET
/authoring/analyze-text/projects/{projectName}/resources
Microsoft Azure Get Authoring Analyze Text Projects Projectname Resources
microsoftAzureTextanalysisauthoringListdeploymentresources 5 params → 200default
POST
/authoring/analyze-text/projects/{projectName}/resources/:assign
Microsoft Azure Post Authoring Analyze Text Projects Projectname Resources :assign
microsoftAzureTextanalysisauthoringAssigndeploymentresources 2 params body → 202default
POST
/authoring/analyze-text/projects/{projectName}/resources/:unassign
Microsoft Azure Post Authoring Analyze Text Projects Projectname Resources :unassign
microsoftAzureTextanalysisauthoringUnassigndeploymentresources 2 params body → 202default
GET
/authoring/analyze-text/projects/{projectName}/resources/assign/jobs/{jobId}
Microsoft Azure Get Authoring Analyze Text Projects Projectname Resources Assign Jobs Jobid
microsoftAzureTextanalysisauthoringGetassigndeploymentresourcesstatus 3 params → 200default
GET
/authoring/analyze-text/projects/{projectName}/resources/unassign/jobs/{jobId}
Microsoft Azure Get Authoring Analyze Text Projects Projectname Resources Unassign Jobs Jobid
microsoftAzureTextanalysisauthoringGetunassigndeploymentresourcesstatus 3 params → 200default
GET
/authoring/analyze-text/projects/{projectName}/train/jobs
Microsoft Azure Get Authoring Analyze Text Projects Projectname Train Jobs
microsoftAzureTextanalysisauthoringListtrainingjobs 5 params → 200default
GET
/authoring/analyze-text/projects/{projectName}/train/jobs/{jobId}
Microsoft Azure Get Authoring Analyze Text Projects Projectname Train Jobs Jobid
microsoftAzureTextanalysisauthoringGettrainingstatus 3 params → 200default
POST
/authoring/analyze-text/projects/{projectName}/train/jobs/{jobId}/:cancel
Microsoft Azure Post Authoring Analyze Text Projects Projectname Train Jobs Jobid :cancel
microsoftAzureTextanalysisauthoringCanceltrainingjob 3 params → 202default
GET
/authoring/analyze-text/projects/global/deletion-jobs/{jobId}
Microsoft Azure Get Authoring Analyze Text Projects Global Deletion Jobs Jobid
microsoftAzureTextanalysisauthoringGetprojectdeletionstatus 2 params → 200default
GET
/authoring/analyze-text/projects/global/deployments/resources
Microsoft Azure Get Authoring Analyze Text Projects Global Deployments Resources
microsoftAzureTextanalysisauthoringListassignedresourcedeployments 4 params → 200default
GET
/authoring/analyze-text/projects/global/languages
Microsoft Azure Get Authoring Analyze Text Projects Global Languages
microsoftAzureTextanalysisauthoringGetsupportedlanguages 5 params → 200default
GET
/authoring/analyze-text/projects/global/prebuilt-entities
Microsoft Azure Get Authoring Analyze Text Projects Global Prebuilt Entities
microsoftAzureTextanalysisauthoringGetsupportedprebuiltentities 7 params → 200default
GET
/authoring/analyze-text/projects/global/training-config-versions
Microsoft Azure Get Authoring Analyze Text Projects Global Training Config Versions
microsoftAzureTextanalysisauthoringListtrainingconfigversions 5 params → 200default
GET
/authoring/query-knowledgebases/projects
Microsoft Azure Gets All Projects For A User
microsoftAzureQuestionansweringprojectsListprojects 4 params → 200default
GET
/authoring/query-knowledgebases/projects/{projectName}
Microsoft Azure Get The Requested Project Metadata
microsoftAzureQuestionansweringprojectsGetprojectdetails 2 params → 200default
PATCH
/authoring/query-knowledgebases/projects/{projectName}
Microsoft Azure Create Or Update A Project
microsoftAzureQuestionansweringprojectsCreateproject 2 params body → 200201default
DELETE
/authoring/query-knowledgebases/projects/{projectName}
Microsoft Azure Delete The Project
microsoftAzureQuestionansweringprojectsDeleteproject 2 params → 202default
GET
/authoring/query-knowledgebases/projects/deletion-jobs/{jobId}
Microsoft Azure Gets The Status Of A Project Delete Job
microsoftAzureQuestionansweringprojectsGetdeletestatus 2 params → 200default
POST
/authoring/query-knowledgebases/projects/{projectName}/:export
Microsoft Azure Export Project Metadata And Assets
microsoftAzureQuestionansweringprojectsExport 4 params → 200202default
GET
/authoring/query-knowledgebases/projects/{projectName}/export/jobs/{jobId}
Microsoft Azure Gets The Status Of An Export Job, Once Job Completes, Returns The Project Metadata, And Assets
microsoftAzureQuestionansweringprojectsGetexportstatus 3 params → 200default
POST
/authoring/query-knowledgebases/projects/{projectName}/:import
Microsoft Azure Import Project Assets
microsoftAzureQuestionansweringprojectsImport 4 params body → 202default
GET
/authoring/query-knowledgebases/projects/{projectName}/import/jobs/{jobId}
Microsoft Azure Gets The Status Of An Import Job
microsoftAzureQuestionansweringprojectsGetimportstatus 3 params → 200default
PUT
/authoring/query-knowledgebases/projects/{projectName}/deployments/{deploymentName}
Microsoft Azure Deploy Project To Production
microsoftAzureQuestionansweringprojectsDeployproject 3 params → 202default
GET
/authoring/query-knowledgebases/projects/{projectName}/deployments/{deploymentName}/jobs/{jobId}
Microsoft Azure Gets The Status Of A Deploy Job
microsoftAzureQuestionansweringprojectsGetdeploystatus 4 params → 200default
GET
/authoring/query-knowledgebases/projects/{projectName}/deployments
Microsoft Azure List All Deployments Of A Project
microsoftAzureQuestionansweringprojectsListdeployments 5 params → 200default
GET
/authoring/query-knowledgebases/projects/{projectName}/synonyms
Microsoft Azure Gets All The Synonyms Of A Project
microsoftAzureQuestionansweringprojectsGetsynonyms 5 params → 200default
PUT
/authoring/query-knowledgebases/projects/{projectName}/synonyms
Microsoft Azure Updates All The Synonyms Of A Project
microsoftAzureQuestionansweringprojectsUpdatesynonyms 2 params body → 204default
GET
/authoring/query-knowledgebases/projects/{projectName}/sources
Microsoft Azure Gets All The Sources Of A Project
microsoftAzureQuestionansweringprojectsGetsources 5 params → 200default
PATCH
/authoring/query-knowledgebases/projects/{projectName}/sources
Microsoft Azure Updates The Sources Of A Project
microsoftAzureQuestionansweringprojectsUpdatesources 2 params body → 202default
GET
/authoring/query-knowledgebases/projects/{projectName}/sources/jobs/{jobId}
Microsoft Azure Gets The Status Of Update Sources Job
microsoftAzureQuestionansweringprojectsGetupdatesourcesstatus 3 params → 200default
GET
/authoring/query-knowledgebases/projects/{projectName}/qnas
Microsoft Azure Gets All The Qnas Of A Project
microsoftAzureQuestionansweringprojectsGetqnas 6 params → 200default
PATCH
/authoring/query-knowledgebases/projects/{projectName}/qnas
Microsoft Azure Updates The Qnas Of A Project
microsoftAzureQuestionansweringprojectsUpdateqnas 2 params body → 202default
GET
/authoring/query-knowledgebases/projects/{projectName}/qnas/jobs/{jobId}
Microsoft Azure Gets The Status Of Update Qnas Job
microsoftAzureQuestionansweringprojectsGetupdateqnasstatus 3 params → 200default
POST
/authoring/query-knowledgebases/projects/{projectName}/feedback
Microsoft Azure Update Active Learning Feedback
microsoftAzureQuestionansweringprojectsAddfeedback 2 params body → 204default

Schemas 171

The contract defines 171 schemas that model the data the API accepts and returns. The most detailed are ConversationalAnalysisAuthoringProjectMetadata (11 properties), TextAnalysisAuthoringProjectMetadata (11 properties), ConversationalAnalysisAuthoringEntitiesEvaluationSummary (8 properties), ProjectMetadata (8 properties). Each schema is shown below with its type and property counts.

TextAnalysisAuthoringModelFile
object
Represents the properties for the model file.
2 properties 2 required
WordAlterations
object
Collection of word alterations.
1 property 1 required
TextAnalysisAuthoringResourceMetadata
object
Represents metadata for the Azure resource..
3 properties 3 required
TextAnalysisAuthoringAssignedResourceDeploymentsMetadata
object
Represents the metadata for deployments assigned to a resource.
2 properties 2 required
TextAnalysisAuthoringAssignedProjectDeploymentsMetadata
object
Represents the metadata for assigned deployments for a project.
2 properties 2 required
TextAnalysisAuthoringWarning
object
Represents a warning that was encountered while executing the request.
2 properties 2 required
TextAnalysisAuthoringDeploymentResource
object
Represents an Azure resource assigned to a deployment.
2 properties 2 required
ConversationalAnalysisAuthoringEvaluationKind
string
TextAnalysisAuthoringExportedModelManifest
object
Represents the properties for the exported model manifest.
1 property 1 required
TextAnalysisAuthoringCopyAuthorizationOptions
object
Represents the options for authorizing a project copy to the current Azure resource.
3 properties 1 required
TextAnalysisAuthoringExportedProjectAssets
object
Represents the assets of an exported project.
1 property 1 required
TextAnalysisAuthoringSwapDeploymentsOptions
object
Represents the options for swapping two deployments together.
2 properties 2 required
ConversationalAnalysisAuthoringCopyProjectOptions
object
Represents the options for copying an existing project to another Azure resource.
6 properties 6 required
ConversationalAnalysisAuthoringProjectDeletionJobState
object
Represents the state of a project deletion job.
SynonymAsset
array
Collection of synonyms.
ConversationalAnalysisAuthoringDeploymentJobState
object
Represents the state of a deployment job.
TextAnalysisAuthoringProjectKind
string
ConversationalAnalysisAuthoringTrainingMode
string
RetrieveQnaRecord
QnA Record with last updated date-time.
SourceDisplayNameParameter
object
1 property
TextAnalysisAuthoringProjectDeletionJobState
object
Represents the state of a project deletion job.
QnaSourceMetadata
object
Input source file or url details.
5 properties 3 required
TextAnalysisAuthoringProjectsMetadata
object
Represents a list of retrieved projects' metadata.
2 properties 2 required
ConversationalAnalysisAuthoringEntityEvaluationSummary
object
Represents the evaluation result for an entity.
7 properties 7 required
ConversationalAnalysisAuthoringTrainingJobs
object
Represents a list of retrieved training jobs.
2 properties 2 required
ConversationalAnalysisAuthoringProjectsMetadata
object
Represents a list of retrieved projects' metadata.
2 properties 2 required
FeedbackRecord
object
Feedback Record for Active Learning.
3 properties
ConversationalAnalysisAuthoringExportProjectJobState
object
Represents the state of an export job.
1 property
TextAnalysisAuthoringTrainingConfigVersions
object
Represents a list of training config versions.
2 properties 2 required
ExportJobState
Export job status, project metadata, and assets.
Assets
object
All assets for this project.
2 properties
SuggestedQuestion
object
Question suggested by the Active Learning feature.
3 properties
TextAnalysisAuthoringJobStatus
string
ProjectMetadata
object
Represents the project.
8 properties
TextAnalysisAuthoringStringIndexType
string
ConversationalAnalysisAuthoringProjectTrainedModels
object
Represents a list of retrieved trained models.
2 properties 2 required
ConversationalAnalysisAuthoringDeploymentResource
object
Represents an Azure resource assigned to a deployment.
2 properties 2 required
ConversationalAnalysisAuthoringSwapDeploymentsOptions
object
Represents the options for swapping two deployments together.
2 properties 2 required
TextAnalysisAuthoringLoadSnapshotJobState
object
Represents the state of loading a snapshot job.
LastUpdatedDateTimeParameter
object
Last updated date-time parameter.
1 property
TextAnalysisAuthoringProjectSettings
object
Represents the settings used to define the project behavior.
5 properties
TextAnalysisAuthoringCopyProjectOptions
object
Represents the options for copying an existing project to another Azure resource.
6 properties 6 required
ConversationalAnalysisAuthoringDeploymentResourcesJobState
object
Represents the state of a deployment resources job.
QnaSourceKind
string
Supported source types.
ConversationalAnalysisAuthoringAssignedDeploymentResources
object
Represents the assigned deployment resources.
2 properties 2 required
SynonymAssets
object
All synonym assets for this project.
2 properties
TextAnalysisAuthoringExportedTrainedModels
object
Represents a list of exported trained models.
2 properties 2 required
ConversationalAnalysisAuthoringAssignedProjectDeploymentMetadata
object
Represents the metadata for an assigned deployment
3 properties 3 required
TextAnalysisAuthoringProjectMetadata
object
Represents the metadata of a project.
11 properties 6 required
TextAnalysisAuthoringProjectDeployments
object
Represents a list of retrieved deployments.
2 properties 2 required
UpdateQnaRecord
object
QnA record to be updated.
2 properties 2 required
TextAnalysisAuthoringEvaluationJobResult
object
4 properties 4 required
UpdateSourcesOptions
array
A list of sources to be updated.
JobState
Job state represents the job metadata and any errors.
ConversationalAnalysisAuthoringProjectMetadata
object
Represents the metadata of a project.
11 properties 5 required
QnaDialog
object
Dialog associated with QnA Record.
2 properties
TextAnalysisAuthoringProjectTrainedModel
object
Represents a trained model.
7 properties 7 required
ConversationalAnalysisAuthoringEvaluationResults
object
Represent a list of utterances' evaluation results.
2 properties 2 required
TextAnalysisAuthoringPrebuiltEntity
object
Represents a supported prebuilt entity.
3 properties 3 required
ProjectDeploymentsList
array
List of deployments of a project.
TextAnalysisAuthoringExportedModelJobState
object
Represents the state of a job to create or updated an exported model.
ProjectDeployments
object
All deployments of a project.
2 properties
ConversationalAnalysisAuthoringEvaluationJobResult
object
4 properties 4 required
TextAnalysisAuthoringProjectTrainedModels
object
Represents a list of retrieved trained models.
2 properties 2 required
ConversationalAnalysisAuthoringSupportedLanguages
object
Represents a list of retrieved languages.
2 properties 2 required
SuggestedQuestionsCluster
object
Active Learning suggested questions cluster details.
2 properties
ConversationalAnalysisAuthoringEntitiesEvaluationSummary
object
Represents the evaluation result summary for the project's entities.
8 properties 8 required
ConversationalAnalysisAuthoringCopyProjectJobState
object
Represents the state of a copy job.
FeedbackRecords
array
A list of Feedback Records for Active Learning.
ConversationalAnalysisAuthoringProjectSettings
object
Represents the settings used to define the project behavior.
1 property 1 required
ConversationalAnalysisAuthoringIntentsEvaluationSummary
object
Represents the evaluation summary for the project's intents.
8 properties 8 required
QnaRecord
object
QnA record.
7 properties
ConversationalAnalysisAuthoringEvaluationOptions
object
Represents the options used running the evaluation.
3 properties
TextAnalysisAuthoringAssignedDeploymentResource
object
Represents the assigned deployment resource.
2 properties 2 required
ConversationalAnalysisAuthoringAssignDeploymentResourcesOptions
object
Represents the options for assigning Azure resources to a project.
1 property 1 required
TextAnalysisAuthoringDocumentEvaluationResult
object
Represents the evaluation result of a document.
3 properties 3 required
TextAnalysisAuthoringTrainingJobs
object
Represents a list of retrieved training jobs.
2 properties 2 required
ConversationalAnalysisAuthoringImportProjectJobState
object
Represents the state of an import job.
TextAnalysisAuthoringAssignedProjectDeploymentMetadata
object
Represents the metadata for an assigned deployment
3 properties 3 required
TextAnalysisAuthoringAssignedDeploymentResources
object
Represents the assigned deployment resources.
2 properties 2 required
ExportJobResultUrl
object
URL to download the result of the Export Job.
1 property 1 required
ImportQnaAsset
array
List of QnA records to import.
ConversationalAnalysisAuthoringAssignedProjectDeploymentsMetadata
object
Represents the metadata for assigned deployments for a project.
2 properties 2 required
TextAnalysisAuthoringTrainingJobResult
object
Represents the output of a training job.
5 properties 3 required
TextAnalysisAuthoringSupportedLanguages
object
Represents a list of retrieved languages.
2 properties 2 required
ConversationalAnalysisAuthoringJobState
object
Represents a job's state.
7 properties 4 required
TextAnalysisAuthoringSupportedLanguage
object
Represents a supported language.
2 properties 2 required
ConversationalAnalysisAuthoringWarning
object
Represents a warning that was encountered while executing the request.
2 properties 2 required
ConversationalAnalysisAuthoringTrainingJobResult
object
Represents the output of a training job.
6 properties 3 required
TextAnalysisAuthoringCopyProjectJobState
object
Represents the state of a copy job.
TextAnalysisAuthoringImportProjectJobState
object
Represents the state of an import job.
ConversationalAnalysisAuthoringUtteranceEntitiesEvaluationResult
object
Represents the comparison between the expected and predicted entities for an utterance.
2 properties 2 required
Errors
object
Collection of Error types.
1 property
TextAnalysisAuthoringTrainingConfigVersion
object
Represents a training config version.
2 properties 2 required
TextAnalysisAuthoringTrainingJobState
object
Represents the state of a training job.
1 property 1 required
UpdateOperationKind
string
Update operation type for assets.
QnaAssets
object
All QnA assets for the project.
2 properties
ConversationalAnalysisAuthoringEvaluationSummary
object
Represents the evaluation result summary.
3 properties 2 required
ConversationalAnalysisAuthoringTrainingJobOptions
object
Represents the options for starting a new training job.
4 properties 2 required
ConversationalAnalysisAuthoringConfusionMatrixCell
object
Represents a cell in a confusion matrix.
2 properties 2 required
TextAnalysisAuthoringEvaluationOptions
object
Represents the options used running the evaluation.
3 properties
ImportQnaRecord
Import QnA Record.
TextAnalysisAuthoringUnassignDeploymentResourcesOptions
object
Represents the options to unassign Azure resources from a project.
1 property 1 required
ConversationalAnalysisAuthoringConfusionMatrixRow
object
JobStatus
string
Job Status.
ProjectsMetadata
object
Collection of projects metadata and global settings.
2 properties
ConversationalAnalysisAuthoringExportedProject
object
Represents an exported project.
4 properties 3 required
ConversationalAnalysisAuthoringConfusionMatrix
object
ConversationalAnalysisAuthoringUtteranceEvaluationResult
object
Represents the evaluation result for an utterance.
4 properties 4 required
TextAnalysisAuthoringDeleteDeploymentOptions
object
Represents the options for deleting a project deployment.
1 property
ConversationalAnalysisAuthoringPrebuiltEntities
object
Represents a list of the retrieved supported prebuilt entities.
2 properties 2 required
QnaPrompt
object
Prompt for an answer.
4 properties
TextAnalysisAuthoringAssignDeploymentResourcesOptions
object
Represents the options for assigning Azure resources to a project.
1 property 1 required
ConversationalAnalysisAuthoringAssignedDeploymentResource
object
Represents the assigned deployment resource.
2 properties 2 required
UpdateQnaOptions
array
A list of QnAs to be updated.
ConversationalAnalysisAuthoringProjectKind
string
ConversationalAnalysisAuthoringAssignedResourceDeploymentsMetadata
object
Represents the metadata for deployments assigned to a resource.
2 properties 2 required
TextAnalysisAuthoringTrainingJobOptions
object
Represents the options for starting a new training job.
3 properties 2 required
ConversationalAnalysisAuthoringProjectDeployment
object
Represents a project deployment.
7 properties 7 required
TextAnalysisAuthoringDeploymentJobState
object
Represents the state of a deployment job.
ConversationalAnalysisAuthoringEvaluationJobState
object
Represents the state of a evaluation job.
1 property 1 required
SourceContentStructureKind
string
Content structure type for sources.
TextAnalysisAuthoringExportProjectJobState
object
Represents the state of an export job.
1 property
ConversationalAnalysisAuthoringCreateDeploymentOptions
object
Represents the options for creating or updating a project deployment.
2 properties 1 required
ImportJobOptions
object
Project assets the needs to be imported.
3 properties
TextAnalysisAuthoringCreateDeploymentOptions
object
Represents the options for creating or updating a project deployment.
2 properties 1 required
ConversationalAnalysisAuthoringExportedProjectAssets
object
Represents the assets of an exported project.
1 property 1 required
ConversationalAnalysisAuthoringCopyAuthorizationOptions
object
Represents the options for authorizing a project copy to the current Azure resource.
3 properties 1 required
ConversationalAnalysisAuthoringIntentEvaluationSummary
object
The evaluation summary for an intent.
7 properties 7 required
ConversationalAnalysisAuthoringStringIndexType
string
TextAnalysisAuthoringSubTrainingJobState
object
Represents the detailed state of a training sub-operation.
4 properties 2 required
ConversationalAnalysisAuthoringDeleteDeploymentOptions
object
Represents the options for deleting a project deployment.
1 property
ConversationalAnalysisAuthoringResourceMetadata
object
Represents metadata for the Azure resource..
3 properties 3 required
ProjectSettings
object
Configurable settings of the Project.
1 property
TextAnalysisAuthoringEvaluationJobState
object
Represents the state of a evaluation job.
1 property 1 required
TextAnalysisAuthoringExportedModelOptions
object
Represents the options for creating or replacing an exported model.
1 property 1 required
TextAnalysisAuthoringEvaluationSummary
object
Represents the summary for an evaluation operation.
2 properties 2 required
ActiveLearningFeedback
object
Feedback for Active Learning.
1 property
UpdateQnaSourceRecord
Update source record.
TextAnalysisAuthoringExportedProject
object
Represents an exported project.
4 properties 3 required
TextAnalysisAuthoringEvaluationResults
object
Represents a list of results for an evaluation operation.
2 properties 2 required
TextAnalysisAuthoringProjectDeployment
object
Represents a project deployment.
7 properties 7 required
CreateProjectOptions
object
Parameters needed to create the project.
4 properties 1 required
ConversationalAnalysisAuthoringProjectTrainedModel
object
Represents a trained model.
7 properties 7 required
ConversationalAnalysisAuthoringUnassignDeploymentResourcesOptions
object
Represents the options to unassign Azure resources from a project.
1 property 1 required
ConversationalAnalysisAuthoringJobStatus
string
TextAnalysisAuthoringCreateProjectOptions
object
Represents the options used to create or update a project.
7 properties 4 required
ConversationalAnalysisAuthoringTrainingConfigVersions
object
Represents a list of training config versions.
2 properties 2 required
ConversationalAnalysisAuthoringLoadSnapshotJobState
object
Represents the state of loading a snapshot job.
QnaAsset
array
List of QnA records.
RefreshSourceOptions
object
Boolean flag used to refresh data from the Source.
1 property
ConversationalAnalysisAuthoringSubTrainingJobState
object
Represents the detailed state of a training sub-operation.
4 properties 2 required
QnaSourcesMetadata
array
Custom sources from which QnAs were extracted or explicitly added to the project.
QnaSourceRecord
Custom source record with last updated date-time.
ConversationalAnalysisAuthoringCreateProjectOptions
object
Represents the options used to create or update a project.
7 properties 3 required
TextAnalysisAuthoringJobState
object
Represents a job's state.
7 properties 4 required
ConversationalAnalysisAuthoringTrainingJobState
object
Represents the state of a training job.
1 property 1 required
TextAnalysisAuthoringPrebuiltEntities
object
Represents a list of the retrieved supported prebuilt entities.
2 properties 2 required
ConversationalAnalysisAuthoringUtteranceIntentsEvaluationResult
object
Represents the comparison between the expected and the predicted intent for an utterance.
2 properties 2 required
ProjectDeployment
object
Project deployment details.
2 properties
UpdateSourceRecord
object
Source to be updated.
2 properties 2 required
ConversationalAnalysisAuthoringTrainingConfigVersion
object
Represents a training config version.
2 properties 2 required
TextAnalysisAuthoringDeploymentResourcesJobState
object
Represents the state of a deployment resources job.
ConversationalAnalysisAuthoringSupportedLanguage
object
Represents a supported language.
2 properties 2 required
QnaSources
object
All QnA sources for the project.
2 properties
ConversationalAnalysisAuthoringPrebuiltEntity
object
Represents a supported prebuilt entity.
3 properties 3 required
ConversationalAnalysisAuthoringUtteranceEntityEvaluationResult
object
Represents the evaluation output of an entity label or prediction.
3 properties 3 required
JobMetadata
object
Represents the job metadata.
5 properties 4 required
TextAnalysisAuthoringExportedTrainedModel
object
Represents an exported trained model.
6 properties 6 required
TextAnalysisAuthoringEvaluationKind
string
ConversationalAnalysisAuthoringProjectDeployments
object
Represents a list of retrieved deployments.
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

microsoft-azure-authoring-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 Authoring 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.