API Reference

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Rubrics

Create a rubric

client.rubrics.create(RubricCreateParams { title, criteria, tags } body, RequestOptionsoptions?): RubricResponse { id, created_at, created_by, 7 more }

POST/v5/rubrics

List rubrics

client.rubrics.list(RubricListParams { ending_before, limit, sort_by, 4 more } query?, RequestOptionsoptions?): CursorPage<RubricResponse { id, created_at, created_by, 7 more } >

GET/v5/rubrics

Get a rubric

client.rubrics.retrieve(stringrubricID, RequestOptionsoptions?): RubricResponse { id, created_at, created_by, 7 more }

GET/v5/rubrics/{rubric_id}

Update or restore a rubric

client.rubrics.update(stringrubricID, RubricUpdateParams { rubric } params, RequestOptionsoptions?): RubricResponse { id, created_at, created_by, 7 more }

PATCH/v5/rubrics/{rubric_id}

Archive a rubric

client.rubrics.archive(stringrubricID, RequestOptionsoptions?): RubricArchiveResponse { id, deleted, object }

DELETE/v5/rubrics/{rubric_id}

ModelsExpand Collapse

RestoreRequest { restore }

restore: true

Set to true to restore the entity from the database.

RubricResponse { id, created_at, created_by, 7 more }

id: string

created_at: string

formatdate-time

created_by: Identity { id, type, object }

The identity that created the entity.

id: string

type: "user" | "service_account"

One of the following:

"user"

"service_account"

object?: "identity"

tags: Array<string> | null

The tags associated with the entity

title: string

version: number

archived_at?: string

formatdate-time

criteria?: Array<RubricCriteriaResponse { id, created_at, rubric_id, 5 more } | RubricCriteriaSummaryResponse { title, weight } >

Full criteria on get, summary (title + weight) on list

One of the following:

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

object?: "rubric"

updated_at?: string

formatdate-time

RubricArchiveResponse { id, deleted, object }

id: string

deleted: boolean

object?: "rubric"

RubricsCriteria

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"