Skip to main content
POST
/
v1
/
vote
Error
A valid request URL is required to generate request examples
{
  "success": true,
  "message": "<string>",
  "data": {
    "messageId": "<string>",
    "rating": "<string>",
    "comment": "<string>",
    "threadId": "<string>"
  }
}

Authorizations

​
Authorization
string
header
required

Org API key (scopes the request to its organization) or the shared trusted key (requires X-Organization-Id on every request).

Headers

​
X-Organization-Id
string

Organization to scope the request to. Optional when authenticating with an org API key (the org is taken from the key; if sent, it must match). Required when authenticating with the trusted key.

​
X-User-Id
string

End-user identity for the request; user-scoped data (threads, memory) resolves to {orgId}_{userId}. Required by endpoints that read or write user-scoped resources. A userId query param (or body field, where documented) is accepted as a fallback.

Body

application/json
​
messageId
string
required

The ID of the message to vote on

​
user_rating
enum<string>
required

The rating: -1 (thumbs down), 0 (neutral), 1 (thumbs up)

Available options:
-1,
0,
1
​
user_comment
string

Optional comment about the rating

Response

Vote recorded successfully

​
success
boolean
​
message
string
​
data
object