Skip to main content
POST
Rate an AI job's response

Authorizations

Authorization
string
header
required

Can be either an Organization API Key or Personal Access Token (PAT).

Include in the Authorization header as: Bearer YOUR_TOKEN

Path Parameters

jobId
string<uuid>
required

The unique identifier of the AI job

Example:

"123e4567-e89b-12d3-a456-426614174000"

Query Parameters

userId
string<uuid>

Organization API key required. The membership ID of the user to act as.

Body

application/json
rating
enum<string>
required

The verdict on the response. good is a thumbs up, bad a thumbs down.

Available options:
good,
bad
Example:

"bad"

comment
string

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.

Required string length: 1 - 5000
Example:

"Grouped by order date instead of ship date."

Response

Feedback recorded.

comment
string
required

The comment as recorded, or null when none was sent.

Example:

"Grouped by order date instead of ship date."

conversationId
string<uuid>
required

The conversation the rated job belongs to. Analytics keys feedback by job id and conversation id.

Example:

"660e8400-e29b-41d4-a716-446655440001"

jobId
string<uuid>
required

The job whose response was rated.

Example:

"550e8400-e29b-41d4-a716-446655440000"

rating
enum<string>
required

The verdict on the response. good is a thumbs up, bad a thumbs down.

Available options:
good,
bad
Example:

"bad"

submittedAt
string<date-time>
required

When the feedback was recorded.

Example:

"2025-01-15T10:00:00.000Z"