Microsoft Azure Threads API

swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector Threads API
schemes:
- https
tags:
- name: Threads
paths:
  /chat/threads/{chatThreadId}/readReceipts:
    get:
      tags:
      - Threads
      summary: Microsoft Azure Gets Chat Message Read Receipts For A Thread
      operationId: microsoftAzureChatthreadListchatreadreceipts
      produces:
      - application/json
      parameters:
      - in: path
        name: chatThreadId
        description: Thread id to get the chat message read receipts for.
        required: true
        type: string
      - in: query
        name: maxPageSize
        description: The maximum number of chat message read receipts to be returned per page.
        type: integer
        format: int32
      - in: query
        name: skip
        description: Skips chat message read receipts up to a specified position in response.
        type: integer
        format: int32
      - $ref: '#/parameters/ApiVersionParameter'
      responses:
        '200':
          description: Request successful. The action returns the requested `ChatMessageReadReceipt` resources.
          schema:
            $ref: '#/definitions/ChatMessageReadReceiptsCollection'
        '401':
          description: Unauthorized.
          schema:
            $ref: '#/definitions/CommunicationErrorResponse'
          x-ms-error-response: true
        '403':
          description: Forbidden.
          schema:
            $ref: '#/definitions/CommunicationErrorResponse'
          x-ms-error-response: true
        '429':
          description: Too many requests.
          schema:
            $ref: '#/definitions/CommunicationErrorResponse'
          x-ms-error-response: true
        '503':
          description: Service unavailable.
          schema:
            $ref: '#/definitions/CommunicationErrorResponse'
          x-ms-error-response: true
      x-ms-examples:
        Get thread read receipts with pagination (max page size):
          $ref: ./examples/Conversations_ListChatReadReceiptsWithPageSize.json
      x-ms-pageable:
        nextLinkName: nextLink
        itemName: value
      description: Needs a more full description created.
    post:
      tags:
      - Threads
      summary: Microsoft Azure Sends A Read Receipt Event To A Thread, On Behalf Of A User
      operationId: microsoftAzureChatthreadSendchatreadreceipt
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - in: path
        name: chatThreadId
        description: Thread id to send the read receipt event to.
        required: true
        type: string
      - $ref: '#/parameters/ApiVersionParameter'
      - in: body
        name: sendReadReceiptRequest
        description: Read receipt details.
        required: true
        schema:
          $ref: '#/definitions/SendReadReceiptRequest'
      responses:
        '200':
          description: Request successful.
        '401':
          description: Unauthorized.
          schema:
            $ref: '#/definitions/CommunicationErrorResponse'
          x-ms-error-response: true
        '403':
          description: Forbidden.
          schema:
            $ref: '#/definitions/CommunicationErrorResponse'
          x-ms-error-response: true
        '429':
          description: Too many requests.
          schema:
            $ref: '#/definitions/CommunicationErrorResponse'
          x-ms-error-response: true
        '503':
          description: Service unavailable.
          schema:
            $ref: '#/definitions/CommunicationErrorResponse'
          x-ms-error-response: true
      x-ms-examples:
        Send read receipt:
          $ref: ./examples/Conversations_SendChatReadReceipt.json
      description: Needs a more full description created.
  /chat/threads:
    post:
      tags:
      - Threads
      summary: Microsoft Azure Creates A Chat Thread
      operationId: microsoftAzureChatCreatechatthread
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - in: header
        name: repeatability-request-id
        description: If specified, the client directs that the request is repeatable; that is, that the client can make the request multiple times with the same Repeatability-Request-Id and get back an appropriate response without the server executing the request multiple times. The value of the Repeatability-Request-Id is an opaque string representing a client-generated, globally unique for all time, identifier for the request. It is recommended to use version 4 (random) UUIDs.
        type: string
      - $ref: '#/parameters/ApiVersionParameter'
      - in: body
        name: createChatThreadRequest
        description: Request payload for creating a chat thread.
        required: true
        schema:
          $ref: '#/definitions/CreateChatThreadRequest'
      responses:
        '201':
          description: Thread created, the `Location` header would contain the URL for the newly created thread.
          schema:
            $ref: '#/definitions/CreateChatThreadResult'
        '401':
          description: Unauthorized.
          schema:
            $ref: '#/definitions/CommunicationErrorResponse'
          x-ms-error-response: true
        '403':
          description: Forbidden.
          schema:
            $ref: '#/definitions/CommunicationErrorResponse'
          x-ms-error-response: true
        '429':
          description: Too many requests.
          schema:
            $ref: '#/definitions/CommunicationErrorResponse'
          x-ms-error-response: true
        '503':
          description: Service unavailable.
          schema:
            $ref: '#/definitions/CommunicationErrorResponse'
          x-ms-error-response: true
      x-ms-examples:
        Create chat thread:
          $ref: ./examples/Threads_CreateChatThread.json
        Create chat thread with repeatability request id header:
          $ref: ./examples/Threads_CreateChatThreadWithIdempotencyToken.json
      description: Needs a more full description created.
    get:
      tags:
      - Threads
      summary: Microsoft Azure Gets The List Of Chat Threads Of A User
      operationId: microsoftAzureChatListchatthreads
      produces:
      - application/json
      parameters:
      - in: query
        name: maxPageSize
        description: The maximum number of chat threads returned per page.
        type: integer
        format: int32
      - in: query
        name: startTime
        description: 'The earliest point in time to get chat threads up to. The timestamp should be in RFC3339 format: `yyyy-MM-ddTHH:mm:ssZ`.'
        type: string
        format: date-time
      - $ref: '#/parameters/ApiVersionParameter'
      responses:
        '200':
          description: Request successful. The action returns a `GetThreadsResponse` resource.
          schema:
            $ref: '#/definitions/ChatThreadsItemCollection'
        '401':
          description: Unauthorized.
          schema:
            $ref: '#/definitions/CommunicationErrorResponse'
          x-ms-error-response: true
        '403':
          description: Forbidden.
          schema:
            $ref: '#/definitions/CommunicationErrorResponse'
          x-ms-error-response: true
        '429':
          description: Too many requests.
          schema:
            $ref: '#/definitions/CommunicationErrorResponse'
          x-ms-error-response: true
        '503':
          description: Service unavailable.
          schema:
            $ref: '#/definitions/CommunicationErrorResponse'
          x-ms-error-response: true
      x-ms-examples:
        Get threads with pagination (Max Page Size):
          $ref: ./examples/Threads_ListChatThreadsWithPageSize.json
      x-ms-pageable:
        nextLinkName: nextLink
        itemName: value
      description: Needs a more full description created.
  /chat/threads/{chatThreadId}:
    patch:
      tags:
      - Threads
      summary: Microsoft Azure Updates A Thread S Properties
      operationId: microsoftAzureChatthreadUpdatechatthreadproperties
      consumes:
      - application/merge-patch+json
      produces:
      - application/json
      parameters:
      - in: path
        name: chatThreadId
        description: The id of the thread to update.
        required: true
        type: string
      - $ref: '#/parameters/ApiVersionParameter'
      - in: body
        name: updateChatThreadRequest
        description: Request payload for updating a chat thread.
        required: true
        schema:
          $ref: '#/definitions/UpdateChatThreadRequest'
      responses:
        '204':
          description: Thread was successfully updated.
        '401':
          description: Unauthorized.
          schema:
            $ref: '#/definitions/CommunicationErrorResponse'
          x-ms-error-response: true
        '403':
          description: Forbidden.
          schema:
            $ref: '#/definitions/CommunicationErrorResponse'
          x-ms-error-response: true
        '429':
          description: Too many requests.
          schema:
            $ref: '#/definitions/CommunicationErrorResponse'
          x-ms-error-response: true
        '503':
          description: Service unavailable.
          schema:
            $ref: '#/definitions/CommunicationErrorResponse'
          x-ms-error-response: true
      x-ms-examples:
        Update chat thread topic:
          $ref: ./examples/Threads_UpdateChatThreadTopic.json
      description: Needs a more full description created.
    get:
      tags:
      - Threads
      summary: Microsoft Azure Gets A Chat Thread S Properties
      operationId: microsoftAzureChatthreadGetchatthreadproperties
      produces:
      - application/json
      parameters:
      - in: path
        name: chatThreadId
        description: Id of the thread.
        required: true
        type: string
      - $ref: '#/parameters/ApiVersionParameter'
      responses:
        '200':
          description: Request successful. The action returns a chat thread.
          schema:
            $ref: '#/definitions/ChatThreadProperties'
        '401':
          description: Unauthorized.
          schema:
            $ref: '#/definitions/CommunicationErrorResponse'
          x-ms-error-response: true
        '403':
          description: Forbidden.
          schema:
            $ref: '#/definitions/CommunicationErrorResponse'
          x-ms-error-response: true
        '429':
          description: Too many requests.
          schema:
            $ref: '#/definitions/CommunicationErrorResponse'
          x-ms-error-response: true
        '503':
          description: Service unavailable.
          schema:
            $ref: '#/definitions/CommunicationErrorResponse'
          x-ms-error-response: true
      x-ms-examples:
        Get chat thread:
          $ref: ./examples/Threads_GetChatThread.json
      description: Needs a more full description created.
    delete:
      tags:
      - Threads
      summary: Microsoft Azure Deletes A Thread
      operationId: microsoftAzureChatDeletechatthread
      produces:
      - application/json
      parameters:
      - in: path
        name: chatThreadId
        description: Id of the thread to be deleted.
        required: true
        type: string
      - $ref: '#/parameters/ApiVersionParameter'
      responses:
        '204':
          description: Request successful.
        '401':
          description: Unauthorized.
          schema:
            $ref: '#/definitions/CommunicationErrorResponse'
          x-ms-error-response: true
        '403':
          description: Forbidden.
          schema:
            $ref: '#/definitions/CommunicationErrorResponse'
          x-ms-error-response: true
        '429':
          description: Too many requests.
          schema:
            $ref: '#/definitions/CommunicationErrorResponse'
          x-ms-error-response: true
        '503':
          description: Service unavailable.
          schema:
            $ref: '#/definitions/CommunicationErrorResponse'
          x-ms-error-response: true
      x-ms-examples:
        Delete chat thread:
          $ref: ./examples/Threads_DeleteChatThread.json
      description: Needs a more full description created.
  /threads:
    post:
      operationId: microsoftAzureCreatethread
      description: Creates a new thread. Threads contain messages and can be run by assistants.
      parameters:
      - name: body
        in: body
        required: true
        schema:
          $ref: '#/definitions/AssistantThreadCreationOptions'
      responses:
        '200':
          description: Information about the newly created thread.
          schema:
            $ref: '#/definitions/AssistantThread'
      summary: Microsoft Azure Post Threads
      tags:
      - Threads
  /threads/{threadId}:
    get:
      operationId: microsoftAzureGetthread
      description: Gets information about an existing thread.
      parameters:
      - name: threadId
        in: path
        description: The ID of the thread to retrieve information about.
        required: true
        type: string
      responses:
        '200':
          description: Information about the requested thread.
          schema:
            $ref: '#/definitions/AssistantThread'
      summary: Microsoft Azure Get Threads Threadid
      tags:
      - Threads
    post:
      operationId: microsoftAzureModifythread
      description: Modifies an existing thread.
      parameters:
      - name: threadId
        in: path
        description: The ID of the thread to modify.
        required: true
        type: string
      - name: body
        in: body
        required: true
        schema:
          type: object
          properties:
            metadata:
              type: object
              description: A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length.
              x-nullable: true
              additionalProperties:
                type: string
      responses:
        '200':
          description: Information about the modified thread.
          schema:
            $ref: '#/definitions/AssistantThread'
      summary: Microsoft Azure Post Threads Threadid
      tags:
      - Threads
    delete:
      operationId: microsoftAzureDeletethread
      description: Deletes an existing thread.
      parameters:
      - name: threadId
        in: path
        description: The ID of the thread to delete.
        required: true
        type: string
      responses:
        '200':
          description: Status information about the requested thread deletion operation.
          schema:
            $ref: '#/definitions/ThreadDeletionStatus'
      summary: Microsoft Azure Delete Threads Threadid
      tags:
      - Threads
  /threads/{threadId}/messages:
    get:
      operationId: microsoftAzureListmessages
      description: Gets a list of messages that exist on a thread.
      parameters:
      - name: threadId
        in: path
        description: The ID of the thread to list messages from.
        required: true
        type: string
      - name: limit
        in: query
        description: A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.
        required: false
        type: integer
        format: int32
        default: 20
      - name: order
        in: query
        description: Sort order by the created_at timestamp of the objects. asc for ascending order and desc for descending order.
        required: false
        type: string
        default: desc
        enum:
        - asc
        - desc
        x-ms-enum:
          name: ListSortOrder
          modelAsString: true
          values:
          - name: ascending
            value: asc
            description: Specifies an ascending sort order.
          - name: descending
            value: desc
            description: Specifies a descending sort order.
      - name: after
        in: query
        description: A cursor for use in pagination. after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list.
        required: false
        type: string
      - name: before
        in: query
        description: A cursor for use in pagination. before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list.
        required: false
        type: string
      responses:
        '200':
          description: The requested list of messages.
          schema:
            type: object
            description: The response data for a requested list of items.
            properties:
              object:
                type: string
                description: The object type, which is always list.
                enum:
                - list
                x-ms-enum:
                  modelAsString: false
              data:
                type: array
                description: The requested list of items.
                items:
                  $ref: '#/definitions/ThreadMessage'
              first_id:
                type: string
                description: The first ID represented in this list.
                x-ms-client-name: firstId
              last_id:
                type: string
                description: The last ID represented in this list.
                x-ms-client-name: lastId
              has_more:
                type: boolean
                description: A value indicating whether there are additional values available not captured in this list.
                x-ms-client-name: hasMore
            required:
            - object
            - data
            - first_id
            - last_id
            - has_more
      summary: Microsoft Azure Get Threads Threadid Messages
      tags:
      - Threads
    post:
      operationId: microsoftAzureCreatemessage
      description: Creates a new message on a specified thread.
      parameters:
      - name: threadId
        in: path
        description: The ID of the thread to create the new message on.
        required: true
        type: string
      - name: body
        in: body
        required: true
        schema:
          type: object
          properties:
            role:
              $ref: '#/definitions/MessageRole'
              description: The role to associate with the new message.
            content:
              type: string
              description: The textual content for the new message.
            file_ids:
              type: array
              description: A list of up to 10 file IDs to associate with the message, as used by tools like 'code_interpreter' or 'retrieval' that can read files.
              items:
                type: string
              x-ms-client-name: fileIds
            metadata:
              type: object
              description: A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length.
              x-nullable: true
              additionalProperties:
                type: string
          required:
          - role
          - content
      responses:
        '200':
          description: A representation of the new message.
          schema:
            $ref: '#/definitions/ThreadMessage'
      summary: Microsoft Azure Post Threads Threadid Messages
      tags:
      - Threads
  /threads/{threadId}/messages/{messageId}:
    get:
      operationId: microsoftAzureGetmessage
      description: Gets an existing message from an existing thread.
      parameters:
      - name: threadId
        in: path
        description: The ID of the thread to retrieve the specified message from.
        required: true
        type: string
      - name: messageId
        in: path
        description: The ID of the message to retrieve from the specified thread.
        required: true
        type: string
      responses:
        '200':
          description: A representation of the requested message.
          schema:
            $ref: '#/definitions/ThreadMessage'
      summary: Microsoft Azure Get Threads Threadid Messages Messageid
      tags:
      - Threads
    post:
      operationId: microsoftAzureModifymessage
      description: Modifies an existing message on an existing thread.
      parameters:
      - name: threadId
        in: path
        description: The ID of the thread containing the specified message to modify.
        required: true
        type: string
      - name: messageId
        in: path
        description: The ID of the message to modify on the specified thread.
        required: true
        type: string
      - name: body
        in: body
        required: true
        schema:
          type: object
          properties:
            metadata:
              type: object
              description: A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length.
              x-nullable: true
              additionalProperties:
                type: string
      responses:
        '200':
          description: A representation of the modified message.
          schema:
            $ref: '#/definitions/ThreadMessage'
      summary: Microsoft Azure Post Threads Threadid Messages Messageid
      tags:
      - Threads
  /threads/{threadId}/messages/{messageId}/files:
    get:
      operationId: microsoftAzureListmessagefiles
      description: Gets a list of previously uploaded files associated with a message from a thread.
      parameters:
      - name: threadId
        in: path
        description: The ID of the thread containing the message to list files from.
        required: true
        type: string
      - name: messageId
        in: path
        description: The ID of the message to list files from.
        required: true
        type: string
      - name: limit
        in: query
        description: A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.
        required: false
        type: integer
        format: int32
        default: 20
      - name: order
        in: query
        description: Sort order by the created_at timestamp of the objects. asc for ascending order and desc for descending order.
        required: false
        type: string
        default: desc
        enum:
        - asc
        - desc
        x-ms-enum:
          name: ListSortOrder
          modelAsString: true
          values:
          - name: ascending
            value: asc
            description: Specifies an ascending sort order.
          - name: descending
            value: desc
            description: Specifies a descending sort order.
      - name: after
        in: query
        description: A cursor for use in pagination. after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list.
        required: false
        type: string
      - name: before
        in: query
        description: A cursor for use in pagination. before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list.
        required: false
        type: string
      responses:
        '200':
          description: The requested list of files associated with the specified message.
          schema:
            type: object
            description: The response data for a requested list of items.
            properties:
              object:
                type: string
                description: The object type, which is always list.
                enum:
                - list
                x-ms-enum:
                  modelAsString: false
              data:
                type: array
                description: The requested list of items.
                items:
                  $ref: '#/definitions/MessageFile'
              first_id:
                type: string
                description: The first ID represented in this list.
                x-ms-client-name: firstId
              last_id:
                type: string
                description: The last ID represented in this list.
                x-ms-client-name: lastId
              has_more:
                type: boolean
                description: A value indicating whether there are additional values available not captured in this list.
                x-ms-client-name: hasMore
            required:
            - object
            - data
            - first_id
            - last_id
            - has_more
      summary: Microsoft Azure Get Threads Threadid Messages Messageid Files
      tags:
      - Threads
  /threads/{threadId}/messages/{messageId}/files/{fileId}:
    get:
      operationId: microsoftAzureGetmessagefile
      description: Gets information about a file attachment to a message within a thread.
      parameters:
      - name: threadId
        in: path
        description: The ID of the thread containing the message to get information from.
        required: true
        type: string
      - name: messageId
        in: path
        description: The ID of the message to get information from.
        required: true
        type: string
      - name: fileId
        in: path
        description: The ID of the file to get information about.
        required: true
        type: string
      responses:
        '200':
          description: The requested file information.
          schema:
            $ref: '#/definitions/MessageFile'
      summary: Microsoft Azure Get Threads Threadid Messages Messageid Files Fileid
      tags:
      - Threads
  /threads/{threadId}/runs:
    get:
      operationId: microsoftAzureListruns
      description: Gets a list of runs for a specified thread.
      parameters:
      - name: threadId
        in: path
        description: The ID of the thread to list runs from.
        required: true
        type: string
      - name: limit
        in: query
        description: A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.
        required: false
        type: integer
        format: int32
        default: 20
      - name: order
        in: query
        description: Sort order by the created_at timestamp of the objects. asc for ascending order and desc for descending order.
        required: false
        type: string
        default: desc
        enum:
        - asc
        - desc
        x-ms-enum:
          name: ListSortOrder
          modelAsString: true
          values:
          - name: ascending
            value: asc
            description: Specifies an ascending sort order.
          - name: descending
            value: desc
            description: Specifies a descending sort order.
      - name: after
        in: query
        description: A cursor for use in pagination. after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list.
        required: false
        type: string
      - name: before
        in: query
        description: A cursor for use in pagination. before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list.
        required: false
        type: string
      responses:
        '200':
          description: The requested list of thread runs.
          schema:
            type: object
            description: The response data for a requested list of items.
            properties:
              object:
                type: string
                description: The object type, which is always list.
                enum:
                - list
                x-ms-enum:
                  modelAsString: false
              data:
                type: array
                description: The requested list of items.
                items:
                  $ref: '#/definitions/ThreadRun'
              first_id:
                type: string
                description: The first ID represented in this list.
                x-ms-client-name: firstId
              last_id:
                type: string
                description: The last ID represented in this list.
                x-ms-client-name: lastId
              has_more:
                type: boolean
                description: A value indicating whether there are additional values available not captured in this list.
                x-ms-client-name: hasMore
            required:
            - object
            - data
            - first_id
            - last_id
            - has_more
      summary: Microsoft Azure Get Threads Threadid Runs
      tags:
      - Threads
    post:
      operationId: microsoftAzureCreaterun
      description: Creates a new run for an assistant thread.
      parameters:
      - name: threadId
        in: path
        description: The ID of the thread to run.
        required: true
        type: string
      - name: body
        in: body
        required: true
        schema:
          type: object
          properties:
            assistant_id:
              type: string
              description: The ID of the assistant that should run the thread.
              x-ms-client-name: assistantId
            model:
              type: string
              description: The overridden model name that the assistant should use to run the thread.
            instructions:
              type: string
              description: The overridden system instructions that the assistant should use to run the thread.
            tools:
              type: array
              description: The overridden list of enabled tools that the assistant should use to run the thread.
              items:
                $ref: '#/definitions/ToolDefinition'
              x-ms-identifiers: []
            metadata:
              type: object
              description: A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length.
              x-nullable: true
              additionalProperties:
                type: string
          required:
          - assistant_id
      responses:
        '200':
          description: Information about the new thread run.
          schema:
            $ref: '#/definitions/ThreadRun'
      summary: Microsoft Azure Post Threads Threadid Runs
      tags:
      - Threads
  /threads/{threadId}/runs/{runId}:
    get:
      operationId: microsoftAzureGetrun
      description: Gets an existing run from an existing thread.
      parameters:
      - name: threadId
        in: path
        description: The ID of the thread to retrieve run information from.
        required: true
        type: string
      - name: runId
        in: path
        description: The ID of the thread to retrieve information about.
        required: true
        type: string
      responses:
        '200':
          description: The requested information about the specified thread run.
          schema:
            $ref: '#/definitions/ThreadRun'
      summary: Microsoft Azure Get Threads Threadid Runs Runid
      tags:
      - Threads
    post:
      operationId: microsoftAzureModifyrun
      description: Modifies an existing thread run.
      parameters:
      - name: threadId
        in: path
        description: The ID of the thre

# --- truncated at 32 KB (67 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/microsoft-azure/refs/heads/main/openapi/microsoft-azure-threads-api-openapi.yml