Skip to content

Get sheet version

Use this to fetch one owned exercise sheet version snapshot with its referenced exercise details.

{
"annotations": {
"readOnlyHint": true,
"destructiveHint": false,
"idempotentHint": true,
"openWorldHint": false
},
"fileParams": [],
"requiredPermission": "read",
"security": {
"type": "oauth2",
"scopes": [
"chalksurf:read"
]
}
}

The server advertises this JSON Schema to MCP clients. Runtime authorization and business-rule checks still apply.

{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {
"exerciseSheetId": {
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
"type": "string"
},
"organizationId": {
"description": "The ChalkSurf organization ID to use for this request.",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
"type": "string"
},
"versionId": {
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
"type": "string"
}
},
"required": [
"exerciseSheetId",
"versionId",
"organizationId"
],
"type": "object"
}
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {
"version": {
"additionalProperties": false,
"properties": {
"createdAt": {
"type": "string"
},
"createdByName": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"createdByUserId": {
"anyOf": [
{
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
"type": "string"
},
{
"type": "null"
}
]
},
"exercises": {
"items": {
"additionalProperties": false,
"properties": {
"created_at": {
"type": "string"
},
"descriptionGenerationLanguages": {
"items": {
"enum": [
"english",
"hungarian",
"german",
"french",
"spanish",
"italian"
],
"type": "string"
},
"type": "array"
},
"difficulty": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"figures": {
"items": {
"additionalProperties": false,
"properties": {
"exerciseFigureId": {
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
"type": "string"
},
"orderIndex": {
"maximum": 9007199254740991,
"minimum": 0,
"type": "integer"
},
"provenance": {
"additionalProperties": false,
"properties": {
"byteLength": {
"maximum": 104857600,
"minimum": 0,
"type": "integer"
},
"createdBy": {
"enum": [
"agent",
"user",
"import"
],
"type": "string"
},
"mimeType": {
"maxLength": 100,
"minLength": 1,
"type": "string"
},
"originalFileName": {
"maxLength": 255,
"minLength": 1,
"type": "string"
},
"pixelHeight": {
"maximum": 100000,
"minimum": 1,
"type": "integer"
},
"pixelWidth": {
"maximum": 100000,
"minimum": 1,
"type": "integer"
},
"renderQualityStatus": {
"enum": [
"passed",
"needs_revision",
"unchecked"
],
"type": "string"
},
"renderSpecHash": {
"pattern": "^[a-f0-9]{64}$",
"type": "string"
},
"sourceKind": {
"enum": [
"local_file",
"mcp_file",
"https_url",
"base64_image",
"rendered_figure",
"user_upload",
"import",
"unknown"
],
"type": "string"
}
},
"required": [
"sourceKind",
"createdBy"
],
"type": "object"
},
"rotationClockwiseDegrees": {
"anyOf": [
{
"const": 0,
"type": "number"
},
{
"const": 90,
"type": "number"
},
{
"const": 180,
"type": "number"
},
{
"const": 270,
"type": "number"
}
]
},
"type": {
"enum": [
"text",
"solution"
],
"type": "string"
},
"url": {
"format": "uri",
"type": "string"
},
"widthInCm": {
"maximum": 20,
"minimum": 1,
"type": "number"
}
},
"required": [
"type",
"url",
"widthInCm",
"exerciseFigureId",
"orderIndex",
"rotationClockwiseDegrees"
],
"type": "object"
},
"type": "array"
},
"hasActiveQualityIssues": {
"type": "boolean"
},
"id": {
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
"type": "string"
},
"is_public": {
"type": "boolean"
},
"labels": {
"items": {
"type": "string"
},
"type": "array"
},
"max_age": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"metadata": {
"anyOf": [
{},
{
"type": "null"
}
]
},
"min_age": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"order_index": {
"maximum": 9007199254740991,
"minimum": -9007199254740991,
"type": "integer"
},
"organization_id": {
"anyOf": [
{
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
"type": "string"
},
{
"type": "null"
}
]
},
"score_points": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"source": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"subject": {
"enum": [
"math",
"physics",
"chemistry"
],
"type": "string"
},
"text": {
"additionalProperties": {
"type": "string"
},
"propertyNames": {
"type": "string"
},
"type": "object"
},
"translations": {
"additionalProperties": {
"additionalProperties": false,
"properties": {
"answer": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"detailed_solution": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"exercise_text": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"hint": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"scaffold": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"status": {
"enum": [
"verified",
"unverified",
"invalid"
],
"type": "string"
}
},
"required": [
"status"
],
"type": "object"
},
"propertyNames": {
"type": "string"
},
"type": "object"
},
"updated_at": {
"type": "string"
}
},
"required": [
"id",
"created_at",
"updated_at",
"difficulty",
"min_age",
"max_age",
"figures",
"metadata",
"organization_id",
"is_public",
"source",
"subject",
"labels",
"translations",
"text"
],
"type": "object"
},
"type": "array"
},
"exerciseSheetId": {
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
"type": "string"
},
"id": {
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
"type": "string"
},
"snapshot": {
"additionalProperties": false,
"properties": {
"exercises": {
"items": {
"additionalProperties": false,
"properties": {
"exerciseId": {
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
"type": "string"
},
"orderIndex": {
"maximum": 9007199254740991,
"minimum": 1,
"type": "integer"
},
"scorePoints": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
}
},
"required": [
"exerciseId",
"orderIndex",
"scorePoints"
],
"type": "object"
},
"type": "array"
},
"private_notes": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"scoring_enabled": {
"type": "boolean"
},
"subject": {
"enum": [
"math",
"physics",
"chemistry"
],
"type": "string"
},
"translations": {
"additionalProperties": {
"additionalProperties": false,
"properties": {
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"name": {
"type": "string"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"name",
"title",
"description"
],
"type": "object"
},
"propertyNames": {
"type": "string"
},
"type": "object"
}
},
"required": [
"subject",
"private_notes",
"scoring_enabled",
"translations",
"exercises"
],
"type": "object"
},
"sourceVersionId": {
"anyOf": [
{
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
"type": "string"
},
{
"type": "null"
}
]
},
"type": {
"enum": [
"backfill",
"create",
"manual_edit",
"copy",
"sheet_import",
"revert"
],
"type": "string"
},
"versionNumber": {
"exclusiveMinimum": 0,
"maximum": 9007199254740991,
"type": "integer"
}
},
"required": [
"id",
"exerciseSheetId",
"versionNumber",
"createdAt",
"createdByUserId",
"createdByName",
"type",
"sourceVersionId",
"snapshot",
"exercises"
],
"type": "object"
}
},
"required": [
"version"
],
"type": "object"
}