Microsoft Azure Microsoft Azure ML Chat API

The Microsoft Azure Azure ML Chat API from Microsoft Azure — 1 operation(s) for microsoft azure azure ml chat.

Documentation GitHub OpenAPI

Business capability

Artificial Intelligence Management BC-610.60

Operations 1

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

POST /{operationRoute} Create a streaming chat completion · Microsoft Azure Post Operationroute #

Ask an LLM

“How do I stream a chat reply from my Azure Machine Learning chat endpoint?”

“Can I pass session state and extra context along with chat messages?”

Tell an agent

Send messages {messages} to chat route {operationRoute} with streaming {stream}.

Stream a chat completion from {operationRoute} for {messages}, keeping session state {sessionState}.

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/microsoft-azure:microsoft-azure-microsoft-azure-azure-ml-chat-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: Microsoft Azure Azure ML Chat API
  version: 2023-10-01-preview
  description: Azure APIs for the Azure Chat protocol.
  x-typespec-generated:
  - emitter: '@azure-tools/typespec-autorest'
security:
- ApiKeyAuth: []
- OAuth2Auth: []
tags:
- name: Microsoft Azure Azure ML Chat
paths:
  /{operationRoute}:
    post:
      operationId: microsoftAzureChatCreatestreaming
      description: Creates a new streaming chat completion.
      parameters:
      - $ref: '#/components/parameters/OperationRouteParam'
      responses:
        '200':
          description: The request has succeeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ChatCompletionChunk'
      x-ms-examples:
        Creates a chat completion for the provided prompt using streaming.:
          $ref: ./examples/create_streaming.json
      summary: Microsoft Azure Post Operationroute
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/StreamingChatCompletionOptions'
        required: true
      tags:
      - Microsoft Azure Azure ML Chat
components:
  schemas:
    StreamingChatCompletionOptions:
      type: object
      description: The configuration for a streaming chat completion request.
      properties:
        messages:
          type: array
          description: The collection of context messages associated with this completion request.
          items:
            $ref: '#/components/schemas/ChatMessage'
          x-ms-identifiers: []
        stream:
          type: boolean
          description: Indicates whether the completion is a streaming or non-streaming completion.
          enum:
          - true
        sessionState:
          description: 'Field that allows the chat app to store and retrieve data, the structure of such data is dependant on the backend

            being used. The client must send back the data in this field unchanged in subsequent requests, until the chat app

            sends a new one. The data in this field can be used to implement stateful services, such as remembering previous

            conversations or user preferences.'
        context:
          type: object
          description: 'Context allows the chat app to receive extra parameters from the client, such as temperature, functions, or

            customer_info. These parameters are specific to the chat app and not understood by the generic clients.'
          additionalProperties: {}
      required:
      - messages
      - stream
    ChoiceDelta:
      type: object
      description: The representation of an incremental choice received in a streaming completion.
      properties:
        index:
          type: integer
          format: int64
          description: The index of the of the chat choice, relative to the other choices in the same completion.
        delta:
          $ref: '#/components/schemas/ChatMessageDelta'
          description: The partial message received for this choice.
        sessionState:
          description: 'Field that allows the chat app to store and retrieve data, the structure of such data is dependant on the backend

            being used. The client must send back the data in this field unchanged in subsequent requests, until the chat app

            sends a new one. The data in this field can be used to implement stateful services, such as remembering previous

            conversations or user preferences.'
        context:
          type: object
          description: 'Context allows the chat app to receive extra parameters from the client, such as temperature, functions, or

            customer_info. These parameters are specific to the chat app and not understood by the generic clients.'
          additionalProperties: {}
        finishReason:
          $ref: '#/components/schemas/FinishReason'
          description: The reason this chat completion completed its generation.
      required:
      - index
      - delta
    ChatCompletionChunk:
      type: object
      description: A single response to a streaming completion request.
      properties:
        choices:
          type: array
          description: The collection of choice deltas received in this chunk.
          items:
            $ref: '#/components/schemas/ChoiceDelta'
          x-ms-identifiers: []
      required:
      - choices
    MessageKind:
      type: string
      description: Identifies the type of a message.
      enum:
      - text
      x-ms-enum:
        name: MessageKind
        modelAsString: true
        values:
        - name: text
          value: text
          description: The message context is text.
    ChatMessage:
      type: object
      description: A single, role-attributed message within a chat completion interaction.
      properties:
        kind:
          $ref: '#/components/schemas/MessageKind'
          description: The type of the message. If not specified, the message is assumed to be text.
        role:
          $ref: '#/components/schemas/ChatRole'
          description: The role associated with the message.
        sessionState:
          description: 'Field that allows the chat app to store and retrieve data, the structure of such data is dependant on the backend

            being used. The client must send back the data in this field unchanged in subsequent requests, until the chat app

            sends a new one. The data in this field can be used to implement stateful services, such as remembering previous

            conversations or user preferences.'
      discriminator:
        propertyName: kind
      required:
      - kind
      - role
    ChatRole:
      type: string
      description: A representation of the intended purpose of a message.
      enum:
      - user
      - system
      - assistant
      x-ms-enum:
        name: ChatRole
        modelAsString: true
        values:
        - name: user
          value: user
          description: The role that provides input to the completion.
        - name: system
          value: system
          description: The role that instructs or configures the behavior of the assistant.
        - name: assistant
          value: assistant
          description: The role that provides responses to the system-instructed, user-prompted input.
    ChatMessageDelta:
      type: object
      description: The representation of a delta message received in a streaming completion.
      properties:
        kind:
          $ref: '#/components/schemas/MessageKind'
          description: The type of the message. If not specified, the message is assumed to be text.
        role:
          $ref: '#/components/schemas/ChatRole'
          description: The role associated with the message.
        sessionState:
          description: 'Field that allows the chat app to store and retrieve data, the structure of such data is dependant on the backend

            being used. The client must send back the data in this field unchanged in subsequent requests, until the chat app

            sends a new one. The data in this field can be used to implement stateful services, such as remembering previous

            conversations or user preferences.'
      discriminator:
        propertyName: kind
      required:
      - kind
    FinishReason:
      type: string
      description: Representation of the reason why a chat session has finished processing.
      enum:
      - stop
      - length
      x-ms-enum:
        name: FinishReason
        modelAsString: true
        values:
        - name: stopped
          value: stop
          description: Completion ended normally.
        - name: tokenLimitReached
          value: length
          description: The completion exhausted available tokens before generation could complete.
  parameters:
    OperationRouteParam:
      name: operationRoute
      in: path
      description: The route where the endpoint exposes the chat operations.
      required: true
      x-ms-parameter-location: method
      schema:
        type: string
        default: chat
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      name: api-key
      in: header
    OAuth2Auth:
      type: oauth2
      flows:
        implicit:
          scopes: {}
          authorizationUrl: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - name: endpoint
    in: path
    required: true
    type: string
x-ms-paths:
  /{operationRoute}?_overload=create:
    post:
      operationId: Chat_Create
      description: Creates a new chat completion.
      parameters:
      - $ref: '#/components/parameters/OperationRouteParam'
      - name: body
        in: body
        required: true
        schema:
          $ref: '#/components/schemas/ChatCompletionOptions'
      responses:
        '200':
          description: The request has succeeded.
          schema:
            $ref: '#/components/schemas/ChatCompletion'
      x-ms-examples:
        Creates a chat completion for the provided prompt using streaming.:
          $ref: ./examples/create.json