Rubrics

Create a rubric

POST/v5/rubrics

List rubrics

GET/v5/rubrics

Get a rubric

GET/v5/rubrics/{rubric_id}

Update or restore a rubric

PATCH/v5/rubrics/{rubric_id}

Archive a rubric

DELETE/v5/rubrics/{rubric_id}

ModelsExpand Collapse

RestoreRequest object { restore }

restore: true

Set to true to restore the entity from the database.

RubricResponse object { 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" or "service_account"

One of the following:

"user"

"service_account"

object: optional "identity"

tags: array of string

The tags associated with the entity

title: string

version: number

archived_at: optional string

formatdate-time

criteria: optional array of RubricCriteriaResponse { id, created_at, rubric_id, 5 more } or RubricCriteriaSummaryResponse { title, weight }

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

One of the following:

RubricCriteriaResponse object { id, created_at, rubric_id, 5 more }

id: string

created_at: string

formatdate-time

rubric_id: string

title: string

version: number

annotations: optional map[unknown]

object: optional "rubric_criteria"

weight: optional number

RubricCriteriaSummaryResponse object { title, weight }

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

title: string

weight: optional number

object: optional "rubric"

updated_at: optional string

formatdate-time

RubricArchiveResponse object { id, deleted, object }

id: string

deleted: boolean

object: optional "rubric"

RubricsCriteria

Add a criterion to a rubric

POST/v5/rubrics/{rubric_id}/criteria

Update a criterion

PATCH/v5/rubrics/{rubric_id}/criteria/{rubric_criteria_id}

List criterion versions

GET/v5/rubrics/{rubric_id}/criteria/{rubric_criteria_id}/versions

ModelsExpand Collapse

RubricCriteriaInput object { title, annotations, weight }

title: string

The Criteria text

minLength1

annotations: optional map[unknown]

Free-form metadata for the Criteria

weight: optional number

Weight multiplier for scoring

minimum0

RubricCriteriaResponse object { id, created_at, rubric_id, 5 more }

id: string

created_at: string

formatdate-time

rubric_id: string

title: string

version: number

annotations: optional map[unknown]

object: optional "rubric_criteria"

weight: optional number

RubricCriteriaSummaryResponse object { title, weight }

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

title: string

weight: optional number

CriterionListVersionsResponse object { has_more, items, total, 2 more }

has_more: boolean

Whether there are more items left to be fetched.

items: array of RubricCriteriaResponse { id, created_at, rubric_id, 5 more }

id: string

created_at: string

formatdate-time

rubric_id: string

title: string

version: number

annotations: optional map[unknown]

object: optional "rubric_criteria"

weight: optional number

total: number

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

limit: optional number

The maximum number of items to return.

object: optional "list"