Skip to main content
Only teams with customer review enabled: other teams get 403 The "customerReview" feature is not enabled for this team. Return a page of the customer reviews of a run, without task content. Deciding a review moves it out of awaiting, so to work through the queue, decide the first page and list again from offset 0. The listAll* variant yields items across every page. The other variant returns one page with pagination metadata. See Pagination.

Signature

Method signatures on client.reviews:

Parameters

listAll()

string
required
Pipeline run ID with prefix plr..
number
default:"20"
Maximum number of results to return; defaults to 20.
number
default:"0"
Number of results to skip before this page; defaults to 0.
"checking" | "awaiting" | "closed"
default:"awaiting"
Which reviews to list. awaiting: reviews that still take a decision (needs_review and returned before their deadline), soonest deadline first. checking: rejects the LLM QA check is checking, soonest deadline first. closed: accepted, rejected and expired reviews, most recently closed first. Defaults to awaiting.
string
Only list the reviews of this generation node.

listPage()

string
required
Pipeline run ID with prefix plr..
number
default:"20"
Maximum number of results to return; defaults to 20.
number
default:"0"
Number of results to skip before this page; defaults to 0.
"checking" | "awaiting" | "closed"
default:"awaiting"
Which reviews to list. awaiting: reviews that still take a decision (needs_review and returned before their deadline), soonest deadline first. checking: rejects the LLM QA check is checking, soonest deadline first. closed: accepted, rejected and expired reviews, most recently closed first. Defaults to awaiting.
string
Only list the reviews of this generation node.

Returns

listAll() result

AsyncGenerator<ReviewSummary> Yields one item at a time. The fields below describe each yielded item. A customer review of one task, without its content.
ReviewId
required
Review ID with prefix trr..
RunId
required
Pipeline run ID with prefix plr..
RunItemId
required
Run item ID with prefix plri..
string
required
ID of the generation node whose task is under review.
string
required
Name of that generation node.
ReviewStatus
required
Review status. needs_review: waiting for the first decision. returned: the LLM QA check did not confirm the last reject, so the review waits for a new decision. checking: the LLM QA check is checking a reject, and decisions are refused until it answers. accepted: the team accepted the task. rejected: the reject is final, either forced or confirmed by the LLM QA check. expired: the deadline passed while the review was open, whether it waited for a decision or was checking a reject the check then did not confirm, so the task was accepted automatically.
string
required
Time the task was submitted, as an ISO 8601 timestamp.
string
required
Deadline for a decision, as an ISO 8601 timestamp. From then on the review takes no decisions, but it closes a little later: a review waiting for a decision expires shortly after the deadline, and its task is accepted automatically (the expert is paid and the task is billed); a review checking a reject closes when the LLM QA check answers.
string | null
required
Time the review closed, as an ISO 8601 timestamp, or null while it is open.

listPage() result

Promise<{ reviews: ReviewSummary[]; pagination: Pagination }>
ReviewSummary[]
required
Reviews in this page.
Pagination
required
Pagination information for this page.

Errors

HTTP errors throw PotatoApiError. The endpoint documents these error responses: HTTP endpoint: GET /runs/{runId}/reviews.