> ## Documentation Index
> Fetch the complete documentation index at: https://docs.superoffice.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get Chatbot Turns

> Returns stored history of chat messages for a given chat_id.

Chat_id is usually derived from soproto + current id, but could also be arbitrary name.
NsApiSlow threshold: 2000 ms.
<para />## Experimental: ## The AI agent is experimental, subject to change, and not intended for partners.



## OpenAPI

````yaml /openapi/agent/openapi-v3-AIAgent.json post /api/v1/Agents/AI/GetChatbotTurns
openapi: 3.0.0
info:
  version: v1-Agents
  title: SuperOffice Agent API v1
  description: SuperOffice Agent API - AIAgent
  contact:
    name: SuperOffice DevNet
    url: https://docs.superoffice.com/en/api/index.html
    email: sdk@superoffice.com
servers:
  - url: http://localhost:56350
  - url: https://localhost:56350
security: []
tags: []
externalDocs:
  description: >-
    The SuperOffice DevNet Community has more documentation, examples, and
    discussion forums.
  url: https://community.superoffice.com/en/developer/
paths:
  /api/v1/Agents/AI/GetChatbotTurns:
    post:
      tags:
        - AI_Agent
      summary: Get Chatbot Turns
      description: "Returns stored history of chat messages for a given chat_id.\n\nChat_id is usually derived from soproto + current id, but could also be arbitrary name.\r\nNsApiSlow threshold: 2000 ms.\r\n<para />## Experimental: ## The AI agent is experimental, subject to change, and not intended for partners."
      operationId: v1AIAgent_GetChatbotTurns
      parameters:
        - name: $select
          in: query
          description: >-
            Optional comma separated list of properties to include in the
            result. Other fields are then nulled out to reduce payload size:
            "Name,department,category". Default = show all fields.
          required: false
          schema:
            type: string
        - name: Accept-Language
          in: header
          description: >-
            Convert string references and multi-language values into a specified
            language (iso2) code.
          required: false
          schema:
            type: string
        - name: SO-Language
          in: header
          description: >-
            Convert string references and multi-language values into a specified
            language (iso2) code. Overrides Accept-Language value.
          required: false
          schema:
            type: string
        - name: SO-Culture
          in: header
          description: >-
            Number, date formatting in a specified culture (iso2 language) code.
            Partially overrides SO-Language/Accept-Language value. Ignored if no
            Language set.
          required: false
          schema:
            type: string
        - name: SO-TimeZone
          in: header
          description: >-
            Specify the timezone code that you would like date/time responses
            converted to.
          required: false
          schema:
            type: string
        - name: SO-AppToken
          in: header
          description: >-
            The application token that identifies the partner app. Used when
            calling Online WebAPI from a server.
          required: false
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: >-
                #/components/schemas/SuperOffice.WebApi.v1.Carriers.AICarriers.GetChatbotTurnsRequest
          text/json:
            schema:
              $ref: >-
                #/components/schemas/SuperOffice.WebApi.v1.Carriers.AICarriers.GetChatbotTurnsRequest
          application/xml:
            schema:
              $ref: >-
                #/components/schemas/SuperOffice.WebApi.v1.Carriers.AICarriers.GetChatbotTurnsRequest
          text/xml:
            schema:
              $ref: >-
                #/components/schemas/SuperOffice.WebApi.v1.Carriers.AICarriers.GetChatbotTurnsRequest
          application/x-www-form-urlencoded:
            schema:
              $ref: >-
                #/components/schemas/SuperOffice.WebApi.v1.Carriers.AICarriers.GetChatbotTurnsRequest
          application/json-patch+json:
            schema:
              $ref: >-
                #/components/schemas/SuperOffice.WebApi.v1.Carriers.AICarriers.GetChatbotTurnsRequest
          application/merge-patch+json:
            schema:
              $ref: >-
                #/components/schemas/SuperOffice.WebApi.v1.Carriers.AICarriers.GetChatbotTurnsRequest
        description: ChatId
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/SuperOffice.CRM.Services.ChatbotTurn'
            text/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/SuperOffice.CRM.Services.ChatbotTurn'
            application/xml:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/SuperOffice.CRM.Services.ChatbotTurn'
            text/xml:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/SuperOffice.CRM.Services.ChatbotTurn'
            application/json-patch+json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/SuperOffice.CRM.Services.ChatbotTurn'
            application/merge-patch+json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/SuperOffice.CRM.Services.ChatbotTurn'
      security:
        - SuperOffice_Password: []
          SuperId_Authentication: []
components:
  schemas:
    SuperOffice.WebApi.v1.Carriers.AICarriers.GetChatbotTurnsRequest:
      description: >-
        GetChatbotTurns: Returns stored history of chat messages for a given
        chat_id. Chat_id is usually derived from soproto + current id, but could
        also be arbitrary name.
      type: object
      properties:
        ChatId:
          type: string
    SuperOffice.CRM.Services.ChatbotTurn:
      description: "Chat turn contains one user question, an optional display value for the user prompt, and one chatbot response.\r\n<para />\r\nCarrier object for ChatbotTurn.\r\nServices for the ChatbotTurn Carrier is available from the <see cref=\"T:SuperOffice.CRM.Services.IAIAgent\">AI Agent</see>."
      type: object
      properties:
        Timestamp:
          format: date-time
          description: UTC timestamp for turn - when response was generated.
          type: string
        UserPrompt:
          description: Text from the user
          type: string
        UserDisplayText:
          description: Optional display value to use instead of the the UserPrompt
          type: string
        BotResponse:
          description: Text from the chatbot
          type: string
        BotActions:
          description: >-
            optional dictionary of action buttons. Key = Display text, Value =
            Prompt text
          type: object
          additionalProperties:
            type: string
        Attachments:
          description: optional array of attachments - can be URL or Base64 encoded data
          type: array
          items:
            type: string

````

## Related topics

- [SuperOffice.WebApi.Data.AI GetChatbotTurnsRequest](/en/api/reference/webapi/SuperOffice.WebApi.Data.AI_GetChatbotTurnsRequest.md)
- [Clear Chatbot Turns](/en/api/reference/restful/agent/ai_agent/clear-chatbot-turns.md)
- [Get Chatbot Response](/en/api/reference/restful/agent/ai_agent/get-chatbot-response.md)
- [SuperOffice.WebApi.Data.ChatbotTurn](/en/api/reference/webapi/SuperOffice.WebApi.Data.ChatbotTurn.md)
- [SuperOffice.WebApi.Data.AI ClearChatbotTurnsRequest](/en/api/reference/webapi/SuperOffice.WebApi.Data.AI_ClearChatbotTurnsRequest.md)
- [Get Chatbot Prompt Suggestions](/en/api/reference/restful/agent/ai_agent/get-chatbot-prompt-suggestions.md)
