rateCopilotMessage

Requires permission catalog:copilot:chat.

Rate an ASSISTANT turn of one of the CALLER'S OWN copilot threads (UP/DOWN + optional note). The message must exist in the thread; anything else is 400.

Errors: a failed call returns a GraphQL errors entry, not a field on the result, and data may be null or partial. Read the entry's extensions.code and message; every shape and code is in the Error reference.

Example:

GraphQL

mutation RateCopilotMessage($id: ID!, $messageId: ID!, $rating: String!) {
  rateCopilotMessage(id: $id, messageId: $messageId, rating: $rating)
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "mutation RateCopilotMessage($id: ID!, $messageId: ID!, $rating: String!) {\n  rateCopilotMessage(id: $id, messageId: $messageId, rating: $rating)\n}",
  "variables": {
    "id": "id",
    "messageId": "id",
    "rating": "string"
  }
}
EOF

Variables:

{
  "id": "id",
  "messageId": "id",
  "rating": "string"
}

Response:

{
  "data": {
    "rateCopilotMessage": true
  }
}

rateCopilotMessage(
  id: ID!
  messageId: ID!
  note: String
  rating: String!
): Boolean!

Arguments

rateCopilotMessage.id ● ID! non-null scalar

The ID of the Copilot session.

rateCopilotMessage.messageId ● ID! non-null scalar

The ID of the message being rated.

rateCopilotMessage.note ● String scalar

An optional comment.

rateCopilotMessage.rating ● String! non-null scalar

The rating: "up" or "down".

Type

Boolean scalar

The Boolean scalar type represents true or false.