Microsoft

Microsoft Chat API

Manage chat threads and messages

Documentation GitHub OpenAPI

Documentation

https://learn.microsoft.com/en-us/graph/overview

https://learn.microsoft.com/en-us/graph/auth/

https://learn.microsoft.com/en-us/graph/use-the-api

https://learn.microsoft.com/en-us/rest/api/azure/

https://learn.microsoft.com/en-us/rest/api/?view=Azure

https://learn.microsoft.com/en-us/azure/active-directory/develop/

https://learn.microsoft.com/en-us/azure/ai-services/openai/

https://learn.microsoft.com/en-us/azure/ai-services/openai/reference

https://learn.microsoft.com/en-us/azure/ai-services/openai/quickstart

https://learn.microsoft.com/en-us/azure/ai-services/openai/how-to/managed-identity

https://learn.microsoft.com/en-us/azure/ai-services/

https://learn.microsoft.com/en-us/rest/api/cognitiveservices/

https://learn.microsoft.com/en-us/microsoftteams/platform/

https://learn.microsoft.com/en-us/graph/teams-concept-overview

https://learn.microsoft.com/en-us/onedrive/developer/

https://learn.microsoft.com/en-us/onedrive/developer/rest-api/

https://learn.microsoft.com/en-us/power-platform/admin/programmability-overview

https://learn.microsoft.com/en-us/bing/search-apis/

https://learn.microsoft.com/en-us/bing/search-apis/bing-web-search/reference/endpoints

https://learn.microsoft.com/en-us/sharepoint/dev/sp-add-ins/get-to-know-the-sharepoint-rest-service

https://learn.microsoft.com/en-us/sharepoint/dev/sp-add-ins/complete-basic-operations-using-sharepoint-rest-endpoints

https://learn.microsoft.com/en-us/sharepoint/dev/apis/sharepoint-rest-graph

https://learn.microsoft.com/en-us/power-bi/developer/

https://learn.microsoft.com/en-us/rest/api/power-bi/

https://learn.microsoft.com/en-us/power-bi/developer/embedded/register-app

https://learn.microsoft.com/en-us/rest/api/azure/devops/

https://learn.microsoft.com/en-us/azure/devops/integrate/how-to/call-rest-api

https://learn.microsoft.com/en-us/azure/devops/integrate/get-started/authentication/authentication-guidance

https://learn.microsoft.com/en-us/rest/dynamics365/

https://learn.microsoft.com/en-us/power-apps/developer/data-platform/webapi/reference/about

https://learn.microsoft.com/en-us/power-apps/developer/data-platform/webapi/overview

https://learn.microsoft.com/en-us/power-apps/developer/data-platform/authenticate-oauth

https://learn.microsoft.com/en-us/linkedin/

https://learn.microsoft.com/en-us/linkedin/shared/authentication/getting-access

https://learn.microsoft.com/en-us/linkedin/shared/api-guide/concepts

https://learn.microsoft.com/en-us/azure/communication-services/

https://learn.microsoft.com/en-us/rest/api/communication/

https://learn.microsoft.com/en-us/entra/identity-platform/

https://learn.microsoft.com/en-us/graph/identity-network-access-overview

https://learn.microsoft.com/en-us/entra/identity-platform/quickstart-register-app

https://learn.microsoft.com/en-us/entra/identity-platform/v2-overview

https://learn.microsoft.com/en-us/outlook/

https://learn.microsoft.com/en-us/outlook/rest/get-started

https://learn.microsoft.com/en-us/graph/intune-concept-overview

https://learn.microsoft.com/en-us/graph/api/resources/intune-graph-overview

https://learn.microsoft.com/en-us/intune/intune-service/developer/intune-graph-apis

Specifications

https://raw.githubusercontent.com/api-evangelist/microsoft/refs/heads/main/openapi/microsoft-chat-api-openapi.yml

Schemas & Data

https://raw.githubusercontent.com/api-evangelist/microsoft/refs/heads/main/json-schema/microsoft-graph-user-schema.json

https://raw.githubusercontent.com/api-evangelist/microsoft/refs/heads/main/json-schema/microsoft-graph-group-schema.json

https://raw.githubusercontent.com/api-evangelist/microsoft/refs/heads/main/json-schema/microsoft-azure-resource-group-schema.json

https://raw.githubusercontent.com/api-evangelist/microsoft/refs/heads/main/json-schema/microsoft-teams-team-schema.json

https://raw.githubusercontent.com/api-evangelist/microsoft/refs/heads/main/json-schema/microsoft-drive-item-schema.json

https://raw.githubusercontent.com/api-evangelist/microsoft/refs/heads/main/json-schema/microsoft-managed-device-schema.json

Other Resources

https://learn.microsoft.com/en-us/graph/sdks/sdks-overview

https://developer.microsoft.com/en-us/graph/graph-explorer

https://learn.microsoft.com/en-us/graph/whats-new-overview

https://raw.githubusercontent.com/api-evangelist/microsoft/refs/heads/main/graphql/microsoft-graphql.md

https://azure.microsoft.com/en-us/downloads/

https://azure.microsoft.com/en-us/pricing/

https://azure.microsoft.com/en-us/pricing/details/cognitive-services/openai-service/

https://azure.microsoft.com/en-us/pricing/details/cognitive-services/

https://learn.microsoft.com/en-us/azure/ai-services/cognitive-services-apis-create-account-client-library

https://learn.microsoft.com/en-us/microsoftteams/platform/samples/app-templates

https://learn.microsoft.com/en-us/microsoftteams/platform/get-started/get-started-overview

https://github.com/OneDrive/samples

https://learn.microsoft.com/en-us/power-apps/developer/data-platform/webapi/overview

Power Automate API

