Agents

Submit feedback for an agent message

Changed on

Append structured feedback to a bot-response message in an agent conversation. Uses the same request body shape as updateMessageFeedback (helpfulness, categories, comments). Feedback can only be submitted on bot_response messages.

post/agents/{agentKey}/conversations/{conversationId}/message/{messageId}/feedback

Request

  • Base URL
    https://app.pipeshub.com/api/v1
  • URL
    https://app.pipeshub.com/api/v1/agents/{agentKey}/conversations/{conversationId}/message/{messageId}/feedback
  • Auth
    • HTTP bearer
    • or OAuth 2
      Authorization code: /api/v1/oauth2/authorize
      Client credentials
      Token URL: /api/v1/oauth2/token scopes: agent:execute

Path parameters

agentKeystring required

Unique agent identifier (gateway Zod requires non-empty string).

conversationIdstring objectId required

Unique conversation identifier.

messageIdstring objectId required

Identifier of the bot-response message being rated.

Request body

isHelpfulboolean

Overall helpfulness signal (thumbs up/down).

categoriesstring[]

Issue or positive categories that apply to the response.

Response

Feedback stored

conversationIdstring objectId required

Conversation the feedback was attached to.

messageIdstring objectId required

Message the feedback was attached to.

Changes

    • info

      added the media type application/json for the response with the status

    • info

      added the media type application/json for the response with the status

    • info

      added the media type application/json for the response with the status

    • info

      added the media type application/json for the response with the status

    • info

      added the non-success response with the status