Cisco Secure Firewall Conversation API

openapi: 3.2.0
info:
  description: APIs for interacting with AI Assistant
  title: AI Assistant Conversation API
  version: 2.0.0
  x-provenance:
    method: harvested
    authored_by: Cisco Security Cloud Control
    harvested_by: API Evangelist
    harvested_on: '2026-08-19'
    first_party: true
    note: Published by Cisco. Retrieved unmodified except for this x-provenance block.
    provider_published: true
  x-evidence:
  - type: source
    url: https://github.com/CiscoDevNet/scc-public-api-docs/blob/main/specs/ai-assistant.yaml
  - type: raw
    url: https://raw.githubusercontent.com/CiscoDevNet/scc-public-api-docs/main/specs/ai-assistant.yaml
servers:
- description: AI Assistant Production API Server (NAM region)
  url: https://api.security.cisco.com/api/ai-assistant
tags:
- description: Conversation APIs
  name: Conversation
paths:
  /v2/conversations:
    get:
      operationId: listConversations
      parameters:
      - description: Client product identifier
        in: header
        name: x-aiassistant-client-product
        required: true
        schema:
          type: string
      - description: max number of conversations to return
        in: query
        name: limit
        required: false
        schema:
          type: integer
      - description: offset used to retrieve next set of conversations with desired limit
        in: query
        name: offset
        required: false
        schema:
          type: integer
      - description: order of conversations to be shown based on sort by value
        in: query
        name: order
        required: false
        schema:
          enum:
          - DESC
          - ASC
          type: string
      - description: value to sort the conversations by
        in: query
        name: sort_by
        required: false
        schema:
          enum:
          - last_interaction_date
          type: string
      - description: Array containing which conversations with specified label/s name to show in the resulting list. This should have the same length as label_value_filter
        in: query
        name: label_name_filter
        required: false
        schema:
          items:
            type: string
          type: array
      - description: Array containing which conversations with specified label/s value to show in the resulting list. This should have the same length as label_name_filter
        in: query
        name: label_value_filter
        required: false
        schema:
          items:
            type: string
          type: array
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/conversationListResponse'
          description: Conversations retrieved successfully.
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorResponse'
          description: Bad request or missing fields
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorResponse'
          description: Unauthorized
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorResponse'
          description: Forbidden
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorResponse'
          description: Tenant Not found
        '500':
          description: Internal server error
      security:
      - bearerAuth: []
      summary: List conversations along with details in paginated form
      tags:
      - Conversation
    post:
      operationId: createConversation
      parameters:
      - description: Client product identifier
        in: header
        name: x-aiassistant-client-product
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/createConversationRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/createConversationResponse'
          description: Conversation created successfully
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorResponse'
          description: Bad request or missing fields
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorResponse'
          description: Unauthorized
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorResponse'
          description: Forbidden
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorResponse'
          description: Tenant Not found
        '500':
          description: Internal server error
      security:
      - bearerAuth: []
      summary: Create new conversation for a given user
      tags:
      - Conversation
  /v2/conversations/{conversation_id}:
    delete:
      description: Deletes a specific conversation by its conversation ID.
      operationId: deleteConversation
      parameters:
      - description: The ID of the conversation to delete.
        in: path
        name: conversation_id
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful deletion of the conversation
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorResponse'
          description: Unauthorized
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorResponse'
          description: Forbidden
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorResponse'
          description: Conversation not found
      security:
      - bearerAuth: []
      summary: Delete a conversation
      tags:
      - Conversation
    get:
      operationId: getConversation
      parameters:
      - description: Client product identifier
        in: header
        name: x-aiassistant-client-product
        required: true
        schema:
          type: string
      - description: ID of conversation to fetch
        in: path
        name: conversation_id
        required: true
        schema:
          format: uuid
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/conversationGetResponse'
          description: Conversation retrieved successfully.
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorResponse'
          description: Bad request or missing fields
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorResponse'
          description: Unauthorized
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorResponse'
          description: Forbidden
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorResponse'
          description: Conversation Not found
        '500':
          description: Internal server error
      security:
      - bearerAuth: []
      summary: Get Conversation details along with chat history for this particular conversation
      tags:
      - Conversation
  /v2/conversations/{conversation_id}/addLabel:
    put:
      operationId: addLabel
      parameters:
      - description: Client product identifier
        in: header
        name: x-aiassistant-client-product
        required: true
        schema:
          type: string
      - description: ID of conversation to retrieve messages from
        in: path
        name: conversation_id
        required: true
        schema:
          format: uuid
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/addLabelRequest'
        required: true
      responses:
        '200':
          description: Labels added successfully
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorResponse'
          description: Bad request or missing fields
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorResponse'
          description: Unauthorized
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorResponse'
          description: Forbidden
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorResponse'
          description: Conversation Not found
        '500':
          description: Internal server error
      security:
      - bearerAuth: []
      summary: Add label/s to a conversation's metadata - can be used for filtering
      tags:
      - Conversation
  /v2/conversations/{conversation_id}/description:
    put:
      operationId: updateConversationDescription
      parameters:
      - description: Client product identifier
        in: header
        name: x-aiassistant-client-product
        required: true
        schema:
          type: string
      - description: ID of conversation to update.
        in: path
        name: conversation_id
        required: true
        schema:
          format: uuid
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/updateConversationRequest'
        required: true
      responses:
        '200':
          description: Conversation updated successfully.
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorResponse'
          description: Bad request or missing fields
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorResponse'
          description: Unauthorized
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorResponse'
          description: Forbidden
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorResponse'
          description: Conversation Not found
        '500':
          description: Internal server error
      security:
      - bearerAuth: []
      summary: Update conversation description by providing conversation id
      tags:
      - Conversation
  /v2/conversations/{conversation_id}/history:
    get:
      operationId: listHistory
      parameters:
      - description: Client product identifier
        in: header
        name: x-aiassistant-client-product
        required: true
        schema:
          type: string
      - description: ID of conversation to retrieve messages from
        in: path
        name: conversation_id
        required: true
        schema:
          format: uuid
          type: string
      - description: offset used to retrieve the desired set of messages
        in: query
        name: offset
        required: true
        schema:
          type: integer
      - description: max number of messages to return
        in: query
        name: limit
        required: true
        schema:
          type: integer
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/historyListResponse'
          description: Messages retrieved successfully
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorResponse'
          description: Bad request or missing fields
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorResponse'
          description: Unauthorized
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorResponse'
          description: Forbidden
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorResponse'
          description: Conversation Not found
        '500':
          description: Internal server error
      security:
      - bearerAuth: []
      summary: Retrieve conversation's messages with additional information, in the reverse order of their creation.
      tags:
      - Conversation
  /v2/conversations/{conversation_id}/message:
    get:
      operationId: listMessages
      parameters:
      - description: Client product identifier
        in: header
        name: x-aiassistant-client-product
        required: true
        schema:
          type: string
      - description: ID of conversation to retrieve messages from
        in: path
        name: conversation_id
        required: true
        schema:
          format: uuid
          type: string
      - description: offset used to retrieve the desired set of messages
        in: query
        name: offset
        required: true
        schema:
          type: integer
      - description: max number of messages to return
        in: query
        name: limit
        required: true
        schema:
          type: integer
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/messageListResponse'
          description: Messages retrieved successfully
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorResponse'
          description: Bad request or missing fields
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorResponse'
          description: Unauthorized
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorResponse'
          description: Forbidden
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorResponse'
          description: Conversation Not found
        '500':
          description: Internal server error
      security:
      - bearerAuth: []
      summary: Retrieve conversation's messages, in the reverse order of their creation.
      tags:
      - Conversation
    post:
      operationId: createMessage
      parameters:
      - description: Client product identifier
        in: header
        name: x-aiassistant-client-product
        required: true
        schema:
          type: string
      - description: ID of conversation to add message to
        in: path
        name: conversation_id
        required: true
        schema:
          format: uuid
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/postMessageRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/postMessageResponse'
          description: Message added to conversation successfully
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorResponse'
          description: Bad request or missing fields
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorResponse'
          description: Unauthorized
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorResponse'
          description: Forbidden
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorResponse'
          description: Conversation Not found
        '500':
          description: Internal server error
      security:
      - bearerAuth: []
      summary: Post request message to an existing active conversation
      tags:
      - Conversation
  /v2/conversations/{conversation_id}/message/{message_id}:
    get:
      operationId: getMessage
      parameters:
      - description: Client product identifier
        in: header
        name: x-aiassistant-client-product
        required: true
        schema:
          type: string
      - description: ID of conversation the message is associated with
        in: path
        name: conversation_id
        required: true
        schema:
          format: uuid
          type: string
      - description: ID of the message to poll
        in: path
        name: message_id
        required: true
        schema:
          format: uuid
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/messageGetResponse'
          description: Message retrieved successfully
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorResponse'
          description: Bad request or missing fields
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorResponse'
          description: Unauthorized
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorResponse'
          description: Forbidden
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorResponse'
          description: Message Not found
        '500':
          description: Internal server error
      security:
      - bearerAuth: []
      summary: Retrieve a message using conversation_id and message_id
      tags:
      - Conversation
  /v2/conversations/{conversation_id}/message/{message_id}/feedback:
    get:
      operationId: listFeedback
      parameters:
      - description: Client product identifier
        in: header
        name: x-aiassistant-client-product
        required: true
        schema:
          type: string
      - description: ID of the conversation to list feedback for
        in: path
        name: conversation_id
        required: true
        schema:
          format: uuid
          type: string
      - description: ID of the message to list feedback for
        in: path
        name: message_id
        required: true
        schema:
          format: uuid
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/listFeedbackResponse'
          description: List of feedback retrieved successfully.
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorResponse'
          description: Bad request or missing fields
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorResponse'
          description: Unauthorized
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorResponse'
          description: Forbidden
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorResponse'
          description: Message Not found
        '500':
          description: Internal server error
      security:
      - bearerAuth: []
      summary: List all feedbacks for a specific message
      tags:
      - Conversation
    post:
      operationId: createFeedback
      parameters:
      - description: Client product identifier
        in: header
        name: x-aiassistant-client-product
        required: true
        schema:
          type: string
      - description: ID of the conversation
        in: path
        name: conversation_id
        required: true
        schema:
          format: uuid
          type: string
      - description: ID of the message that feedback is being given on
        in: path
        name: message_id
        required: true
        schema:
          format: uuid
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/postFeedbackRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/postFeedbackResponse'
          description: Feedback successfully stored.
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorResponse'
          description: Bad request or missing fields
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorResponse'
          description: Unauthorized
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorResponse'
          description: Forbidden
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorResponse'
          description: Message Not found
        '500':
          description: Internal server error
      security:
      - bearerAuth: []
      summary: Allows for creating an initial feedback object, with Rating, for a particular message
      tags:
      - Conversation
  /v2/conversations/{conversation_id}/message/{message_id}/feedback/{feedback_id}:
    patch:
      operationId: updateFeedback
      parameters:
      - description: Client product identifier
        in: header
        name: x-aiassistant-client-product
        required: true
        schema:
          type: string
      - description: 'ID of the conversation '
        in: path
        name: conversation_id
        required: true
        schema:
          format: uuid
          type: string
      - description: ID of the message that feedback was given on
        in: path
        name: message_id
        required: true
        schema:
          format: uuid
          type: string
      - description: ID of the feedback to be modified
        in: path
        name: feedback_id
        required: true
        schema:
          format: uuid
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/patchFeedbackRequest'
        required: true
      responses:
        '200':
          description: Feedback successfully updated.
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorResponse'
          description: Bad request or missing fields
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorResponse'
          description: Unauthorized
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorResponse'
          description: Forbidden
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorResponse'
          description: Feedback Not found
        '500':
          description: Internal server error
      security:
      - bearerAuth: []
      summary: Allows for updating an existing feedback object with quick pick responses and/or freeform response, for a particular message and save said feedback
      tags:
      - Conversation
  /v2/conversations/{conversation_id}/message/{message_id}/response:
    get:
      operationId: getMessageResponse
      parameters:
      - description: Client product identifier
        in: header
        name: x-aiassistant-client-product
        required: true
        schema:
          type: string
      - description: ID of conversation the message is associated with
        in: path
        name: conversation_id
        required: true
        schema:
          format: uuid
          type: string
      - description: ID of the message to poll
        in: path
        name: message_id
        required: true
        schema:
          format: uuid
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/messageResponseGet'
          description: Message response retrieved successfully.
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorResponse'
          description: Bad request or missing fields
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorResponse'
          description: Unauthorized
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorResponse'
          description: Forbidden
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorResponse'
          description: Message Not found
        '500':
          description: Internal server error
      security:
      - bearerAuth: []
      summary: Retrieve the response for a given message using conversation_id and message_id
      tags:
      - Conversation
  /v2/conversations/{conversation_id}/message_sse:
    post:
      operationId: createMessageSse
      parameters:
      - description: Client product identifier
        in: header
        name: x-aiassistant-client-product
        required: true
        schema:
          type: string
      - description: ID of conversation to add message to
        in: path
        name: conversation_id
        required: true
        schema:
          format: uuid
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/postMessageRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/postMessageSseResponse'
          description: Message added to conversation successfully
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorResponse'
          description: Bad request or missing fields
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorResponse'
          description: Unauthorized
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorResponse'
          description: Forbidden
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorResponse'
          description: Conversation Not found
        '500':
          description: Internal server error
      security:
      - bearerAuth: []
      summary: Post request message to an existing active conversation with streaming response
      tags:
      - Conversation
  /v2/conversations/{conversation_id}/removeLabel:
    put:
      operationId: removeLabel
      parameters:
      - description: Client product identifier
        in: header
        name: x-aiassistant-client-product
        required: true
        schema:
          type: string
      - description: ID of conversation to retrieve messages from
        in: path
        name: conversation_id
        required: true
        schema:
          format: uuid
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/removeLabelRequest'
        required: true
      responses:
        '200':
          description: Labels removed successfully
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorResponse'
          description: Bad request or missing fields
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorResponse'
          description: Unauthorized
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorResponse'
          description: Forbidden
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorResponse'
          description: Conversation Not found
        '500':
          description: Internal server error
      security:
      - bearerAuth: []
      summary: Remove label/s from a conversation's metadata
      tags:
      - Conversation
