OMomni
AI

Rate an AI job's response

Changed on

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.

<Note> 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. </Note>
post/v1/ai/jobs/{jobId}/feedback

Request

  • Base URL
    https://blobsrus.omniapp.co/api
  • URL
    https://blobsrus.omniapp.co/api/v1/ai/jobs/{jobId}/feedback
  • Auth
    HTTP bearer

Path parameters

jobIdstring uuid required

The unique identifier of the AI job

Example:123e4567-e89b-12d3-a456-426614174000

Query parameters

userIdstring uuid

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

Request body

commentstring

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.

rating'good' | 'bad' required

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

Example request

{
  "comment": "Grouped by order date instead of ship date.",
  "rating": "bad"
}

Response

Feedback recorded.

commentstring required

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

conversationIdstring uuid required

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

jobIdstring uuid required

The job whose response was rated.

rating'good' | 'bad' required

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

submittedAtstring date-time required

When the feedback was recorded.

Example response

{
  "comment": "Grouped by order date instead of ship date.",
  "conversationId": "660e8400-e29b-41d4-a716-446655440001",
  "jobId": "550e8400-e29b-41d4-a716-446655440000",
  "rating": "bad",
  "submittedAt": "2025-01-15T10:00:00.000Z"
}

Changes