Skip to content
sgp
API Reference
Rubrics

Criteria

Add a criterion to a rubric
client.rubrics.criteria.create(stringrubricID, CriterionCreateParams { title, annotations, weight } body, RequestOptionsoptions?): RubricCriteriaResponse { id, created_at, rubric_id, 5 more }
POST/v5/rubrics/{rubric_id}/criteria
Update a criterion
client.rubrics.criteria.update(stringrubricCriteriaID, CriterionUpdateParams { rubric_id, annotations, title, weight } params, RequestOptionsoptions?): RubricCriteriaResponse { id, created_at, rubric_id, 5 more }
PATCH/v5/rubrics/{rubric_id}/criteria/{rubric_criteria_id}
List criterion versions
client.rubrics.criteria.listVersions(stringrubricCriteriaID, CriterionListVersionsParams { rubric_id, ending_before, limit, 3 more } params, RequestOptionsoptions?): CriterionListVersionsResponse { has_more, items, total, 2 more }
GET/v5/rubrics/{rubric_id}/criteria/{rubric_criteria_id}/versions
ModelsExpand Collapse
RubricCriteriaInput { title, annotations, weight }
title: string

The Criteria text

minLength1
annotations?: Record<string, unknown>

Free-form metadata for the Criteria

weight?: number

Weight multiplier for scoring

minimum0
RubricCriteriaResponse { id, created_at, rubric_id, 5 more }
id: string
created_at: string
formatdate-time
rubric_id: string
title: string
version: number
annotations?: Record<string, unknown>
object?: "rubric_criteria"
weight?: number
RubricCriteriaSummaryResponse { title, weight }

Slim criteria projection for list endpoints (title + weight only).

title: string
weight?: number
CriterionListVersionsResponse { has_more, items, total, 2 more }
has_more: boolean

Whether there are more items left to be fetched.

items: Array<RubricCriteriaResponse { id, created_at, rubric_id, 5 more } >
id: string
created_at: string
formatdate-time
rubric_id: string
title: string
version: number
annotations?: Record<string, unknown>
object?: "rubric_criteria"
weight?: number
total: number

The total of items that match the query. This is greater than or equal to the number of items returned.

limit?: number

The maximum number of items to return.

object?: "list"