components:
  schemas:
    postMessageSseResponse:
      description: create message SSE response body
      properties:
        Data:
          description: event data
          oneOf:
          - description: For TEXT event, Data is a simple string.
            type: string
          - description: For OBJECT event, Data is a JSON object.
            type: object
        Event:
          description: event type
          enum:
          - TEXT
          - OBJECT
          type: string
        Id:
          description: event ID
          format: uuid
          type: string
      required:
      - Id
      - Data
      - Event
      type: object
    messageGetResponse:
      description: get message response body
      properties:
        message:
          $ref: '#/components/schemas/message'
      type: object
    createConversationResponse:
      description: create conversation response body
      properties:
        conversationId:
          description: conversation ID
          format: uuid
          type: string
      required:
      - conversationId
      type: object
    extendedFeedback:
      description: Extended feedback object
      properties:
        freeFormResponse:
          description: Free form response
          type: string
        quickPickResponses:
          description: List of quick pick responses
          items:
            description: Quick pick response
            enum:
            - NONE
            - FACTUAL_INACCURACY
            - INCORRECT_CLASSIFICATION
            - UNHELPFUL_FORMATTING
            - INAPPROPRIATE_LENGTH
            - IRRELEVANT_CONTENT
            - CITATION_ISSUE
            - CORRECT
            - HELPFUL
            - OTHER
            type: string
          type: array
      type: object
    conversation:
      description: Conversation object
      properties:
        conversationId:
          description: conversation ID
          format: uuid
          type: string
        description:
          description: conversation description
          type: string
        hasUnreadMessages:
          description: indicates whether the conversation has unread messages
          type: boolean
        labels:
          description: conversation labels
          items:
            $ref: '#/components/schemas/label'
     

# --- truncated at 32 KB (41 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/cisco-secure-firewall/refs/heads/main/openapi/cisco-secure-firewall-conversation-api-openapi.yml