Microsoft Azure Models API

Operations for listing available models

Documentation GitHub OpenAPI

Operations 17

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /subscriptions/{subscriptionId}/providers/Microsoft.CognitiveServices/models List Azure AI models available to a subscription · Microsoft Azure List Available Models #

Ask an LLM

“Which Cognitive Services models can my subscription deploy?”

“What AI models are available to me in Azure AI services?”

Tell an agent

List the Cognitive Services models available to subscription {subscriptionId}.

Show the AI service model catalog I can use.

POST /models Upload Digital Twins models · Microsoft Azure Post Models #

Ask an LLM

“How do I upload DTDL model definitions to Azure Digital Twins?”

“If one of several uploaded twin models is invalid, are any of them saved?”

Tell an agent

Upload these DTDL models to my Digital Twins instance using API version {api-version}.

Add the new twin interface definitions as one batch.

GET /models List Digital Twins models · Microsoft Azure Get Models #

Ask an LLM

“What DTDL models are uploaded to my Azure Digital Twins instance?”

“Can I list only the digital twin models a given model depends on?”

Tell an agent

List all DTDL models in my Digital Twins instance.

List the digital twin models needed by {dependenciesFor}, including definitions.

GET /models/{id} Get one Digital Twins model by DTMI · Microsoft Azure Get Models Id #

Ask an LLM

“How do I look up one DTDL model in my Azure Digital Twins instance by its model id?”

“Can I fetch a twin model's full definition along with its metadata?”

Tell an agent

Get Digital Twins model {id}.

Show DTDL model {id} with its definition included: {includeModelDefinition}.

PATCH /models/{id} Update Digital Twins model metadata · Microsoft Azure Patch Models Id #

Ask an LLM

“Can I decommission a DTDL model with a JSON Patch instead of deleting it?”

“How do I change the metadata on an existing twin model?”

Tell an agent

Update the metadata of digital twin model {id} with a JSON Patch.

Decommission twin model {id}.

DELETE /models/{id} Delete a Digital Twins model · Microsoft Azure Delete Models Id #

Ask an LLM

“Why does deleting a DTDL model fail when other twin models still reference it?”

“How do I remove a model from my Azure Digital Twins instance?”

Tell an agent destructive · confirm first

Delete Digital Twins model {id}.

Remove DTDL interface {id} from the twin graph's model set.

GET /models/{model_id} Get a model by model_id · Microsoft Azure Gets Details For The Model Specified By The Given Modelid #

Ask an LLM

“Where do I look up details for a model using the model_id path form?”

“Can I fetch a model's details by passing its id as model_id?”

Tell an agent

Get details for model {model_id} via the model_id endpoint.

Look up model {model_id} (underscore model_id route).

GET /models/{model-id} Get a model by model-id (hyphenated route) · Microsoft Azure Gets Details For The Model Specified By The Given Modelid #

Ask an LLM

“Is there a hyphenated model-id route for reading a model's details?”

“How do I read one model's details through the dash-separated model-id path?”

Tell an agent

Get details for model {model-id} via the hyphenated model-id endpoint.

Look up model {model-id} using the dash-style route.

POST /models/{model}/analyze Analyze an image with a domain-specific model · Microsoft Azure Post Models Model Analyze #

Ask an LLM

“Can Computer Vision recognize celebrities or landmarks in a photo?”

“Which language can I get domain-specific image analysis results in?”

Tell an agent

Analyze this image with the {model} domain model.

Recognize {model} content in the image and answer in {language}.

PUT /models/{name} Train a custom model · Microsoft Azure Start Training A Custom Model status Codes Returned: 201… #

Ask an LLM

“How do I start training a new custom model with my training parameters?”

“Can I kick off custom model training and evaluate it at the same time?”

Tell an agent

Start training custom model {name}.

Train model {name} with training parameters {trainingParameters}.

GET /models/{name} Get a custom trained model · Microsoft Azure Get Information About A Specific Model status Codes Returned… #

Ask an LLM

“How do I check the training status of a custom model I started?”

“Can I see a custom model's performance once training finishes?”

Tell an agent

Get custom model {name}.

Show training status and performance of model {name}.

DELETE /models/{name} Delete a custom model · Microsoft Azure Delete A Custom Model A Model Can Be Deleted If It Is In One Of… #

Ask an LLM

“Which training states must a custom model be in before I can delete it?”

“How do I get rid of a custom model I no longer need?”

Tell an agent destructive · confirm first

Delete custom model {name}.

Remove the finished or failed model {name}.

POST /models/{name}:cancel Cancel custom model training · Microsoft Azure Cancel Model Training status Codes Returned: 202: Operation… #

Ask an LLM

“Can I stop a custom model training run that is still in progress?”

“How do I cancel training to avoid spending more training minutes?”

Tell an agent destructive · confirm first

Cancel training of model {name}.

Stop the in-progress training job for {name}.

PUT /models/{name}/evaluations/{evaluationName} Evaluate an existing custom model · Microsoft Azure Evaluate An Existing Model status Codes Returned: 201… #

Ask an LLM

“How do I run an evaluation of a trained model against a test set?”

“Can I create a new evaluation with its own evaluation parameters?”

Tell an agent

Evaluate model {name} as evaluation {evaluationName}.

Run evaluation {evaluationName} on model {name} with parameters {evaluationParameters}.

GET /models/{name}/evaluations/{evaluationName} Get a model evaluation · Microsoft Azure Get Information About A Specific Model Evaluation status Codes… #

Ask an LLM

“How do I read the results of one evaluation run against my custom model?”

“What status is a specific model evaluation in?”

Tell an agent

Get evaluation {evaluationName} of model {name}.

Show the performance results for evaluation {evaluationName}.

DELETE /models/{name}/evaluations/{evaluationName} Delete a model evaluation · Microsoft Azure Delete A Model Evaluation A Model Evaluation Can Be Deleted If… #

Ask an LLM

“Can I delete an evaluation that is still running?”

“How do I remove an old evaluation from a custom model?”

Tell an agent destructive · confirm first

Delete evaluation {evaluationName} from model {name}.

Remove the failed evaluation {evaluationName}.

GET /models/{name}/evaluations List evaluations for a custom model · Microsoft Azure Get A List Of The Available Evaluations For A Model status… #

Ask an LLM

“What evaluations have been run on my custom model so far?”

“Can I page through a model's evaluations with skip and top?”

Tell an agent

List evaluations of model {name}.

List the first {top} evaluations of model {name}, skipping {skip}.

Microsoft Azure Models API

Operations 17

Documentation

Specifications

Other Resources

Work with this as data

MCP server

Tools for apis

Call it yourself

Get an API key

OpenAPI Specification