Skip to content
sgp
API Reference

Rubrics

Create a rubric
rubrics.create(RubricCreateParams**kwargs) -> RubricResponse
POST/v5/rubrics
List rubrics
rubrics.list(RubricListParams**kwargs) -> SyncCursorPage[RubricResponse]
GET/v5/rubrics
Get a rubric
rubrics.retrieve(strrubric_id) -> RubricResponse
GET/v5/rubrics/{rubric_id}
Update or restore a rubric
rubrics.update(strrubric_id, RubricUpdateParams**kwargs) -> RubricResponse
PATCH/v5/rubrics/{rubric_id}
Archive a rubric
rubrics.archive(strrubric_id) -> RubricArchiveResponse
DELETE/v5/rubrics/{rubric_id}
ModelsExpand Collapse
class RestoreRequest: …
restore: Literal[true]

Set to true to restore the entity from the database.

class RubricResponse: …
id: str
created_at: datetime
formatdate-time
created_by: Identity

The identity that created the entity.

id: str
type: Literal["user", "service_account"]
One of the following:
"user"
"service_account"
object: Optional[Literal["identity"]]
tags: Optional[List[str]]

The tags associated with the entity

title: str
version: int
archived_at: Optional[datetime]
formatdate-time
criteria: Optional[List[Criterion]]

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

One of the following:
class RubricCriteriaResponse: …
id: str
created_at: datetime
formatdate-time
rubric_id: str
title: str
version: int
annotations: Optional[Dict[str, object]]
object: Optional[Literal["rubric_criteria"]]
weight: Optional[float]
class RubricCriteriaSummaryResponse: …

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

title: str
weight: Optional[float]
object: Optional[Literal["rubric"]]
updated_at: Optional[datetime]
formatdate-time
class RubricArchiveResponse: …
id: str
deleted: bool
object: Optional[Literal["rubric"]]

RubricsCriteria

Add a criterion to a rubric
rubrics.criteria.create(strrubric_id, CriterionCreateParams**kwargs) -> RubricCriteriaResponse
POST/v5/rubrics/{rubric_id}/criteria
Update a criterion
rubrics.criteria.update(strrubric_criteria_id, CriterionUpdateParams**kwargs) -> RubricCriteriaResponse
PATCH/v5/rubrics/{rubric_id}/criteria/{rubric_criteria_id}
List criterion versions
rubrics.criteria.list_versions(strrubric_criteria_id, CriterionListVersionsParams**kwargs) -> CriterionListVersionsResponse
GET/v5/rubrics/{rubric_id}/criteria/{rubric_criteria_id}/versions
ModelsExpand Collapse
class RubricCriteriaInput: …
title: str

The Criteria text

minLength1
annotations: Optional[Dict[str, object]]

Free-form metadata for the Criteria

weight: Optional[float]

Weight multiplier for scoring

minimum0
class RubricCriteriaResponse: …
id: str
created_at: datetime
formatdate-time
rubric_id: str
title: str
version: int
annotations: Optional[Dict[str, object]]
object: Optional[Literal["rubric_criteria"]]
weight: Optional[float]
class RubricCriteriaSummaryResponse: …

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

title: str
weight: Optional[float]
class CriterionListVersionsResponse: …
has_more: bool

Whether there are more items left to be fetched.

id: str
created_at: datetime
formatdate-time
rubric_id: str
title: str
version: int
annotations: Optional[Dict[str, object]]
object: Optional[Literal["rubric_criteria"]]
weight: Optional[float]
total: int

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

limit: Optional[int]

The maximum number of items to return.

object: Optional[Literal["list"]]