https://learn.microsoft.com/en-us/power-automate/web-api

https://www.microsoft.com/en-us/bing/apis/pricing

Microsoft Graph Integration

https://learn.microsoft.com/en-us/graph/sharepoint-concept-overview

https://learn.microsoft.com/en-us/power-bi/developer/embedded/

https://learn.microsoft.com/en-us/azure/devops/integrate/get-started/rest/samples

https://learn.microsoft.com/en-us/linkedin/shared/development-resources/api-clients

https://learn.microsoft.com/en-us/azure/communication-services/concepts/sdk-options

https://azure.microsoft.com/en-us/products/communication-services/#pricing

https://github.com/Azure/Communication

Mail API Reference

https://learn.microsoft.com/en-us/graph/outlook-mail-concept-overview

Calendar API Reference

https://learn.microsoft.com/en-us/graph/outlook-calendar-concept-overview

https://learn.microsoft.com/en-us/intune/intune-service/developer/app-sdk-get-started

OpenAPI Specification

openapi: 3.1.0
info:
  title: Microsoft Azure Cognitive Services Accounts Chat API
  description: APIs for vision, speech, language, and decision-making AI capabilities including Computer Vision, Text Analytics, and Translator services.
  version: '3.2'
  contact:
    name: Microsoft Azure Support
    url: https://azure.microsoft.com/en-us/support/
  termsOfService: https://www.microsoft.com/en-us/legal/terms-of-use
servers:
- url: https://{region}.api.cognitive.microsoft.com
  description: Azure Cognitive Services Regional Endpoint
  variables:
    region:
      default: eastus
      description: Azure region for the Cognitive Services resource
security:
- apiKey: []
tags:
- name: Chat
  description: Manage chat threads and messages
paths:
  /chat/threads:
    post:
      operationId: createChatThread
      summary: Microsoft Create a chat thread
      description: Create a new chat thread.
      tags:
      - Chat
      parameters:
      - $ref: '#/components/parameters/apiVersion'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateChatThreadRequest'
      responses:
        '201':
          description: Chat thread created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateChatThreadResult'
        '400':
          description: Invalid request
        '401':
          description: Unauthorized
    get:
      operationId: listChatThreads
      summary: Microsoft List chat threads
      description: List all chat threads for the authenticated user.
      tags:
      - Chat
      parameters:
      - $ref: '#/components/parameters/apiVersion'
      - name: maxPageSize
        in: query
        description: Maximum number of threads per page
        schema:
          type: integer
      - name: startTime
        in: query
        description: Start time for the range query
        schema:
          type: string
          format: date-time
      responses:
        '200':
          description: List of chat threads
          content:
            application/json:
              schema:
                type: object
                properties:
                  value:
                    type: array
                    items:
                      $ref: '#/components/schemas/ChatThread'
                  nextLink:
                    type: string
        '401':
          description: Unauthorized
  /chat/threads/{chatThreadId}/messages:
    post:
      operationId: sendChatMessage
      summary: Microsoft Send a chat message
      description: Send a message to a chat thread.
      tags:
      - Chat
      parameters:
      - name: chatThreadId
        in: path
        required: true
        description: Chat thread ID
        schema:
          type: string
      - $ref: '#/components/parameters/apiVersion'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - content
              properties:
                content:
                  type: string
                senderDisplayName:
                  type: string
                type:
                  type: string
                  enum:
                  - text
                  - html
                  default: text
      responses:
        '201':
          description: Message sent
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: string
        '400':
          description: Invalid request
        '401':
          description: Unauthorized
    get:
      operationId: listChatMessages
      summary: Microsoft List chat messages
      description: List messages in a chat thread.
      tags:
      - Chat
      parameters:
      - name: chatThreadId
        in: path
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/apiVersion'
      - name: maxPageSize
        in: query
        schema:
          type: integer
      - name: startTime
        in: query
        schema:
          type: string
          format: date-time
      responses:
        '200':
          description: List of messages
          content:
            application/json:
              schema:
                type: object
                properties:
                  value:
                    type: array
                    items:
                      $ref: '#/components/schemas/ChatMessageItem'
                  nextLink:
                    type: string
        '401':
          description: Unauthorized
components:
  schemas:
    ChatThread:
      type: object
      properties:
        id:
          type: string
        topic:
          type: string
        createdOn:
          type: string
          format: date-time
        createdByCommunicationIdentifier:
          type: object
          properties:
            communicationUserId:
              type: string
        deletedOn:
          type: string
          format: date-time
    ChatMessageItem:
      type: object
      properties:
        id:
          type: string
        type:
          type: string
        content:
          type: object
          properties:
            message:
              type: string
        senderDisplayName:
          type: string
        createdOn:
          type: string
          format: date-time
        senderCommunicationIdentifier:
          type: object
          properties:
            communicationUserId:
              type: string
    CreateChatThreadRequest:
      type: object
      required:
      - topic
      properties:
        topic:
          type: string
        participants:
          type: array
          items:
            type: object
            required:
            - communicationIdentifier
            properties:
              communicationIdentifier:
                type: object
                properties:
                  communicationUserId:
                    type: string
              displayName:
                type: string
    CreateChatThreadResult:
      type: object
      properties:
        chatThread:
          $ref: '#/components/schemas/ChatThread'
        errors:
          type: object
  parameters:
    apiVersion:
      name: api-version
      in: query
      required: true
      description: API version
      schema:
        type: string
        default: 2024-03-15-preview
  securitySchemes:
    apiKey:
      type: apiKey
      name: Ocp-Apim-Subscription-Key
      in: header
      description: Azure Cognitive Services subscription key
externalDocs:
  description: Azure AI Services Documentation
  url: https://learn.microsoft.com/en-us/azure/ai-services/