Flowise feedback API

openapi: 3.0.3
info:
  title: Flowise APIs assistants feedback API
  version: 1.0.0
  description: 'Flowise REST API for managing AI agent flows, chatflows, assistants, document stores, tools, variables, and predictions.

    Bearer token authentication uses an API key generated in the Flowise admin UI. The default server is your local or hosted Flowise instance at /api/v1.

    '
  license:
    name: Apache 2.0
    url: https://github.com/FlowiseAI/Flowise/blob/main/LICENSE.md
  contact:
    name: FlowiseAI
    email: support@flowiseai.com
servers:
- url: http://localhost:3000/api/v1
  description: Local Flowise server
- url: https://{instance}.flowiseai.com/api/v1
  description: Flowise Cloud instance
  variables:
    instance:
      default: app
tags:
- name: feedback
paths:
  /feedback:
    post:
      tags:
      - feedback
      security:
      - bearerAuth: []
      operationId: createChatMessageFeedbackForChatflow
      summary: Create new chat message feedback
      description: Create new feedback for a specific chat flow.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ChatMessageFeedback'
        required: true
      responses:
        '200':
          description: Feedback successfully created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ChatMessageFeedback'
        '400':
          description: Invalid input provided
        '500':
          description: Internal server error
  /feedback/{id}:
    get:
      tags:
      - feedback
      security:
      - bearerAuth: []
      summary: List all chat message feedbacks for a chatflow
      description: Retrieve all feedbacks for a chatflow
      operationId: getAllChatMessageFeedback
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: string
        description: Chatflow ID
      - in: query
        name: chatId
        schema:
          type: string
        description: Chat ID to filter feedbacks (optional)
      - in: query
        name: sortOrder
        schema:
          type: string
          enum:
          - asc
          - desc
          default: asc
        description: Sort order of feedbacks (optional)
      - in: query
        name: startDate
        schema:
          type: string
          format: date-time
        description: Filter feedbacks starting from this date (optional)
      - in: query
        name: endDate
        schema:
          type: string
          format: date-time
        description: Filter feedbacks up to this date (optional)
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ChatMessageFeedback'
        '500':
          description: Internal server error
    put:
      tags:
      - feedback
      security:
      - bearerAuth: []
      summary: Update chat message feedback
      description: Update a specific feedback
      operationId: updateChatMessageFeedbackForChatflow
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: string
        description: Chat Message Feedback ID
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ChatMessageFeedback'
      responses:
        '200':
          description: Feedback successfully updated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ChatMessageFeedback'
        '400':
          description: Invalid input provided
        '404':
          description: Feedback with the specified ID was not found
        '500':
          description: Internal server error
components:
  schemas:
    ChatMessageFeedback:
      type: object
      properties:
        id:
          type: string
          format: uuid
          description: Unique identifier for the feedback
        chatflowid:
          type: string
          format: uuid
          description: Identifier for the chat flow
        chatId:
          type: string
          description: Identifier for the chat
        messageId:
          type: string
          format: uuid
          description: Identifier for the message
        rating:
          type: string
          enum:
          - THUMBS_UP
          - THUMBS_DOWN
          description: Rating for the message
        content:
          type: string
          description: Feedback content
        createdDate:
          type: string
          format: date-time
          description: Date and time when the feedback was created
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT