Rate an AI job's response
Rate an AI job’s response using the same thumbs up/thumbs down and optional comment a user can give a response in the Omni UI or in Slack.
The job must have finished or the API returns a 409. Poll the Get AI job status endpoint to retrieve a job’s current status. Submit feedback once per job.
Personal Access Tokens can only rate their own jobs. If using an Organization API key, pass userId to attribute the feedback to a specific user. This must be the same userId the job was submitted with.
Authorizations
Can be either an Organization API Key or Personal Access Token (PAT).
Include in the Authorization header as: Bearer YOUR_TOKEN
Path Parameters
The unique identifier of the AI job
"123e4567-e89b-12d3-a456-426614174000"
Query Parameters
Organization API key required. The membership ID of the user to act as.
Body
The verdict on the response. good is a thumbs up, bad a thumbs down.
good, bad "bad"
Free-text feedback about the response, such as what was wrong or what an automated evaluation found. Whitespace is trimmed; null is treated as no comment.
1 - 5000"Grouped by order date instead of ship date."
Response
Feedback recorded.
The comment as recorded, or null when none was sent.
"Grouped by order date instead of ship date."
The conversation the rated job belongs to. Analytics keys feedback by job id and conversation id.
"660e8400-e29b-41d4-a716-446655440001"
The job whose response was rated.
"550e8400-e29b-41d4-a716-446655440000"
The verdict on the response. good is a thumbs up, bad a thumbs down.
good, bad "bad"
When the feedback was recorded.
"2025-01-15T10:00:00.000Z"

