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

# Rate a reply

> Records a thumbs up or down (and an optional comment) on an assistant message. Sending it again replaces the previous rating.



## OpenAPI

````yaml /openapi.yaml post /agents/{agentId}/conversations/{conversationRef}/messages/{messageId}/feedback
openapi: 3.0.3
info:
  title: ReyGrid API
  version: 1.0.3
  description: |
    ReyGrid API

    ## Persistent user conversations

    If you want to build a separate conversation system for each user,
    build a wrapper layer around the ReyGrid API.

    The wrapper should manage the application's own user IDs and map them
    to ReyGrid conversations.

    The wrapper is responsible for:
    - Managing and identifying users.
    - Storing the relationship between the application's userId and
      ReyGrid conversationId.
    - Persisting conversation IDs in the application's own database.
    - Reusing the stored conversationId when the same user continues
      a conversation.
    - Verifying that conversation IDs belong to the expected user before
      using them.

    ReyGrid's userId can also be used as a stable identifier for persistent
    conversations. However, if the application requires its own user and
    conversation management, it should maintain this mapping in its own
    database.
servers:
  - url: https://reygrid.com/api/v1
security: []
paths:
  /agents/{agentId}/conversations/{conversationRef}/messages/{messageId}/feedback:
    post:
      summary: Rate a reply
      description: >-
        Records a thumbs up or down (and an optional comment) on an assistant
        message. Sending it again replaces the previous rating.
      operationId: rateMessage
      parameters:
        - $ref: '#/components/parameters/AgentId'
        - name: conversationRef
          in: path
          required: true
          description: The conversationId or userId of the conversation.
          schema:
            type: string
        - name: messageId
          in: path
          required: true
          description: The ID of an assistant message.
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FeedbackRequest'
            example:
              rating: down
              comment: The shipping times are out of date
      responses:
        '200':
          description: Feedback saved
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FeedbackResponse'
              example:
                success: true
                feedback:
                  rating: down
                  comment: The shipping times are out of date
                  createdAt: '2026-10-05T10:21:34.120Z'
        '400':
          $ref: '#/components/responses/InvalidBody'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
      security:
        - apiKeyAuth: []
      x-codeSamples:
        - lang: bash
          label: cURL
          source: >-
            curl -X POST
            https://reygrid.com/api/v1/agents/{AgentId}/conversations/user_42/messages/msg_x6tWaZ3H9oOKd/feedback
            \
              -H "Authorization: Bearer $REYGRID_API_KEY" \
              -H "Content-Type: application/json" \
              -d '{"rating": "down", "comment": "The shipping times are out of date"}'
        - lang: python
          label: Python SDK
          source: |-
            from reygrid import ReyGrid

            client = ReyGrid(api_key="YOUR_API_KEY")

            client.rate_message(
                "{AgentId}",
                "user_42",
                "msg_x6tWaZ3H9oOKd",
                "down",
                comment="The shipping times are out of date",
            )
        - lang: javascript
          label: TypeScript SDK
          source: >-
            import { ReyGrid } from "reygrid";


            const client = new ReyGrid({ apiKey: "YOUR_API_KEY" });


            await client.rateMessage("{AgentId}", "user_42",
            "msg_x6tWaZ3H9oOKd", {
              rating: "down",
              comment: "The shipping times are out of date",
            });
components:
  parameters:
    AgentId:
      name: agentId
      in: path
      required: true
      description: The ID of the agent.
      schema:
        type: string
  schemas:
    FeedbackRequest:
      type: object
      required:
        - rating
      properties:
        rating:
          type: string
          enum:
            - up
            - down
        comment:
          type: string
          maxLength: 1000
    FeedbackResponse:
      type: object
      properties:
        success:
          type: boolean
        feedback:
          type: object
          properties:
            rating:
              type: string
              enum:
                - up
                - down
            comment:
              type: string
            createdAt:
              type: string
              format: date-time
    ErrorResponse:
      type: object
      required:
        - success
        - error
      properties:
        success:
          type: boolean
        output:
          type: object
          additionalProperties: true
        error:
          $ref: '#/components/schemas/Error'
        usage:
          $ref: '#/components/schemas/ChatUsage'
    AuthErrorResponse:
      type: object
      required:
        - error
        - code
      properties:
        error:
          type: string
          example: Unauthorized
        code:
          type: string
          example: AUTH_REQUIRED
    Error:
      type: object
      required:
        - code
        - message
      properties:
        code:
          type: string
        message:
          type: string
        list:
          type: array
          description: |
            Validation error details.
            Present when error.code is INVALID_BODY.
          items:
            $ref: '#/components/schemas/ValidationErrorItem'
    ChatUsage:
      type: object
      required:
        - credits
      properties:
        credits:
          type: number
    ValidationErrorItem:
      type: object
      additionalProperties: true
  responses:
    InvalidBody:
      description: Invalid body or query (INVALID_BODY)
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            success: false
            error:
              code: INVALID_BODY
              message: Invalid body
              list:
                title:
                  - Title too short
    Unauthorized:
      description: API key is missing or invalid
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/AuthErrorResponse'
          example:
            error: Unauthorized
            code: AUTH_REQUIRED
    NotFound:
      description: The agent, source or message doesn't exist, or the key can't access it
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            success: false
            error:
              code: SOURCE_NOT_FOUND
              message: This source does not exist
  securitySchemes:
    apiKeyAuth:
      type: http
      scheme: bearer
      bearerFormat: API-Key
      description: ReyGrid API key sent as a Bearer token.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.