Azure Cognitive Services provides REST APIs and client library SDKs for adding cognitive capabilities to applications. The service includes AI capabilities for vision, speech, language, decision, and search, enabling developers to integrate pre-built AI models for computer vision, text analytics, speech recognition, language understanding, and content moderation into their applications.
openapi: 3.1.0
info:
title: Microsoft Azure Azure Cognitive Services Management API
description: >-
Azure Cognitive Services (now Azure AI services) provides REST APIs and
client library SDKs for adding cognitive capabilities to applications. This
management API enables programmatic operations to manage Cognitive Services
accounts, including creating, updating, deleting, and listing accounts,
managing keys, listing available SKUs, and checking name availability. It
serves as the control plane for all Azure Cognitive Services resources.
version: '2024-04-01-preview'
contact:
name: Microsoft Azure Support
url: https://azure.microsoft.com/en-us/support/
email: [email protected]
license:
name: Microsoft API License
url: https://learn.microsoft.com/en-us/legal/
x-logo:
url: https://azure.microsoft.com/svghandler/azure-logo.png
servers:
- url: https://management.azure.com
description: Azure Resource Manager endpoint
security:
- oauth2:
- https://management.azure.com/.default
tags:
- name: Accounts
description: Operations for managing Cognitive Services accounts
- name: Deployments
description: Operations for managing model deployments
- name: Models
description: Operations for listing available models
paths:
/subscriptions/{subscriptionId}/providers/Microsoft.CognitiveServices/accounts:
get:
operationId: Accounts_List
summary: Microsoft Azure List Cognitive Services Accounts
description: Returns all the Cognitive Services accounts in a subscription.
tags:
- Accounts
parameters:
- $ref: '#/components/parameters/SubscriptionIdParameter'
- $ref: '#/components/parameters/ApiVersionParameter'
responses:
'200':
description: Successfully returned the list of accounts.
content:
application/json:
schema:
$ref: '#/components/schemas/AccountListResult'
examples:
AccountsList200Example:
summary: Default Accounts_List 200 response
x-microcks-default: true
value:
value:
- id: abc123
name: Example Title
type: example_value
etag: example_value
kind: example_value
location: example_value
tags: example_value
nextLink: example_value
default:
description: Error response.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
AccountsListdefaultExample:
summary: Default Accounts_List default response
x-microcks-default: true
value:
error:
code: example_value
message: example_value
target: example_value
details:
- code: example_value
message: example_value
target: example_value
additionalInfo:
- type: example_value
info: example_value
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts:
get:
operationId: Accounts_ListByResourceGroup
summary: Microsoft Azure List Accounts by Resource Group
description: >-
Returns all Cognitive Services accounts in a resource group.
tags:
- Accounts
parameters:
- $ref: '#/components/parameters/SubscriptionIdParameter'
- $ref: '#/components/parameters/ResourceGroupNameParameter'
- $ref: '#/components/parameters/ApiVersionParameter'
responses:
'200':
description: Successfully returned the list of accounts.
content:
application/json:
schema:
$ref: '#/components/schemas/AccountListResult'
examples:
AccountsListbyresourcegroup200Example:
summary: Default Accounts_ListByResourceGroup 200 response
x-microcks-default: true
value:
value:
- id: abc123
name: Example Title
type: example_value
etag: example_value
kind: example_value
location: example_value
tags: example_value
nextLink: example_value
default:
description: Error response.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
AccountsListbyresourcegroupdefaultExample:
summary: Default Accounts_ListByResourceGroup default response
x-microcks-default: true
value:
error:
code: example_value
message: example_value
target: example_value
details:
- code: example_value
message: example_value
target: example_value
additionalInfo:
- type: example_value
info: example_value
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}
: get:
operationId: Accounts_Get
summary: Microsoft Azure Get a Cognitive Services Account
description: Returns a Cognitive Services account specified by the parameters.
tags:
- Accounts
parameters:
- $ref: '#/components/parameters/SubscriptionIdParameter'
- $ref: '#/components/parameters/ResourceGroupNameParameter'
- $ref: '#/components/parameters/AccountNameParameter'
- $ref: '#/components/parameters/ApiVersionParameter'
responses:
'200':
description: Successfully returned the account.
content:
application/json:
schema:
$ref: '#/components/schemas/Account'
examples:
AccountsGet200Example:
summary: Default Accounts_Get 200 response
x-microcks-default: true
value:
id: abc123
name: Example Title
type: example_value
etag: example_value
kind: example_value
sku:
name: Example Title
tier: Free
identity:
principalId: '500123'
tenantId: '500123'
type: None
userAssignedIdentities: example_value
location: example_value
tags: example_value
properties:
provisioningState: Accepted
endpoint: example_value
endpoints: example_value
capabilities:
- {}
isMigrated: true
dateCreated: example_value
customSubDomainName: example_value
publicNetworkAccess: Enabled
disableLocalAuth: true
restrictOutboundNetworkAccess: true
default:
description: Error response.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
AccountsGetdefaultExample:
summary: Default Accounts_Get default response
x-microcks-default: true
value:
error:
code: example_value
message: example_value
target: example_value
details:
- code: example_value
message: example_value
target: example_value
additionalInfo:
- type: example_value
info: example_value
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
put:
operationId: Accounts_Create
summary: Microsoft Azure Create or Update a Cognitive Services Account
description: >-
Creates a Cognitive Services account. Accounts is a resource group wide
resource type. It holds the keys for developer to access intelligent APIs.
tags:
- Accounts
parameters:
- $ref: '#/components/parameters/SubscriptionIdParameter'
- $ref: '#/components/parameters/ResourceGroupNameParameter'
- $ref: '#/components/parameters/AccountNameParameter'
- $ref: '#/components/parameters/ApiVersionParameter'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/Account'
examples:
AccountsCreateRequestExample:
summary: Default Accounts_Create request
x-microcks-default: true
value:
id: abc123
name: Example Title
type: example_value
etag: example_value
kind: example_value
sku:
name: Example Title
tier: Free
identity:
principalId: '500123'
tenantId: '500123'
type: None
userAssignedIdentities: example_value
location: example_value
tags: example_value
properties:
provisioningState: Accepted
endpoint: example_value
endpoints: example_value
capabilities:
- {}
isMigrated: true
dateCreated: example_value
customSubDomainName: example_value
publicNetworkAccess: Enabled
disableLocalAuth: true
restrictOutboundNetworkAccess: true
responses:
'200':
description: Successfully updated the account.
content:
application/json:
schema:
$ref: '#/components/schemas/Account'
examples:
AccountsCreate200Example:
summary: Default Accounts_Create 200 response
x-microcks-default: true
value:
id: abc123
name: Example Title
type: example_value
etag: example_value
kind: example_value
sku:
name: Example Title
tier: Free
identity:
principalId: '500123'
tenantId: '500123'
type: None
userAssignedIdentities: example_value
location: example_value
tags: example_value
properties:
provisioningState: Accepted
endpoint: example_value
endpoints: example_value
capabilities:
- {}
isMigrated: true
dateCreated: example_value
customSubDomainName: example_value
publicNetworkAccess: Enabled
disableLocalAuth: true
restrictOutboundNetworkAccess: true
'201':
description: Successfully created the account.
content:
application/json:
schema:
$ref: '#/components/schemas/Account'
examples:
AccountsCreate201Example:
summary: Default Accounts_Create 201 response
x-microcks-default: true
value:
id: abc123
name: Example Title
type: example_value
etag: example_value
kind: example_value
sku:
name: Example Title
tier: Free
identity:
principalId: '500123'
tenantId: '500123'
type: None
userAssignedIdentities: example_value
location: example_value
tags: example_value
properties:
provisioningState: Accepted
endpoint: example_value
endpoints: example_value
capabilities:
- {}
isMigrated: true
dateCreated: example_value
customSubDomainName: example_value
publicNetworkAccess: Enabled
disableLocalAuth: true
restrictOutboundNetworkAccess: true
'202':
description: Accepted. The account creation is in progress.
content:
application/json:
schema:
$ref: '#/components/schemas/Account'
examples:
AccountsCreate202Example:
summary: Default Accounts_Create 202 response
x-microcks-default: true
value:
id: abc123
name: Example Title
type: example_value
etag: example_value
kind: example_value
sku:
name: Example Title
tier: Free
identity:
principalId: '500123'
tenantId: '500123'
type: None
userAssignedIdentities: example_value
location: example_value
tags: example_value
properties:
provisioningState: Accepted
endpoint: example_value
endpoints: example_value
capabilities:
- {}
isMigrated: true
dateCreated: example_value
customSubDomainName: example_value
publicNetworkAccess: Enabled
disableLocalAuth: true
restrictOutboundNetworkAccess: true
default:
description: Error response.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
AccountsCreatedefaultExample:
summary: Default Accounts_Create default response
x-microcks-default: true
value:
error:
code: example_value
message: example_value
target: example_value
details:
- code: example_value
message: example_value
target: example_value
additionalInfo:
- type: example_value
info: example_value
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
delete:
operationId: Accounts_Delete
summary: Microsoft Azure Delete a Cognitive Services Account
description: Deletes a Cognitive Services account from the resource group.
tags:
- Accounts
parameters:
- $ref: '#/components/parameters/SubscriptionIdParameter'
- $ref: '#/components/parameters/ResourceGroupNameParameter'
- $ref: '#/components/parameters/AccountNameParameter'
- $ref: '#/components/parameters/ApiVersionParameter'
responses:
'200':
description: Successfully deleted the account.
'202':
description: Accepted. The account deletion is in progress.
'204':
description: The account does not exist.
default:
description: Error response.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
AccountsDeletedefaultExample:
summary: Default Accounts_Delete default response
x-microcks-default: true
value:
error:
code: example_value
message: example_value
target: example_value
details:
- code: example_value
message: example_value
target: example_value
additionalInfo:
- type: example_value
info: example_value
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
patch:
operationId: Accounts_Update
summary: Microsoft Azure Update a Cognitive Services Account
description: Updates a Cognitive Services account.
tags:
- Accounts
parameters:
- $ref: '#/components/parameters/SubscriptionIdParameter'
- $ref: '#/components/parameters/ResourceGroupNameParameter'
- $ref: '#/components/parameters/AccountNameParameter'
- $ref: '#/components/parameters/ApiVersionParameter'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/Account'
examples:
AccountsUpdateRequestExample:
summary: Default Accounts_Update request
x-microcks-default: true
value:
id: abc123
name: Example Title
type: example_value
etag: example_value
kind: example_value
sku:
name: Example Title
tier: Free
identity:
principalId: '500123'
tenantId: '500123'
type: None
userAssignedIdentities: example_value
location: example_value
tags: example_value
properties:
provisioningState: Accepted
endpoint: example_value
endpoints: example_value
capabilities:
- {}
isMigrated: true
dateCreated: example_value
customSubDomainName: example_value
publicNetworkAccess: Enabled
disableLocalAuth: true
restrictOutboundNetworkAccess: true
responses:
'200':
description: Successfully updated the account.
content:
application/json:
schema:
$ref: '#/components/schemas/Account'
examples:
AccountsUpdate200Example:
summary: Default Accounts_Update 200 response
x-microcks-default: true
value:
id: abc123
name: Example Title
type: example_value
etag: example_value
kind: example_value
sku:
name: Example Title
tier: Free
identity:
principalId: '500123'
tenantId: '500123'
type: None
userAssignedIdentities: example_value
location: example_value
tags: example_value
properties:
provisioningState: Accepted
endpoint: example_value
endpoints: example_value
capabilities:
- {}
isMigrated: true
dateCreated: example_value
customSubDomainName: example_value
publicNetworkAccess: Enabled
disableLocalAuth: true
restrictOutboundNetworkAccess: true
'202':
description: Accepted. The account update is in progress.
content:
application/json:
schema:
$ref: '#/components/schemas/Account'
examples:
AccountsUpdate202Example:
summary: Default Accounts_Update 202 response
x-microcks-default: true
value:
id: abc123
name: Example Title
type: example_value
etag: example_value
kind: example_value
sku:
name: Example Title
tier: Free
identity:
principalId: '500123'
tenantId: '500123'
type: None
userAssignedIdentities: example_value
location: example_value
tags: example_value
properties:
provisioningState: Accepted
endpoint: example_value
endpoints: example_value
capabilities:
- {}
isMigrated: true
dateCreated: example_value
customSubDomainName: example_value
publicNetworkAccess: Enabled
disableLocalAuth: true
restrictOutboundNetworkAccess: true
default:
description: Error response.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
AccountsUpdatedefaultExample:
summary: Default Accounts_Update default response
x-microcks-default: true
value:
error:
code: example_value
message: example_value
target: example_value
details:
- code: example_value
message: example_value
target: example_value
additionalInfo:
- type: example_value
info: example_value
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/listKeys
: post:
operationId: Accounts_ListKeys
summary: Microsoft Azure List Account Keys
description: Lists the account keys for the specified Cognitive Services account.
tags:
- Accounts
parameters:
- $ref: '#/components/parameters/SubscriptionIdParameter'
- $ref: '#/components/parameters/ResourceGroupNameParameter'
- $ref: '#/components/parameters/AccountNameParameter'
- $ref: '#/components/parameters/ApiVersionParameter'
responses:
'200':
description: Successfully returned the account keys.
content:
application/json:
schema:
$ref: '#/components/schemas/ApiKeys'
examples:
AccountsListkeys200Example:
summary: Default Accounts_ListKeys 200 response
x-microcks-default: true
value:
key1: example_value
key2: example_value
default:
description: Error response.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
AccountsListkeysdefaultExample:
summary: Default Accounts_ListKeys default response
x-microcks-default: true
value:
error:
code: example_value
message: example_value
target: example_value
details:
- code: example_value
message: example_value
target: example_value
additionalInfo:
- type: example_value
info: example_value
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/regenerateKey
: post:
operationId: Accounts_RegenerateKey
summary: Microsoft Azure Regenerate an Account Key
description: Regenerates the specified account key for the Cognitive Services account.
tags:
- Accounts
parameters:
- $ref: '#/components/parameters/SubscriptionIdParameter'
- $ref: '#/components/parameters/ResourceGroupNameParameter'
- $ref: '#/components/parameters/AccountNameParameter'
- $ref: '#/components/parameters/ApiVersionParameter'
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
keyName:
type: string
enum:
- Key1
- Key2
description: Key name to regenerate.
required:
- keyName
examples:
AccountsRegeneratekeyRequestExample:
summary: Default Accounts_RegenerateKey request
x-microcks-default: true
value:
keyName: Key1
responses:
'200':
description: Successfully regenerated the key.
content:
application/json:
schema:
$ref: '#/components/schemas/ApiKeys'
examples:
AccountsRegeneratekey200Example:
summary: Default Accounts_RegenerateKey 200 response
x-microcks-default: true
value:
key1: example_value
key2: example_value
default:
description: Error response.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
AccountsRegeneratekeydefaultExample:
summary: Default Accounts_RegenerateKey default response
x-microcks-default: true
value:
error:
code: example_value
message: example_value
target: example_value
details:
- code: example_value
message: example_value
target: example_value
additionalInfo:
- type: example_value
info: example_value
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/deployments
: get:
operationId: Deployments_List
summary: Microsoft Azure List Model Deployments
description: Gets the deployments associated with the Cognitive Services account.
tags:
- Deployments
parameters:
- $ref: '#/components/parameters/SubscriptionIdParameter'
- $ref: '#/components/parameters/ResourceGroupNameParameter'
- $ref: '#/components/parameters/AccountNameParameter'
- $ref: '#/components/parameters/ApiVersionParameter'
responses:
'200':
description: Successfully returned the deployments.
content:
application/json:
schema:
$ref: '#/components/schemas/DeploymentListResult'
examples:
DeploymentsList200Example:
summary: Default Deployments_List 200 response
x-microcks-default: true
value:
value:
- id: abc123
name: Example Title
type: example_value
etag: example_value
nextLink: example_value
default:
description: Error response.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
DeploymentsListdefaultExample:
summary: Default Deployments_List default response
x-microcks-default: true
value:
error:
code: example_value
message: example_value
target: example_value
details:
- code: example_value
message: example_value
target: example_value
additionalInfo:
- type: example_value
info: example_value
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/deployments/{deploymentName}
: get:
operationId: Deployments_Get
summary: Microsoft Azure Get a Model Deployment
description: Gets the specified deployments associated with the Cognitive Services account.
tags:
- Deployments
parameters:
- $ref: '#/components/parameters/SubscriptionIdParameter'
- $ref: '#/components/parameters/ResourceGroupNameParameter'
- $ref: '#/components/parameters/AccountNameParameter'
- name: deploymentName
in: path
required: true
description: The name of the deployment.
schema:
type: string
example: example_value
- $ref: '#/components/parameters/ApiVersionParameter'
responses:
'200':
description: Successfully returned the deployment.
content:
application/json:
schema:
$ref: '#/components/schemas/Deployment'
examples:
DeploymentsGet200Example:
summary: Default Deployments_Get 200 response
x-microcks-default: true
value:
id: abc123
name: Example Title
type: example_value
etag: example_value
sku:
name: Example Title
tier: Free
properties:
provisioningState: Accepted
scaleSettings:
scaleType: Standard
capacity: 10
activeCapacity: 10
rateLimits:
- {}
capabilities: example_value
versionUpgradeOption: OnceNewDefaultVersionAvailable
def
# --- truncated at 32 KB (56 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/microsoft-azure/refs/heads/main/openapi/azure-cognitive-services-openapi.yml