Tool tree
Formative classroom assessment and learning platform
addFolderAction
Create a folder
View tool JSON
{
"name": "addFolder",
"kind": "act",
"impl": "imperative",
"description": "Create a folder",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"properties": {
"input": {
"type": "object",
"properties": {
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"orgAccess": {
"anyOf": [
{
"type": "array",
"items": {
"type": "object",
"properties": {
"orgId": {
"type": "string"
},
"permissions": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string",
"enum": [
"assign",
"edit",
"viewAllData",
"viewAnonymousData"
]
}
},
{
"type": "null"
}
]
}
},
"required": [
"orgId"
],
"additionalProperties": false
}
},
{
"type": "null"
}
]
},
"ownerId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"parentId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"sourceParentId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"additionalProperties": false
}
},
"required": [
"input"
],
"additionalProperties": false
},
"page": "/login"
}addFormativeAction
Create a new formative (assessment/lesson) owned by the authenticated user. **Basic example:** ```json { "input": { "title": "Math Quiz" } } ``` **With questions:** ```json { "input": { "title": "Math Quiz", "items": [ { "type": "multipleChoice", "text": "What is 2+2?", "choices": ["A", "B", "C", "D"], "choiceLabels": ["3", "4", "5", "6"], "correctAnswers": ["B"] }, { "type": "shortAnswer", "text": "What is the capital of France?", "correctAnswers": ["Paris", "paris"] } ] } } ``` The response includes URLs for viewing/editing the formative.
View tool JSON
{
"name": "addFormative",
"kind": "act",
"impl": "imperative",
"description": "Create a new formative (assessment/lesson) owned by the authenticated user.\n\n**Basic example:**\n```json\n{\n \"input\": {\n \"title\": \"Math Quiz\"\n }\n}\n```\n\n**With questions:**\n```json\n{\n \"input\": {\n \"title\": \"Math Quiz\",\n \"items\": [\n { \"type\": \"multipleChoice\", \"text\": \"What is 2+2?\", \"choices\": [\"A\", \"B\", \"C\", \"D\"], \"choiceLabels\": [\"3\", \"4\", \"5\", \"6\"], \"correctAnswers\": [\"B\"] },\n { \"type\": \"shortAnswer\", \"text\": \"What is the capital of France?\", \"correctAnswers\": [\"Paris\", \"paris\"] }\n ]\n }\n}\n```\n\nThe response includes URLs for viewing/editing the formative.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"properties": {
"input": {
"type": "object",
"properties": {
"bubbleSheet": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"commonAssessment": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"folderId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"headerColor": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"headerImage": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"items": {
"anyOf": [
{
"type": "array",
"items": {
"type": "object",
"properties": {
"input": {
"type": "object",
"properties": {
"allowEquivalencies": {
"anyOf": [
{
"type": "string",
"enum": [
"ALGEBRAIC",
"BASIC",
"PERCENTAGE_TOLERANCE",
"RANGE",
"TOLERANCE"
]
},
{
"type": "null"
}
]
},
"alternateText": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"answerChoicePoints": {
"anyOf": [
{
"type": "array",
"items": {
"type": "number"
}
},
{
"type": "null"
}
]
},
"areChoiceExplanationsEnabled": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"blanks": {
"anyOf": [
{
"type": "array",
"items": {
"type": "object",
"properties": {
"choiceLabels": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
]
},
"choices": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
]
},
"correctAnswers": {
"type": "array",
"items": {
"type": "string"
}
},
"key": {
"type": "string"
},
"numeric": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
}
},
"required": [
"correctAnswers",
"key"
],
"additionalProperties": false
}
},
{
"type": "null"
}
]
},
"canvas": {
"anyOf": [
{},
{
"type": "null"
}
]
},
"canvasImageList": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
]
},
"childItemBankItemId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"choiceLabels": {
"anyOf": [
{
"type": "array",
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
{
"type": "null"
}
]
},
"choices": {
"anyOf": [
{
"type": "array",
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
{
"type": "null"
}
]
},
"citation": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"correctAnswers": {
"anyOf": [
{
"type": "array",
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
{
"type": "null"
}
]
},
"deleted": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"deletedAt": {
"anyOf": [
{
"anyOf": [
{
"type": "string"
},
{
"type": "number"
}
]
},
{
"type": "null"
}
]
},
"dragAndDrop": {
"anyOf": [
{
"type": "object",
"properties": {
"choices": {
"anyOf": [
{
"type": "array",
"items": {
"type": "object",
"properties": {
"key": {
"type": "string"
},
"label": {
"type": "string"
}
},
"required": [
"key",
"label"
],
"additionalProperties": false
}
},
{
"type": "null"
}
]
},
"correctAnswers": {
"anyOf": [
{
"type": "array",
"items": {
"type": "object",
"properties": {
"choiceKey": {
"type": "string"
},
"targetKey": {
"type": "string"
}
},
"required": [
"choiceKey",
"targetKey"
],
"additionalProperties": false
}
},
{
"type": "null"
}
]
},
"dropLocations": {
"anyOf": [
{
"type": "array",
"items": {
"type": "object",
"properties": {
"placement": {
"anyOf": [
{
"type": "string",
"enum": [
"auto",
"bottom",
"left",
"right",
"top"
]
},
{
"type": "null"
}
]
},
"targetKey": {
"type": "string"
},
"x": {
"type": "number"
},
"y": {
"type": "number"
}
},
"required": [
"targetKey",
"x",
"y"
],
"additionalProperties": false
}
},
{
"type": "null"
}
]
},
"imageSrc": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"source": {
"anyOf": [
{
"type": "string",
"enum": [
"image",
"text"
]
},
{
"type": "null"
}
]
}
},
"additionalProperties": false
},
{
"type": "null"
}
]
},
"formativeSectionId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"googleSlidePageId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"googleSlidePresentationId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"graph": {
"anyOf": [
{
"type": "object",
"properties": {
"correctAnswers": {
"type": "object",
"properties": {
"expressions": {
"anyOf": [
{
"type": "array",
"items": {
"type": "object",
"properties": {
"expression": {
"type": "string"
},
"id": {
"type": "string"
}
},
"required": [
"expression",
"id"
],
"additionalProperties": false
}
},
{
"type": "null"
}
]
},
"graphElements": {
"type": "array",
"items": {
"type": "object",
"properties": {
"asymptote": {
"anyOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"y": {
"type": "number"
}
},
"required": [
"id",
"y"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"dashed": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"function": {
"anyOf": [
{
"type": "string",
"enum": [
"ARCCOS",
"ARCSIN",
"ARCTAN",
"COS",
"SIN",
"TAN"
]
},
{
"type": "null"
}
]
},
"id": {
"type": "string"
},
"pointA": {
"anyOf": [
{
"type": "object",
"properties": {
"dotted": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"id": {
"type": "string"
},
"x": {
"type": "number"
},
"y": {
"type": "number"
}
},
"required": [
"id",
"x",
"y"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"pointB": {
"anyOf": [
{
"type": "object",
"properties": {
"dotted": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"id": {
"type": "string"
},
"x": {
"type": "number"
},
"y": {
"type": "number"
}
},
"required": [
"id",
"x",
"y"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"pointC": {
"anyOf": [
{
"type": "object",
"properties": {
"dotted": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"id": {
"type": "string"
},
"x": {
"type": "number"
},
"y": {
"type": "number"
}
},
"required": [
"id",
"x",
"y"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"points": {
"anyOf": [
{
"type": "array",
"items": {
"type": "object",
"properties": {
"dotted": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"id": {
"type": "string"
},
"x": {
"type": "number"
},
"y": {
"type": "number"
}
},
"required": [
"id",
"x",
"y"
],
"additionalProperties": false
}
},
{
"type": "null"
}
]
},
"rightPoint": {
"anyOf": [
{
"type": "object",
"properties": {
"dotted": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"id": {
"type": "string"
},
"x": {
"type": "number"
},
"y": {
"type": "number"
}
},
"required": [
"id",
"x",
"y"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"type": {
"type": "string",
"enum": [
"EXPONENTIAL",
"LINE",
"NUMBER_LINE",
"PARABOLA",
"POINTS",
"TRIG"
]
},
"vertex": {
"anyOf": [
{
"type": "object",
"properties": {
"dotted": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"id": {
"type": "string"
},
"x": {
"type": "number"
},
"y": {
"type": "number"
}
},
"required": [
"id",
"x",
"y"
],
"additionalProperties": false
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"type"
],
"additionalProperties": false
}
},
"inequalitySets": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"inequalities": {
"type": "array",
"items": {
"type": "object",
"properties": {
"graphElementId": {
"type": "string"
},
"inverse": {
"type": "boolean"
}
},
"required": [
"graphElementId",
"inverse"
],
"additionalProperties": false
}
}
},
"required": [
"id",
"inequalities"
],
"additionalProperties": false
}
}
},
"required": [
"graphElements",
"inequalitySets"
],
"additionalProperties": false
},
"pointDisplayToStudents": {
"anyOf": [
{
"type": "string",
"enum": [
"hidden",
"optional",
"visible"
]
},
{
"type": "null"
}
]
},
"shadingEnabled": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"studentsChooseLineType": {
"type": "boolean"
},
"tickLabelDisplay": {
"anyOf": [
{
"type": "string",
"enum": [
"all",
"endpoints",
"none",
"wholeNumbers"
]
},
{
"type": "null"
}
]
},
"tickType": {
"anyOf": [
{
"type": "string",
"enum": [
"decimal",
"fraction",
"pi"
]
},
{
"type": "null"
}
]
},
"viewBoundingBox": {
"anyOf": [
{
"type": "object",
"properties": {
"xMax": {
"type": "number"
},
"xMin": {
"type": "number"
},
"yMax": {
"type": "number"
},
"yMin": {
"type": "number"
}
},
"required": [
"xMax",
"xMin",
"yMax",
"yMin"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"xAxisLabel": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"xAxisMax": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"xAxisMin": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"xAxisStep": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"xInterceptEnabled": {
"type": "boolean"
},
"xTickType": {
"anyOf": [
{
"type": "string",
"enum": [
"decimal",
"fraction",
"pi"
]
},
{
"type": "null"
}
]
},
"yAxisLabel": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"yAxisMax": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"yAxisMin": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"yAxisStep": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"yInterceptEnabled": {
"type": "boolean"
},
"yTickType": {
"anyOf": [
{
"type": "string",
"enum": [
"decimal",
"fraction",
"pi"
]
},
{
"type": "null"
}
]
}
},
"required": [
"correctAnswers",
"studentsChooseLineType",
"xInterceptEnabled",
"yInterceptEnabled"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"helpText": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"hint": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"hints": {
"anyOf": [
{
"type": "array",
"items": {
"type": "object",
"properties": {
"hint": {
"type": "string"
},
"id": {
"type": "string"
}
},
"required": [
"hint",
"id"
],
"additionalProperties": false
}
},
{
"type": "null"
}
]
},
"hotSpot": {
"anyOf": [
{
"type": "object",
"properties": {
"correctAnswers": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
]
},
"isMultiSelect": {
"type": "boolean"
},
"shapes": {
"anyOf": [
{
"type": "array",
"items": {
"type": "object",
"properties": {
"key": {
"type": "string"
},
"shape": {}
},
"required": [
"key",
"shape"
],
"additionalProperties": false
}
},
{
"type": "null"
}
]
}
},
"required": [
"isMultiSelect"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"hotText": {
"anyOf": [
{
"type": "object",
"properties": {
"choices": {
"anyOf": [
{
"type": "array",
"items": {
"type": "object",
"properties": {
"choice": {
"type": "string"
},
"key": {
"type": "string"
}
},
"required": [
"choice",
"key"
],
"additionalProperties": false
}
},
{
"type": "null"
}
]
},
"correctAnswers": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
]
},
"isMultiSelect": {
"type": "boolean"
},
"text": {
"type": "string"
}
},
"required": [
"isMultiSelect",
"text"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"isCaseSensitive": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"isDrawingEnabled": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"isExtraCreditEnabled": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"isKeywordGrading": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"isPartialCredit": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"isRandomized": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"isRequired": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"isRubricEnabled": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"isRubricStudentViewDisabled": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"itemBankItemId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"labels": {
"anyOf": [
{
"type": "array",
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
{
"type": "null"
}
]
},
"lexileLevel": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"matchTableGrid": {
"anyOf": [
{
"type": "object",
"properties": {
"isMultiSelect": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
}
},
"additionalProperties": false
},
{
"type": "null"
}
]
},
"moveAfter": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"moveBefore": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"newselaContentId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"parentId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"partialCreditMode": {
"anyOf": [
{
"type": "string",
"enum": [
"ignoreIncorrect",
"original",
"standard",
"subtractIncorrect"
]
},
{
"type": "null"
}
]
},
"pinPosition": {
"anyOf": [
{
"type": "object",
"properties": {
"x": {
"type": "number"
},
"y": {
"type": "number"
}
},
"required": [
"x",
"y"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"points": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"preventReuseChoices": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"preventSkippingVideo": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"preventVideoCC": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"preventVideoPlaybackSpeed": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"removeCanvasParts": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
]
},
"rubric": {
"anyOf": [
{
"type": "object",
"properties": {
"criteria": {
"type": "array",
"items": {
"type": "object",
"properties": {
"description": {
"type": "string"
},
"id": {
"type": "string"
},
"levels": {
"type": "array",
"items": {
"type": "object",
"properties": {
"description": {
"type": "string"
},
"id": {
"type": "string"
},
"points": {
"type": "number"
},
"title": {
"type": "string"
}
},
"required": [
"description",
"id",
"points",
"title"
],
"additionalProperties": false
}
},
"tagIds": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
]
},
"title": {
"type": "string"
}
},
"required": [
"description",
"id",
"levels",
"title"
],
"additionalProperties": false
}
},
"description": {
"type": "string"
},
"title": {
"type": "string"
}
},
"required": [
"criteria",
"description",
"title"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"saveCanvasParts": {
"anyOf": [
{
"type": "array",
"items": {
"type": "object",
"properties": {
"d": {
"type": "string"
},
"id": {
"type": "string"
}
},
"required": [
"d",
"id"
],
"additionalProperties": false
}
},
{
"type": "null"
}
]
},
"sequenceScoringMethod": {
"anyOf": [
{
"type": "string",
"enum": [
"exactPosition",
"relativeOrder"
]
},
{
"type": "null"
}
]
},
"setChoiceExplanation": {
"anyOf": [
{
"type": "object",
"properties": {
"choice": {
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"choice",
"value"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"setChoiceExplanations": {
"anyOf": [
{
"type": "array",
"items": {
"type": "object",
"properties": {
"choice": {
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"choice",
"value"
],
"additionalProperties": false
}
},
{
"type": "null"
}
]
},
"showWordCount": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"src": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"styleId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"subtype": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"tabs": {
"anyOf": [
{
"type": "array",
"items": {
"type": "object",
"properties": {
"position": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"text": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"position"
],
"additionalProperties": false
}
},
{
"type": "null"
}
]
},
"tags": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
]
},
"targets": {
"anyOf": [
{
"type": "array",
"items": {
"type": "object",
"properties": {
"choices": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
]
},
"label": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"additionalProperties": false
}
},
{
"type": "null"
}
]
},
"text": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"timestamp": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"variants": {
"anyOf": [
{
"type": "array",
"items": {
"type": "object",
"properties": {
"correctAnswer": {
"type": "string"
},
"statement": {
"type": "string"
}
},
"required": [
"correctAnswer",
"statement"
],
"additionalProperties": false
}
},
{
"type": "null"
}
]
},
"videoPlaybackRate": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"videoTrimLocations": {
"anyOf": [
{
"type": "array",
"items": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
}
},
{
"type": "null"
}
]
},
"whiteboardGridSettings": {
"anyOf": [
{
"type": "object",
"properties": {
"active": {
"anyOf": [
{
"type": "object",
"properties": {
"enabled": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"locked": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
}
},
"additionalProperties": false
},
{
"type": "null"
}
]
},
"dots": {
"anyOf": [
{
"type": "object",
"properties": {
"enabled": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"locked": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
}
},
"additionalProperties": false
},
{
"type": "null"
}
]
},
"snap": {
"anyOf": [
{
"type": "object",
"properties": {
"enabled": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"locked": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
}
},
"additionalProperties": false
},
{
"type": "null"
}
]
}
},
"additionalProperties": false
},
{
"type": "null"
}
]
}
},
"additionalProperties": false
},
"subtype": {
"type": "string",
"enum": [
"audio",
"audioContent",
"bubbleSheet",
"categorize",
"dragAndDrop",
"embed",
"file",
"fillInTheBlank",
"functionalizedAudio",
"functionalizedBubbleSheet",
"functionalizedEmbed",
"functionalizedImage",
"functionalizedMultiPart",
"functionalizedNewselaArticle",
"functionalizedPairedPassages",
"functionalizedSlides",
"functionalizedText",
"functionalizedVideo",
"functionalizedWhiteBoard",
"graph",
"graphing",
"hotSpot",
"hotText",
"image",
"inlineChoice",
"longAnswer",
"matchTableGrid",
"matching",
"multipleChoice",
"multipleSelection",
"newselaArticle",
"numberLine",
"numeric",
"pairedPassages",
"resequence",
"shortAnswer",
"showYourWork",
"slides",
"text",
"trueOrFalse",
"video",
"videoAnswer",
"whiteBoard"
]
}
},
"required": [
"input",
"subtype"
],
"additionalProperties": false
}
},
{
"type": "null"
}
]
},
"lesson": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"newselaContentGrantIds": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
]
},
"note": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"practiceItems": {
"anyOf": [
{
"type": "array",
"items": {
"type": "object",
"properties": {
"flashcard": {
"anyOf": [
{
"type": "object",
"properties": {
"backContent": {
"anyOf": [
{
"type": "object",
"properties": {
"audioSrc": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"imageSrc": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"text": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"additionalProperties": false
},
{
"type": "null"
}
]
},
"frontContent": {
"anyOf": [
{
"type": "object",
"properties": {
"audioSrc": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"imageSrc": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"text": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"additionalProperties": false
},
{
"type": "null"
}
]
}
},
"additionalProperties": false
},
{
"type": "null"
}
]
}
},
"additionalProperties": false
}
},
{
"type": "null"
}
]
},
"practiceSet": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"questionNumberingScheme": {
"anyOf": [
{
"type": "string",
"enum": [
"BY_SECTION",
"DEFAULT"
]
},
{
"type": "null"
}
]
},
"richTextV2": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"sections": {
"anyOf": [
{
"type": "array",
"items": {
"type": "object",
"properties": {
"addBeforeFormativeItemId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"description": {
"type": "string"
},
"headerImage": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"id": {
"type": "string"
},
"instructions": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"note": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"position": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"preserveItemOrder": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"sectionColor": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"description",
"id",
"position"
],
"additionalProperties": false
}
},
{
"type": "null"
}
]
},
"tags": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
]
},
"themeId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"additionalProperties": false
}
},
"required": [
"input"
],
"additionalProperties": false
},
"page": "/login"
}addFormativeItemAction
Add a new item (question or content) to a formative. Requires ownership of the formative. **Question Types and Configuration:** **Multiple Choice** (type: "multipleChoice") - choices: ["A", "B", "C", "D"] - Choice keys - choiceLabels: ["Option 1", "Option 2", ...] - Display text for each choice - correctAnswers: ["B"] - Which choice is correct - isRandomized: true/false - Randomize choice order **Multiple Selection** (type: "multipleSelection") - Same as multiple choice, but correctAnswers can have multiple values - isPartialCredit: true/false - Enable partial credit - partialCreditMode: "proportional" | "standard" | "subtractIncorrect" **True or False** (type: "trueOrFalse") - correctAnswers: ["true"] or ["false"] **Short Answer** (type: "shortAnswer") - correctAnswers: ["Paris", "paris"] - Accepted answers - isCaseSensitive: true/false **Long Answer / Essay** (type: "longAnswer") - showWordCount: true/false - isDrawingEnabled: true/false **Numeric** (type: "numeric") - correctAnswers: ["42", "42.0"] - allowEquivalencies: "basic" | "algebraic" - Accept equivalent forms **Fill in the Blank** (type: "fillInTheBlank") - blanks: [{ key: "blank-1", correctAnswers: ["answer"] }] - Text uses {{blank-1}} syntax for blank placeholders **Matching** (type: "matching") - choices: ["A", "B", "C"] - Items to match - choiceLabels: ["Item 1", "Item 2", "Item 3"] - labels: ["Target 1", "Target 2", "Target 3"] - Targets to match to - correctAnswers: ["A", "B", "C"] - Maps choices[i] to labels[correctAnswers[i]] **Categorize** (type: "categorize") - choices: ["A", "B", "C"] - Items to categorize - choiceLabels: ["Item 1", "Item 2", "Item 3"] - targets: [{ key: "cat1", text: "Category 1", choices: ["A", "B"] }] **Resequence** (type: "resequence") - choices: ["A", "B", "C"] - Items to reorder - choiceLabels: ["First", "Second", "Third"] - correctAnswers: ["A", "B", "C"] - Correct order **Hot Spot** (type: "hotSpot") - hotSpot: { shapes: [...], correctAnswers: ["shape-1"], isMultiSelect: false } - Requires image src **Hot Text** (type: "hotText") - hotText: { text: "...", choices: [...], correctAnswers: ["choice-1"], isMultiSelect: false } **Content Types:** - text: Display text/instructions - image: src = image URL, alternateText = alt text - video: src = video URL - audio: src = audio URL **Common Options:** - points: number (default 1) - isRequired: true/false - hints: [{ text: "Hint 1" }, { text: "Hint 2" }]
View tool JSON
{
"name": "addFormativeItem",
"kind": "act",
"impl": "imperative",
"description": "Add a new item (question or content) to a formative. Requires ownership of the formative.\n\n**Question Types and Configuration:**\n\n**Multiple Choice** (type: \"multipleChoice\")\n- choices: [\"A\", \"B\", \"C\", \"D\"] - Choice keys\n- choiceLabels: [\"Option 1\", \"Option 2\", ...] - Display text for each choice\n- correctAnswers: [\"B\"] - Which choice is correct\n- isRandomized: true/false - Randomize choice order\n\n**Multiple Selection** (type: \"multipleSelection\")\n- Same as multiple choice, but correctAnswers can have multiple values\n- isPartialCredit: true/false - Enable partial credit\n- partialCreditMode: \"proportional\" | \"standard\" | \"subtractIncorrect\"\n\n**True or False** (type: \"trueOrFalse\")\n- correctAnswers: [\"true\"] or [\"false\"]\n\n**Short Answer** (type: \"shortAnswer\")\n- correctAnswers: [\"Paris\", \"paris\"] - Accepted answers\n- isCaseSensitive: true/false\n\n**Long Answer / Essay** (type: \"longAnswer\")\n- showWordCount: true/false\n- isDrawingEnabled: true/false\n\n**Numeric** (type: \"numeric\")\n- correctAnswers: [\"42\", \"42.0\"]\n- allowEquivalencies: \"basic\" | \"algebraic\" - Accept equivalent forms\n\n**Fill in the Blank** (type: \"fillInTheBlank\")\n- blanks: [{ key: \"blank-1\", correctAnswers: [\"answer\"] }]\n- Text uses {{blank-1}} syntax for blank placeholders\n\n**Matching** (type: \"matching\")\n- choices: [\"A\", \"B\", \"C\"] - Items to match\n- choiceLabels: [\"Item 1\", \"Item 2\", \"Item 3\"]\n- labels: [\"Target 1\", \"Target 2\", \"Target 3\"] - Targets to match to\n- correctAnswers: [\"A\", \"B\", \"C\"] - Maps choices[i] to labels[correctAnswers[i]]\n\n**Categorize** (type: \"categorize\")\n- choices: [\"A\", \"B\", \"C\"] - Items to categorize\n- choiceLabels: [\"Item 1\", \"Item 2\", \"Item 3\"]\n- targets: [{ key: \"cat1\", text: \"Category 1\", choices: [\"A\", \"B\"] }]\n\n**Resequence** (type: \"resequence\")\n- choices: [\"A\", \"B\", \"C\"] - Items to reorder\n- choiceLabels: [\"First\", \"Second\", \"Third\"]\n- correctAnswers: [\"A\", \"B\", \"C\"] - Correct order\n\n**Hot Spot** (type: \"hotSpot\")\n- hotSpot: { shapes: [...], correctAnswers: [\"shape-1\"], isMultiSelect: false }\n- Requires image src\n\n**Hot Text** (type: \"hotText\")\n- hotText: { text: \"...\", choices: [...], correctAnswers: [\"choice-1\"], isMultiSelect: false }\n\n**Content Types:**\n- text: Display text/instructions\n- image: src = image URL, alternateText = alt text\n- video: src = video URL\n- audio: src = audio URL\n\n**Common Options:**\n- points: number (default 1)\n- isRequired: true/false\n- hints: [{ text: \"Hint 1\" }, { text: \"Hint 2\" }]",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"properties": {
"formativeId": {
"type": "string"
},
"subtype": {
"type": "string",
"enum": [
"audio",
"audioContent",
"bubbleSheet",
"categorize",
"dragAndDrop",
"embed",
"file",
"fillInTheBlank",
"functionalizedAudio",
"functionalizedBubbleSheet",
"functionalizedEmbed",
"functionalizedImage",
"functionalizedMultiPart",
"functionalizedNewselaArticle",
"functionalizedPairedPassages",
"functionalizedSlides",
"functionalizedText",
"functionalizedVideo",
"functionalizedWhiteBoard",
"graph",
"graphing",
"hotSpot",
"hotText",
"image",
"inlineChoice",
"longAnswer",
"matchTableGrid",
"matching",
"multipleChoice",
"multipleSelection",
"newselaArticle",
"numberLine",
"numeric",
"pairedPassages",
"resequence",
"shortAnswer",
"showYourWork",
"slides",
"text",
"trueOrFalse",
"video",
"videoAnswer",
"whiteBoard"
]
},
"input": {
"type": "object",
"properties": {
"allowEquivalencies": {
"anyOf": [
{
"type": "string",
"enum": [
"ALGEBRAIC",
"BASIC",
"PERCENTAGE_TOLERANCE",
"RANGE",
"TOLERANCE"
]
},
{
"type": "null"
}
]
},
"alternateText": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"answerChoicePoints": {
"anyOf": [
{
"type": "array",
"items": {
"type": "number"
}
},
{
"type": "null"
}
]
},
"areChoiceExplanationsEnabled": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"blanks": {
"anyOf": [
{
"type": "array",
"items": {
"type": "object",
"properties": {
"choiceLabels": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
]
},
"choices": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
]
},
"correctAnswers": {
"type": "array",
"items": {
"type": "string"
}
},
"key": {
"type": "string"
},
"numeric": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
}
},
"required": [
"correctAnswers",
"key"
],
"additionalProperties": false
}
},
{
"type": "null"
}
]
},
"canvas": {
"anyOf": [
{},
{
"type": "null"
}
]
},
"canvasImageList": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
]
},
"childItemBankItemId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"choiceLabels": {
"anyOf": [
{
"type": "array",
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
{
"type": "null"
}
]
},
"choices": {
"anyOf": [
{
"type": "array",
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
{
"type": "null"
}
]
},
"citation": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"correctAnswers": {
"anyOf": [
{
"type": "array",
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
{
"type": "null"
}
]
},
"deleted": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"deletedAt": {
"anyOf": [
{
"anyOf": [
{
"type": "string"
},
{
"type": "number"
}
]
},
{
"type": "null"
}
]
},
"dragAndDrop": {
"anyOf": [
{
"type": "object",
"properties": {
"choices": {
"anyOf": [
{
"type": "array",
"items": {
"type": "object",
"properties": {
"key": {
"type": "string"
},
"label": {
"type": "string"
}
},
"required": [
"key",
"label"
],
"additionalProperties": false
}
},
{
"type": "null"
}
]
},
"correctAnswers": {
"anyOf": [
{
"type": "array",
"items": {
"type": "object",
"properties": {
"choiceKey": {
"type": "string"
},
"targetKey": {
"type": "string"
}
},
"required": [
"choiceKey",
"targetKey"
],
"additionalProperties": false
}
},
{
"type": "null"
}
]
},
"dropLocations": {
"anyOf": [
{
"type": "array",
"items": {
"type": "object",
"properties": {
"placement": {
"anyOf": [
{
"type": "string",
"enum": [
"auto",
"bottom",
"left",
"right",
"top"
]
},
{
"type": "null"
}
]
},
"targetKey": {
"type": "string"
},
"x": {
"type": "number"
},
"y": {
"type": "number"
}
},
"required": [
"targetKey",
"x",
"y"
],
"additionalProperties": false
}
},
{
"type": "null"
}
]
},
"imageSrc": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"source": {
"anyOf": [
{
"type": "string",
"enum": [
"image",
"text"
]
},
{
"type": "null"
}
]
}
},
"additionalProperties": false
},
{
"type": "null"
}
]
},
"formativeSectionId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"googleSlidePageId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"googleSlidePresentationId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"graph": {
"anyOf": [
{
"type": "object",
"properties": {
"correctAnswers": {
"type": "object",
"properties": {
"expressions": {
"anyOf": [
{
"type": "array",
"items": {
"type": "object",
"properties": {
"expression": {
"type": "string"
},
"id": {
"type": "string"
}
},
"required": [
"expression",
"id"
],
"additionalProperties": false
}
},
{
"type": "null"
}
]
},
"graphElements": {
"type": "array",
"items": {
"type": "object",
"properties": {
"asymptote": {
"anyOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"y": {
"type": "number"
}
},
"required": [
"id",
"y"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"dashed": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"function": {
"anyOf": [
{
"type": "string",
"enum": [
"ARCCOS",
"ARCSIN",
"ARCTAN",
"COS",
"SIN",
"TAN"
]
},
{
"type": "null"
}
]
},
"id": {
"type": "string"
},
"pointA": {
"anyOf": [
{
"type": "object",
"properties": {
"dotted": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"id": {
"type": "string"
},
"x": {
"type": "number"
},
"y": {
"type": "number"
}
},
"required": [
"id",
"x",
"y"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"pointB": {
"anyOf": [
{
"type": "object",
"properties": {
"dotted": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"id": {
"type": "string"
},
"x": {
"type": "number"
},
"y": {
"type": "number"
}
},
"required": [
"id",
"x",
"y"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"pointC": {
"anyOf": [
{
"type": "object",
"properties": {
"dotted": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"id": {
"type": "string"
},
"x": {
"type": "number"
},
"y": {
"type": "number"
}
},
"required": [
"id",
"x",
"y"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"points": {
"anyOf": [
{
"type": "array",
"items": {
"type": "object",
"properties": {
"dotted": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"id": {
"type": "string"
},
"x": {
"type": "number"
},
"y": {
"type": "number"
}
},
"required": [
"id",
"x",
"y"
],
"additionalProperties": false
}
},
{
"type": "null"
}
]
},
"rightPoint": {
"anyOf": [
{
"type": "object",
"properties": {
"dotted": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"id": {
"type": "string"
},
"x": {
"type": "number"
},
"y": {
"type": "number"
}
},
"required": [
"id",
"x",
"y"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"type": {
"type": "string",
"enum": [
"EXPONENTIAL",
"LINE",
"NUMBER_LINE",
"PARABOLA",
"POINTS",
"TRIG"
]
},
"vertex": {
"anyOf": [
{
"type": "object",
"properties": {
"dotted": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"id": {
"type": "string"
},
"x": {
"type": "number"
},
"y": {
"type": "number"
}
},
"required": [
"id",
"x",
"y"
],
"additionalProperties": false
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"type"
],
"additionalProperties": false
}
},
"inequalitySets": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"inequalities": {
"type": "array",
"items": {
"type": "object",
"properties": {
"graphElementId": {
"type": "string"
},
"inverse": {
"type": "boolean"
}
},
"required": [
"graphElementId",
"inverse"
],
"additionalProperties": false
}
}
},
"required": [
"id",
"inequalities"
],
"additionalProperties": false
}
}
},
"required": [
"graphElements",
"inequalitySets"
],
"additionalProperties": false
},
"pointDisplayToStudents": {
"anyOf": [
{
"type": "string",
"enum": [
"hidden",
"optional",
"visible"
]
},
{
"type": "null"
}
]
},
"shadingEnabled": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"studentsChooseLineType": {
"type": "boolean"
},
"tickLabelDisplay": {
"anyOf": [
{
"type": "string",
"enum": [
"all",
"endpoints",
"none",
"wholeNumbers"
]
},
{
"type": "null"
}
]
},
"tickType": {
"anyOf": [
{
"type": "string",
"enum": [
"decimal",
"fraction",
"pi"
]
},
{
"type": "null"
}
]
},
"viewBoundingBox": {
"anyOf": [
{
"type": "object",
"properties": {
"xMax": {
"type": "number"
},
"xMin": {
"type": "number"
},
"yMax": {
"type": "number"
},
"yMin": {
"type": "number"
}
},
"required": [
"xMax",
"xMin",
"yMax",
"yMin"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"xAxisLabel": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"xAxisMax": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"xAxisMin": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"xAxisStep": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"xInterceptEnabled": {
"type": "boolean"
},
"xTickType": {
"anyOf": [
{
"type": "string",
"enum": [
"decimal",
"fraction",
"pi"
]
},
{
"type": "null"
}
]
},
"yAxisLabel": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"yAxisMax": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"yAxisMin": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"yAxisStep": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"yInterceptEnabled": {
"type": "boolean"
},
"yTickType": {
"anyOf": [
{
"type": "string",
"enum": [
"decimal",
"fraction",
"pi"
]
},
{
"type": "null"
}
]
}
},
"required": [
"correctAnswers",
"studentsChooseLineType",
"xInterceptEnabled",
"yInterceptEnabled"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"helpText": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"hint": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"hints": {
"anyOf": [
{
"type": "array",
"items": {
"type": "object",
"properties": {
"hint": {
"type": "string"
},
"id": {
"type": "string"
}
},
"required": [
"hint",
"id"
],
"additionalProperties": false
}
},
{
"type": "null"
}
]
},
"hotSpot": {
"anyOf": [
{
"type": "object",
"properties": {
"correctAnswers": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
]
},
"isMultiSelect": {
"type": "boolean"
},
"shapes": {
"anyOf": [
{
"type": "array",
"items": {
"type": "object",
"properties": {
"key": {
"type": "string"
},
"shape": {}
},
"required": [
"key",
"shape"
],
"additionalProperties": false
}
},
{
"type": "null"
}
]
}
},
"required": [
"isMultiSelect"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"hotText": {
"anyOf": [
{
"type": "object",
"properties": {
"choices": {
"anyOf": [
{
"type": "array",
"items": {
"type": "object",
"properties": {
"choice": {
"type": "string"
},
"key": {
"type": "string"
}
},
"required": [
"choice",
"key"
],
"additionalProperties": false
}
},
{
"type": "null"
}
]
},
"correctAnswers": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
]
},
"isMultiSelect": {
"type": "boolean"
},
"text": {
"type": "string"
}
},
"required": [
"isMultiSelect",
"text"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"isCaseSensitive": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"isDrawingEnabled": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"isExtraCreditEnabled": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"isKeywordGrading": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"isPartialCredit": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"isRandomized": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"isRequired": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"isRubricEnabled": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"isRubricStudentViewDisabled": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"itemBankItemId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"labels": {
"anyOf": [
{
"type": "array",
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
{
"type": "null"
}
]
},
"lexileLevel": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"matchTableGrid": {
"anyOf": [
{
"type": "object",
"properties": {
"isMultiSelect": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
}
},
"additionalProperties": false
},
{
"type": "null"
}
]
},
"moveAfter": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"moveBefore": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"newselaContentId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"parentId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"partialCreditMode": {
"anyOf": [
{
"type": "string",
"enum": [
"ignoreIncorrect",
"original",
"standard",
"subtractIncorrect"
]
},
{
"type": "null"
}
]
},
"pinPosition": {
"anyOf": [
{
"type": "object",
"properties": {
"x": {
"type": "number"
},
"y": {
"type": "number"
}
},
"required": [
"x",
"y"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"points": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"preventReuseChoices": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"preventSkippingVideo": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"preventVideoCC": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"preventVideoPlaybackSpeed": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"removeCanvasParts": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
]
},
"rubric": {
"anyOf": [
{
"type": "object",
"properties": {
"criteria": {
"type": "array",
"items": {
"type": "object",
"properties": {
"description": {
"type": "string"
},
"id": {
"type": "string"
},
"levels": {
"type": "array",
"items": {
"type": "object",
"properties": {
"description": {
"type": "string"
},
"id": {
"type": "string"
},
"points": {
"type": "number"
},
"title": {
"type": "string"
}
},
"required": [
"description",
"id",
"points",
"title"
],
"additionalProperties": false
}
},
"tagIds": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
]
},
"title": {
"type": "string"
}
},
"required": [
"description",
"id",
"levels",
"title"
],
"additionalProperties": false
}
},
"description": {
"type": "string"
},
"title": {
"type": "string"
}
},
"required": [
"criteria",
"description",
"title"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"saveCanvasParts": {
"anyOf": [
{
"type": "array",
"items": {
"type": "object",
"properties": {
"d": {
"type": "string"
},
"id": {
"type": "string"
}
},
"required": [
"d",
"id"
],
"additionalProperties": false
}
},
{
"type": "null"
}
]
},
"sequenceScoringMethod": {
"anyOf": [
{
"type": "string",
"enum": [
"exactPosition",
"relativeOrder"
]
},
{
"type": "null"
}
]
},
"setChoiceExplanation": {
"anyOf": [
{
"type": "object",
"properties": {
"choice": {
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"choice",
"value"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"setChoiceExplanations": {
"anyOf": [
{
"type": "array",
"items": {
"type": "object",
"properties": {
"choice": {
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"choice",
"value"
],
"additionalProperties": false
}
},
{
"type": "null"
}
]
},
"showWordCount": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"src": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"styleId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"subtype": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"tabs": {
"anyOf": [
{
"type": "array",
"items": {
"type": "object",
"properties": {
"position": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"text": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"position"
],
"additionalProperties": false
}
},
{
"type": "null"
}
]
},
"tags": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
]
},
"targets": {
"anyOf": [
{
"type": "array",
"items": {
"type": "object",
"properties": {
"choices": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
]
},
"label": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"additionalProperties": false
}
},
{
"type": "null"
}
]
},
"text": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"timestamp": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"variants": {
"anyOf": [
{
"type": "array",
"items": {
"type": "object",
"properties": {
"correctAnswer": {
"type": "string"
},
"statement": {
"type": "string"
}
},
"required": [
"correctAnswer",
"statement"
],
"additionalProperties": false
}
},
{
"type": "null"
}
]
},
"videoPlaybackRate": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"videoTrimLocations": {
"anyOf": [
{
"type": "array",
"items": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
}
},
{
"type": "null"
}
]
},
"whiteboardGridSettings": {
"anyOf": [
{
"type": "object",
"properties": {
"active": {
"anyOf": [
{
"type": "object",
"properties": {
"enabled": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"locked": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
}
},
"additionalProperties": false
},
{
"type": "null"
}
]
},
"dots": {
"anyOf": [
{
"type": "object",
"properties": {
"enabled": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"locked": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
}
},
"additionalProperties": false
},
{
"type": "null"
}
]
},
"snap": {
"anyOf": [
{
"type": "object",
"properties": {
"enabled": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"locked": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
}
},
"additionalProperties": false
},
{
"type": "null"
}
]
}
},
"additionalProperties": false
},
{
"type": "null"
}
]
}
},
"additionalProperties": false
}
},
"required": [
"formativeId",
"subtype",
"input"
],
"additionalProperties": false
},
"page": "/login"
}addOneRosterAction
Create a new OneRoster import configuration
View tool JSON
{
"name": "addOneRoster",
"kind": "act",
"impl": "imperative",
"description": "Create a new OneRoster import configuration",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"properties": {
"input": {
"type": "object",
"properties": {
"active": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"applyChanges": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"archiveUsersWhenDeleted": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"classEndGracePeriod": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"classStartGracePeriod": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"dataSourceName": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"defaultStudentPasswords": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"emailDomains": {
"anyOf": [
{
"type": "array",
"items": {
"type": "object",
"properties": {
"aliases": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
]
},
"domain": {
"type": "string"
},
"verified": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
}
},
"required": [
"domain"
],
"additionalProperties": false
}
},
{
"type": "null"
}
]
},
"endDate": {
"anyOf": [
{
"anyOf": [
{
"type": "string"
},
{
"type": "number"
}
]
},
{
"type": "null"
}
]
},
"fetchBatchSize": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"gradeWhitelist": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
]
},
"ignoreUsernames": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"importConcurrency": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"importDemographics": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"importSections": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"maxConcurrentRequests": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"mergeConflictingUsers": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"notificationEmails": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
]
},
"notificationFailurePeriod": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"oauthKey": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"oauthMethod": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"oauthSecret": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"oauthUrl": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"oneRosterLogin": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"orgId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"orgWhitelist": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
]
},
"preferredHour": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"reuseExistingSectionOnTermsMismatch": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"roleWhitelist": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
]
},
"sendAccountCreatedNotification": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"startDate": {
"anyOf": [
{
"anyOf": [
{
"type": "string"
},
{
"type": "number"
}
]
},
{
"type": "null"
}
]
},
"subjects": {
"anyOf": [
{
"type": "array",
"items": {
"type": "object",
"properties": {
"mapping": {
"type": "string"
},
"name": {
"type": "string"
}
},
"required": [
"mapping",
"name"
],
"additionalProperties": false
}
},
{
"type": "null"
}
]
},
"uploadUrlWithEncryptedPassword": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"version": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"additionalProperties": false
}
},
"required": [
"input"
],
"additionalProperties": false
},
"page": "/login"
}addOrgAction
Create a new organization
View tool JSON
{
"name": "addOrg",
"kind": "act",
"impl": "imperative",
"description": "Create a new organization",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"properties": {
"input": {
"type": "object",
"properties": {
"addresses": {
"anyOf": [
{
"type": "array",
"items": {
"type": "object",
"properties": {
"city": {
"type": "string"
},
"country": {
"type": "string"
},
"state": {
"type": "string"
},
"street": {
"type": "string"
},
"zip": {
"type": "string"
}
},
"required": [
"city",
"country",
"state",
"street",
"zip"
],
"additionalProperties": false
}
},
{
"type": "null"
}
]
},
"identifier": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"name": {
"type": "string"
},
"parentId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"type": {
"anyOf": [
{
"type": "string",
"enum": [
"DEPARTMENT",
"DISTRICT",
"LOCAL",
"NATIONAL",
"OTHER",
"SCHOOL",
"STATE"
]
},
{
"type": "null"
}
]
},
"userRoles": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
]
}
},
"required": [
"name"
],
"additionalProperties": false
}
},
"required": [
"input"
],
"additionalProperties": false
},
"page": "/login"
}addOrgNoteAction
Attach an internal note to an organization
View tool JSON
{
"name": "addOrgNote",
"kind": "act",
"impl": "imperative",
"description": "Attach an internal note to an organization",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"properties": {
"input": {
"type": "object",
"properties": {
"note": {
"type": "string"
},
"orgId": {
"type": "string"
}
},
"required": [
"note",
"orgId"
],
"additionalProperties": false
}
},
"required": [
"input"
],
"additionalProperties": false
},
"page": "/login"
}addPracticeAnswerSensitive Action
Submit an answer for a practice item
View tool JSON
{
"name": "addPracticeAnswer",
"kind": "transact",
"impl": "imperative",
"description": "Submit an answer for a practice item",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"properties": {
"input": {
"type": "object",
"properties": {
"flashcard": {
"anyOf": [
{
"type": "object",
"properties": {
"correct": {
"type": "boolean"
}
},
"required": [
"correct"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"matching": {
"anyOf": [
{
"type": "object",
"properties": {
"correct": {
"type": "boolean"
}
},
"required": [
"correct"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"practiceSessionId": {
"type": "string"
},
"quiz": {
"anyOf": [
{
"type": "object",
"properties": {
"correct": {
"type": "boolean"
}
},
"required": [
"correct"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"write": {
"anyOf": [
{
"type": "object",
"properties": {
"correct": {
"type": "boolean"
}
},
"required": [
"correct"
],
"additionalProperties": false
},
{
"type": "null"
}
]
}
},
"required": [
"practiceSessionId"
],
"additionalProperties": false
},
"practiceItemId": {
"type": "string"
}
},
"required": [
"input",
"practiceItemId"
],
"additionalProperties": false
},
"page": "/login"
}addPracticeItemAction
Add a practice item to a practice set
View tool JSON
{
"name": "addPracticeItem",
"kind": "act",
"impl": "imperative",
"description": "Add a practice item to a practice set",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"properties": {
"input": {
"type": "object",
"properties": {
"flashcard": {
"anyOf": [
{
"type": "object",
"properties": {
"backContent": {
"anyOf": [
{
"type": "object",
"properties": {
"audioSrc": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"imageSrc": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"text": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"additionalProperties": false
},
{
"type": "null"
}
]
},
"frontContent": {
"anyOf": [
{
"type": "object",
"properties": {
"audioSrc": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"imageSrc": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"text": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"additionalProperties": false
},
{
"type": "null"
}
]
}
},
"additionalProperties": false
},
{
"type": "null"
}
]
}
},
"additionalProperties": false
},
"practiceSetId": {
"type": "string"
}
},
"required": [
"input",
"practiceSetId"
],
"additionalProperties": false
},
"page": "/login"
}addQuickLinkAction
Create a quick link
View tool JSON
{
"name": "addQuickLink",
"kind": "act",
"impl": "imperative",
"description": "Create a quick link",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"properties": {
"input": {
"type": "object",
"properties": {
"customLink": {
"anyOf": [
{
"type": "object",
"properties": {
"title": {
"type": "string"
},
"url": {
"type": "string"
}
},
"required": [
"title",
"url"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"folderId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"formativeId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"parentFolderId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"additionalProperties": false
}
},
"required": [
"input"
],
"additionalProperties": false
},
"page": "/login"
}addSectionAction
Create a new section (class). Note: In Formative, "section" and "class" are interchangeable terms. **Required:** - title: Section name (cannot contain emails or URLs) **Optional appearance:** - abbreviation: Short code (auto-generated from title if not provided) - color: Hex color code (defaults to gray) **Optional classification:** - grades: Array of grade levels (K=0, 1-12, 13=Higher Ed) - subjects: Array of subject names **Optional organization:** - orgId: Associate with an organization (requires membership) - onBehalfOfTeacherId: Create section owned by another teacher (requires admin/org manager permissions) **Example:** ```json { "input": { "title": "Algebra 2 - Period 3", "abbreviation": "ALG2-3", "color": "#e74c3c", "grades": [10, 11], "subjects": ["Math", "Algebra"] } } ```
View tool JSON
{
"name": "addSection",
"kind": "act",
"impl": "imperative",
"description": "Create a new section (class). Note: In Formative, \"section\" and \"class\" are interchangeable terms.\n\n**Required:**\n- title: Section name (cannot contain emails or URLs)\n\n**Optional appearance:**\n- abbreviation: Short code (auto-generated from title if not provided)\n- color: Hex color code (defaults to gray)\n\n**Optional classification:**\n- grades: Array of grade levels (K=0, 1-12, 13=Higher Ed)\n- subjects: Array of subject names\n\n**Optional organization:**\n- orgId: Associate with an organization (requires membership)\n- onBehalfOfTeacherId: Create section owned by another teacher (requires admin/org manager permissions)\n\n**Example:**\n```json\n{\n \"input\": {\n \"title\": \"Algebra 2 - Period 3\",\n \"abbreviation\": \"ALG2-3\",\n \"color\": \"#e74c3c\",\n \"grades\": [10, 11],\n \"subjects\": [\"Math\", \"Algebra\"]\n }\n}\n```",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"properties": {
"input": {
"type": "object",
"properties": {
"abbreviation": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"archived": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"cleverId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"color": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"googleClassroomId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"grades": {
"anyOf": [
{
"type": "array",
"items": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
}
},
{
"type": "null"
}
]
},
"locked": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"microsoft": {
"anyOf": [
{
"type": "object",
"properties": {
"classCode": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"course": {
"anyOf": [
{
"type": "object",
"properties": {
"courseNumber": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"displayName": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"externalId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"subject": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"additionalProperties": false
},
{
"type": "null"
}
]
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"displayName": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"externalId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"externalName": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"externalSource": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"externalSourceDetail": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"grade": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"members": {
"anyOf": [
{
"type": "array",
"items": {
"type": "object",
"properties": {
"accountEnabled": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"classes": {
"anyOf": [
{
"type": "array",
"items": {}
},
{
"type": "null"
}
]
},
"displayName": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"externalSource": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"externalSourceDetail": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"givenName": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"mail": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"mailNickname": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"microsoftTeamsClassroomUserId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"middleName": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"primaryRole": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"schools": {
"anyOf": [
{
"type": "array",
"items": {
"type": "object",
"properties": {
"address": {
"anyOf": [
{
"type": "object",
"properties": {
"city": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"countryOrRegion": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"postalCode": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"state": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"street": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"additionalProperties": false
},
{
"type": "null"
}
]
},
"classes": {
"anyOf": [
{
"type": "array",
"items": {}
},
{
"type": "null"
}
]
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"displayName": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"externalId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"externalPrincipalId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"externalSource": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"externalSourceDetail": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"fax": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"highestGrade": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"lowestGrade": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"phone": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"principalEmail": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"principalName": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"schoolNumber": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"users": {
"anyOf": [
{
"type": "array",
"items": {}
},
{
"type": "null"
}
]
}
},
"additionalProperties": false
}
},
{
"type": "null"
}
]
},
"student": {
"anyOf": [
{
"type": "object",
"properties": {
"birthDate": {
"anyOf": [
{
"anyOf": [
{
"type": "string"
},
{
"type": "number"
}
]
},
{
"type": "null"
}
]
},
"externalId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"gender": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"grade": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"graduationYear": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"studentNumber": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"additionalProperties": false
},
{
"type": "null"
}
]
},
"surname": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"teacher": {
"anyOf": [
{
"type": "object",
"properties": {
"externalId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"teacherNumber": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"additionalProperties": false
},
{
"type": "null"
}
]
},
"userPrincipalName": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"userType": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"additionalProperties": false
}
},
{
"type": "null"
}
]
},
"microsoftTeamsClassroomId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"schools": {
"anyOf": [
{
"type": "array",
"items": {
"type": "object",
"properties": {
"address": {
"anyOf": [
{
"type": "object",
"properties": {
"city": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"countryOrRegion": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"postalCode": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"state": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"street": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"additionalProperties": false
},
{
"type": "null"
}
]
},
"classes": {
"anyOf": [
{
"type": "array",
"items": {}
},
{
"type": "null"
}
]
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"displayName": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"externalId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"externalPrincipalId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"externalSource": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"externalSourceDetail": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"fax": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"highestGrade": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"lowestGrade": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"phone": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"principalEmail": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"principalName": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"schoolNumber": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"users": {
"anyOf": [
{
"type": "array",
"items": {
"type": "object",
"properties": {
"accountEnabled": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"classes": {
"anyOf": [
{
"type": "array",
"items": {}
},
{
"type": "null"
}
]
},
"displayName": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"externalSource": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"externalSourceDetail": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"givenName": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"mail": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"mailNickname": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"microsoftTeamsClassroomUserId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"middleName": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"primaryRole": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"schools": {
"anyOf": [
{
"type": "array",
"items": {}
},
{
"type": "null"
}
]
},
"student": {
"anyOf": [
{
"type": "object",
"properties": {
"birthDate": {
"anyOf": [
{
"anyOf": [
{
"type": "string"
},
{
"type": "number"
}
]
},
{
"type": "null"
}
]
},
"externalId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"gender": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"grade": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"graduationYear": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"studentNumber": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"additionalProperties": false
},
{
"type": "null"
}
]
},
"surname": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"teacher": {
"anyOf": [
{
"type": "object",
"properties": {
"externalId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"teacherNumber": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"additionalProperties": false
},
{
"type": "null"
}
]
},
"userPrincipalName": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"userType": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"additionalProperties": false
}
},
{
"type": "null"
}
]
}
},
"additionalProperties": false
}
},
{
"type": "null"
}
]
},
"teachers": {
"anyOf": [
{
"type": "array",
"items": {
"type": "object",
"properties": {
"accountEnabled": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"classes": {
"anyOf": [
{
"type": "array",
"items": {}
},
{
"type": "null"
}
]
},
"displayName": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"externalSource": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"externalSourceDetail": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"givenName": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"mail": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"mailNickname": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"microsoftTeamsClassroomUserId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"middleName": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"primaryRole": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"schools": {
"anyOf": [
{
"type": "array",
"items": {
"type": "object",
"properties": {
"address": {
"anyOf": [
{
"type": "object",
"properties": {
"city": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"countryOrRegion": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"postalCode": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"state": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"street": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"additionalProperties": false
},
{
"type": "null"
}
]
},
"classes": {
"anyOf": [
{
"type": "array",
"items": {}
},
{
"type": "null"
}
]
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"displayName": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"externalId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"externalPrincipalId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"externalSource": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"externalSourceDetail": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"fax": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"highestGrade": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"lowestGrade": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"phone": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"principalEmail": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"principalName": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"schoolNumber": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"users": {
"anyOf": [
{
"type": "array",
"items": {}
},
{
"type": "null"
}
]
}
},
"additionalProperties": false
}
},
{
"type": "null"
}
]
},
"student": {
"anyOf": [
{
"type": "object",
"properties": {
"birthDate": {
"anyOf": [
{
"anyOf": [
{
"type": "string"
},
{
"type": "number"
}
]
},
{
"type": "null"
}
]
},
"externalId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"gender": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"grade": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"graduationYear": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"studentNumber": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"additionalProperties": false
},
{
"type": "null"
}
]
},
"surname": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"teacher": {
"anyOf": [
{
"type": "object",
"properties": {
"externalId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"teacherNumber": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"additionalProperties": false
},
{
"type": "null"
}
]
},
"userPrincipalName": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"userType": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"additionalProperties": false
}
},
{
"type": "null"
}
]
},
"term": {
"anyOf": [
{
"type": "object",
"properties": {
"displayName": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"endDate": {
"anyOf": [
{
"anyOf": [
{
"type": "string"
},
{
"type": "number"
}
]
},
{
"type": "null"
}
]
},
"externalId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"microsoftTeamsClassroomTerm": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"startDate": {
"anyOf": [
{
"anyOf": [
{
"type": "string"
},
{
"type": "number"
}
]
},
{
"type": "null"
}
]
}
},
"additionalProperties": false
},
{
"type": "null"
}
]
}
},
"additionalProperties": false
},
{
"type": "null"
}
]
},
"notifyOwner": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"onBehalfOfTeacherId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"orgId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"ownerId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"subjects": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
]
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"additionalProperties": false
}
},
"required": [
"input"
],
"additionalProperties": false
},
"page": "/login"
}addSectionCollaboratorsAction
Add collaborators to a section
View tool JSON
{
"name": "addSectionCollaborators",
"kind": "act",
"impl": "imperative",
"description": "Add collaborators to a section",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"properties": {
"input": {
"type": "object",
"properties": {
"emails": {
"type": "array",
"items": {
"type": "string"
}
},
"notifications": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"sectionId": {
"type": "string"
}
},
"required": [
"emails",
"sectionId"
],
"additionalProperties": false
}
},
"required": [
"input"
],
"additionalProperties": false
},
"page": "/login"
}addStudentEnrollmentsAction
Enroll students into a section
View tool JSON
{
"name": "addStudentEnrollments",
"kind": "act",
"impl": "imperative",
"description": "Enroll students into a section",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"properties": {
"joinCode": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"sectionId": {
"type": "string"
},
"userIds": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"sectionId",
"userIds"
],
"additionalProperties": false
},
"page": "/login"
}addUserSensitive Action
Create a new user account. **Identity:** - firstName, lastName: User's name - nickname: Display name (optional) - emails: Array of email addresses (preferred for test users) - username: Username for login (prefer email for test users) - password: Account password **Role & type:** - teacher: Set true for teacher accounts - student: Set true for student accounts - role: Professional role (TEACHER, SCHOOL_ADMINISTRATOR, DISTRICT_ADMINISTRATOR, INSTRUCTIONAL_COACH, etc.) - position: Job title/position **Organization & section:** - addToOrg: Add user to an organization { id, roles, verified } - addToSection: Section/class ID to add student to **Additional:** - identifier: External system ID - demographics: Demographic information object - vertical: User category (use "other" for test users) **Example - Test teacher:** ```json { "input": { "firstName": "Test", "lastName": "Teacher", "emails": [{"address": "[email protected]", "verified": true}], "password": "testpass123", "teacher": true, "vertical": "other" } } ``` **Example - Student in a class:** ```json { "input": { "firstName": "Test", "lastName": "Student", "emails": [{"address": "[email protected]"}], "password": "testpass123", "student": true, "addToSection": "sectionId123" } } ```
View tool JSON
{
"name": "addUser",
"kind": "transact",
"impl": "imperative",
"description": "Create a new user account.\n\n**Identity:**\n- firstName, lastName: User's name\n- nickname: Display name (optional)\n- emails: Array of email addresses (preferred for test users)\n- username: Username for login (prefer email for test users)\n- password: Account password\n\n**Role & type:**\n- teacher: Set true for teacher accounts\n- student: Set true for student accounts\n- role: Professional role (TEACHER, SCHOOL_ADMINISTRATOR, DISTRICT_ADMINISTRATOR, INSTRUCTIONAL_COACH, etc.)\n- position: Job title/position\n\n**Organization & section:**\n- addToOrg: Add user to an organization { id, roles, verified }\n- addToSection: Section/class ID to add student to\n\n**Additional:**\n- identifier: External system ID\n- demographics: Demographic information object\n- vertical: User category (use \"other\" for test users)\n\n**Example - Test teacher:**\n```json\n{\n \"input\": {\n \"firstName\": \"Test\",\n \"lastName\": \"Teacher\",\n \"emails\": [{\"address\": \"[email protected]\", \"verified\": true}],\n \"password\": \"testpass123\",\n \"teacher\": true,\n \"vertical\": \"other\"\n }\n}\n```\n\n**Example - Student in a class:**\n```json\n{\n \"input\": {\n \"firstName\": \"Test\",\n \"lastName\": \"Student\",\n \"emails\": [{\"address\": \"[email protected]\"}],\n \"password\": \"testpass123\",\n \"student\": true,\n \"addToSection\": \"sectionId123\"\n }\n}\n```",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"properties": {
"input": {
"type": "object",
"properties": {
"addBadge": {
"anyOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string",
"enum": [
"aiGenerated",
"aiHintsGenerated",
"aiQuestionsGenerated",
"completedKeyMilestoneChecklist",
"formativeCertifiedEducator",
"formativeChampion",
"formativeFanatic",
"formativesAssigned",
"formativesShared",
"foundations101Admin",
"foundations101Teachers",
"newselaArticle",
"questionOfTheDay",
"responseFeedbackGiven",
"responsesReceived",
"showYourKnowledge",
"standardsTagged"
]
},
"toast": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
}
},
"required": [
"id"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"addToOrg": {
"anyOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"roles": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
]
},
"verified": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
}
},
"required": [
"id"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"addToSection": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"animationPreferences": {
"anyOf": [
{
"type": "object",
"properties": {
"lunaHolidayCostumeDisabled": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
}
},
"additionalProperties": false
},
{
"type": "null"
}
]
},
"brand": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"cleverCreds": {
"anyOf": [
{
"type": "object",
"properties": {
"accessToken": {
"type": "string"
}
},
"required": [
"accessToken"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"commandCenterRole": {
"anyOf": [
{
"type": "string",
"enum": [
"business",
"csm",
"csmRestricted",
"design",
"dev",
"implementation",
"itemBankManager",
"product",
"qa",
"sales",
"support"
]
},
{
"type": "null"
}
]
},
"defaultAccommodations": {
"anyOf": [
{
"type": "object",
"properties": {
"answerChoiceReduction": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"colorContrast": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"masking": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"textToSpeech": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"timeLimitExtension": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"translatorLanguage": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"additionalProperties": false
},
{
"type": "null"
}
]
},
"defaultAssignOptions": {
"anyOf": [
{
"type": "object",
"properties": {
"accentsKeyboard": {
"anyOf": [
{
"type": "string",
"enum": [
"french",
"german",
"italian",
"mandarin",
"spanish"
]
},
{
"type": "null"
}
]
},
"afterSubmission": {
"type": "string"
},
"calculator": {
"anyOf": [
{
"type": "string",
"enum": [
"basic",
"graphing",
"scientific"
]
},
{
"type": "null"
}
]
},
"editAfterSubmit": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"publishToGoogleClassroom": {
"type": "boolean"
},
"randomizeQuestions": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"returnAnswers": {
"type": "string"
},
"returnScores": {
"type": "string"
},
"scheduled": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"singleQuestionView": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"studentNotes": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"submissionLimit": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
}
},
"required": [
"afterSubmission",
"publishToGoogleClassroom",
"returnAnswers",
"returnScores"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"defaultGradingMethod": {
"anyOf": [
{
"type": "string",
"enum": [
"progress",
"total"
]
},
{
"type": "null"
}
]
},
"defaultPointValue": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"demographics": {
"anyOf": [
{
"type": "object",
"properties": {
"americanIndianOrAlaskaNative": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"asian": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"birthDate": {
"anyOf": [
{
"anyOf": [
{
"type": "string"
},
{
"type": "number"
}
]
},
{
"type": "null"
}
]
},
"blackOrAfricanAmerican": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"cityOfBirth": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"countryOfBirthCode": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"demographicRaceTwoOrMoreRaces": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"ed": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"hispanicOrLatinoEthnicity": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"lep": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"nativeHawaiianOrOtherPacificIslander": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"publicSchoolResidenceStatus": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"sex": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"sped": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"stateOfBirthAbbreviation": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"status": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"white": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
}
},
"additionalProperties": false
},
{
"type": "null"
}
]
},
"editorPreferences": {
"anyOf": [
{
"type": "object",
"properties": {
"mathKeyboard": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
}
},
"additionalProperties": false
},
{
"type": "null"
}
]
},
"emails": {
"anyOf": [
{
"type": "array",
"items": {
"type": "object",
"properties": {
"address": {
"type": "string"
},
"verified": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
}
},
"required": [
"address"
],
"additionalProperties": false
}
},
{
"type": "null"
}
]
},
"featureWhitelist": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
]
},
"firstName": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"geoIpData": {
"anyOf": [
{
"type": "object",
"properties": {
"city": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"country": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"region": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"sig": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"additionalProperties": false
},
{
"type": "null"
}
]
},
"googleCreds": {
"anyOf": [
{
"type": "object",
"properties": {
"accessToken": {
"type": "string"
},
"clientId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"hostedDomain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"idToken": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"scope": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"accessToken",
"scope"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"grades": {
"anyOf": [
{
"type": "array",
"items": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
}
},
{
"type": "null"
}
]
},
"guest": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"homePage": {
"anyOf": [
{
"type": "object",
"properties": {
"shelves": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string",
"enum": [
"classes",
"quickLinks",
"recentFormatives"
]
}
},
{
"type": "null"
}
]
}
},
"additionalProperties": false
},
{
"type": "null"
}
]
},
"identifier": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"lastName": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"lastSecurityReviewAt": {
"anyOf": [
{
"anyOf": [
{
"type": "string"
},
{
"type": "number"
}
]
},
{
"type": "null"
}
]
},
"lastSeen": {
"anyOf": [
{
"anyOf": [
{
"type": "string"
},
{
"type": "number"
}
]
},
{
"type": "null"
}
]
},
"mergeRequest": {
"anyOf": [
{
"type": "object",
"properties": {
"comment": {
"type": "string"
},
"sourceUserId": {
"type": "string"
}
},
"required": [
"comment",
"sourceUserId"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"microsoftCreds": {
"anyOf": [
{
"type": "object",
"properties": {
"accessToken": {
"type": "string"
},
"idToken": {
"type": "string"
}
},
"required": [
"accessToken",
"idToken"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"newselaOAuthCreds": {
"anyOf": [
{
"type": "object",
"properties": {
"accessToken": {
"type": "string"
}
},
"required": [
"accessToken"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"nickname": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"notificationPreferences": {
"anyOf": [
{
"type": "object",
"properties": {
"coTeacherAddedToClass": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"editedAfterGraded": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"ltiGradePassbackFailed": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"reminderEmails": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"studentLateSubmissionOnly": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"studentSubmission": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"usedHint": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
}
},
"additionalProperties": false
},
{
"type": "null"
}
]
},
"partner": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"partnerSetAt": {
"anyOf": [
{
"anyOf": [
{
"type": "string"
},
{
"type": "number"
}
]
},
{
"type": "null"
}
]
},
"password": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"passwordChangeToken": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"passwordSalt": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"passwordVerifier": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"pendingMilestones": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
]
},
"pilot": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"pilotSetAt": {
"anyOf": [
{
"anyOf": [
{
"type": "string"
},
{
"type": "number"
}
]
},
{
"type": "null"
}
]
},
"position": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"preferredLanguage": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"premium": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"premiumSetAt": {
"anyOf": [
{
"anyOf": [
{
"type": "string"
},
{
"type": "number"
}
]
},
{
"type": "null"
}
]
},
"privacyPolicyAcceptDate": {
"anyOf": [
{
"anyOf": [
{
"type": "string"
},
{
"type": "number"
}
]
},
{
"type": "null"
}
]
},
"quotas": {
"anyOf": [
{
"type": "object",
"properties": {
"aiImageGeneration": {
"anyOf": [
{
"type": "object",
"properties": {
"month": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"remaining": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"used": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"year": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
}
},
"required": [
"month",
"used",
"year"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"aiInputTokens": {
"anyOf": [
{
"type": "object",
"properties": {
"month": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"remaining": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"used": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"year": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
}
},
"required": [
"month",
"used",
"year"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"aiOutputTokens": {
"anyOf": [
{
"type": "object",
"properties": {
"month": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"remaining": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"used": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"year": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
}
},
"required": [
"month",
"used",
"year"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"resultsExports": {
"anyOf": [
{
"type": "object",
"properties": {
"month": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"remaining": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"used": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"year": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
}
},
"required": [
"month",
"used",
"year"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"uploads": {
"anyOf": [
{
"type": "object",
"properties": {
"month": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"remaining": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"used": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"year": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
}
},
"required": [
"month",
"used",
"year"
],
"additionalProperties": false
},
{
"type": "null"
}
]
}
},
"additionalProperties": false
},
{
"type": "null"
}
]
},
"referralId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"removeBadge": {
"anyOf": [
{
"type": "string",
"enum": [
"aiGenerated",
"aiHintsGenerated",
"aiQuestionsGenerated",
"completedKeyMilestoneChecklist",
"formativeCertifiedEducator",
"formativeChampion",
"formativeFanatic",
"formativesAssigned",
"formativesShared",
"foundations101Admin",
"foundations101Teachers",
"newselaArticle",
"questionOfTheDay",
"responseFeedbackGiven",
"responsesReceived",
"showYourKnowledge",
"standardsTagged"
]
},
{
"type": "null"
}
]
},
"removeFromOrg": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"removeFromSection": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"role": {
"anyOf": [
{
"type": "string",
"enum": [
"DISTRICT_ADMINISTRATOR",
"INSTRUCTIONAL_COACH",
"LIBRARY_OR_MEDIA_SPECIALIST",
"OTHER",
"PARENT_TUTOR_OR_CAREGIVER",
"SCHOOL_ADMINISTRATOR",
"TEACHER",
"TECHNOLOGY_ADMINISTRATOR",
"admin",
"reviewer",
"writer"
]
},
{
"type": "null"
}
]
},
"scoreThresholds": {
"anyOf": [
{
"type": "array",
"items": {
"type": "object",
"properties": {
"category": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"color": {
"type": "string"
},
"score": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
}
},
"required": [
"color",
"score"
],
"additionalProperties": false
}
},
{
"type": "null"
}
]
},
"sectionInviteCode": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"sectionJoinCode": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"services": {
"anyOf": [
{
"type": "object",
"properties": {
"clever": {
"anyOf": [
{
"type": "object",
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"additionalProperties": false
},
{
"type": "null"
}
]
},
"google": {
"anyOf": [
{
"type": "object",
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"additionalProperties": false
},
{
"type": "null"
}
]
},
"lti": {
"anyOf": [
{
"type": "object",
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"additionalProperties": false
},
{
"type": "null"
}
]
},
"microsoft": {
"anyOf": [
{
"type": "object",
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"additionalProperties": false
},
{
"type": "null"
}
]
},
"newsela": {
"anyOf": [
{
"type": "object",
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"additionalProperties": false
},
{
"type": "null"
}
]
},
"oneRoster": {
"anyOf": [
{
"type": "object",
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"additionalProperties": false
},
{
"type": "null"
}
]
},
"password": {
"anyOf": [
{
"type": "object",
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"additionalProperties": false
},
{
"type": "null"
}
]
}
},
"additionalProperties": false
},
{
"type": "null"
}
]
},
"signUpTrackingParams": {
"anyOf": [
{
"type": "object",
"properties": {
"clickid": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"utm_campaign": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"utm_campaign_1": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"utm_campaign_2": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"utm_campaign_3": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"utm_campaign_4": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"utm_campaign_5": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"utm_content": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"utm_content_1": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"utm_content_2": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"utm_content_3": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"utm_content_4": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"utm_content_5": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"utm_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"utm_id_1": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"utm_id_2": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"utm_id_3": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"utm_id_4": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"utm_id_5": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"utm_medium": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"utm_medium_1": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"utm_medium_2": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"utm_medium_3": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"utm_medium_4": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"utm_medium_5": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"utm_source": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"utm_source_1": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"utm_source_2": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"utm_source_3": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"utm_source_4": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"utm_source_5": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"utm_term": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"utm_term_1": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"utm_term_2": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"utm_term_3": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"utm_term_4": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"utm_term_5": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"additionalProperties": false
},
{
"type": "null"
}
]
},
"startTrial": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"student": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"subjects": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
]
},
"tagSets": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
]
},
"teacher": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"tempUpgrade": {
"anyOf": [
{
"type": "object",
"properties": {
"endDate": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
}
]
},
"reason": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"startDate": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
}
]
}
},
"required": [
"endDate",
"startDate"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"tutorials": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
]
},
"updateOrg": {
"anyOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"roles": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
]
},
"verified": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
}
},
"required": [
"id"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"username": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"vertical": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"wondeCreds": {
"anyOf": [
{
"type": "object",
"properties": {
"accessToken": {
"type": "string"
}
},
"required": [
"accessToken"
],
"additionalProperties": false
},
{
"type": "null"
}
]
}
},
"additionalProperties": false
}
},
"required": [
"input"
],
"additionalProperties": false
},
"page": "/login"
}addUserNoteAction
Add an admin note to a user account. The note will be attributed to the authenticated user.
View tool JSON
{
"name": "addUserNote",
"kind": "act",
"impl": "imperative",
"description": "Add an admin note to a user account. The note will be attributed to the authenticated user.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"properties": {
"input": {
"type": "object",
"properties": {
"note": {
"type": "string"
},
"userId": {
"type": "string"
}
},
"required": [
"note",
"userId"
],
"additionalProperties": false
}
},
"required": [
"input"
],
"additionalProperties": false
},
"page": "/login"
}aiConfigurationsAnswer
Fetch AI configurations filtered by grade, subject, and org
View tool JSON
{
"name": "aiConfigurations",
"kind": "answer",
"impl": "imperative",
"description": "Fetch AI configurations filtered by grade, subject, and org",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"properties": {
"grades": {
"anyOf": [
{
"type": "array",
"items": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
}
},
{
"type": "null"
}
]
},
"orgIds": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
]
},
"public": {
"type": "boolean"
},
"subjects": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
]
}
},
"required": [
"public"
],
"additionalProperties": false
},
"page": "/login"
}aiThreadsAnswer
List AI threads with associated messages and configuration
View tool JSON
{
"name": "aiThreads",
"kind": "answer",
"impl": "imperative",
"description": "List AI threads with associated messages and configuration",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"properties": {
"input": {
"anyOf": [
{
"type": "object",
"properties": {
"formativeIds": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
]
},
"userIds": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
]
}
},
"additionalProperties": false
},
{
"type": "null"
}
]
}
},
"additionalProperties": false
},
"page": "/login"
}answersAnswer
Fetch answers with filters across assignments, sections, or students. Supports cursor-based pagination: use `first` to set page size (default 20, max 100) and `after` with the `endCursor` from a previous response to fetch the next page. The response includes `totalCount` and `pageInfo.endCursor`.
View tool JSON
{
"name": "answers",
"kind": "answer",
"impl": "imperative",
"description": "Fetch answers with filters across assignments, sections, or students.\n\nSupports cursor-based pagination: use `first` to set page size (default 20, max 100) and `after` with the `endCursor` from a previous response to fetch the next page. The response includes `totalCount` and `pageInfo.endCursor`.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"properties": {
"after": {
"anyOf": [
{},
{
"type": "null"
}
]
},
"assignmentId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"assignments": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
]
},
"first": {
"default": 20,
"type": "integer",
"minimum": 1,
"maximum": 100
},
"formativeId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"formativeItemId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"formativeItems": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
]
},
"formatives": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
]
},
"latestSubmissionOnly": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"orderBy": {
"anyOf": [
{
"type": "array",
"items": {
"type": "object",
"properties": {
"direction": {
"type": "string",
"enum": [
"ASC",
"DESC"
]
},
"field": {
"type": "string",
"enum": [
"CREATED"
]
}
},
"required": [
"direction",
"field"
],
"additionalProperties": false
}
},
{
"type": "null"
}
]
},
"sectionId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"sections": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
]
},
"studentId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"students": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
]
},
"submissionId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"first"
],
"additionalProperties": false
},
"page": "/login"
}archiveStudentEnrollmentsAction
Archive student enrollments from a section
View tool JSON
{
"name": "archiveStudentEnrollments",
"kind": "act",
"impl": "imperative",
"description": "Archive student enrollments from a section",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"properties": {
"sectionId": {
"type": "string"
},
"userIds": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"sectionId",
"userIds"
],
"additionalProperties": false
},
"page": "/login"
}assignPracticeSetAction
Assign a practice set to a section
View tool JSON
{
"name": "assignPracticeSet",
"kind": "act",
"impl": "imperative",
"description": "Assign a practice set to a section",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"properties": {
"practiceSetId": {
"type": "string"
},
"sectionId": {
"type": "string"
}
},
"required": [
"practiceSetId",
"sectionId"
],
"additionalProperties": false
},
"page": "/login"
}createDemoSandboxAction
Create a complete demo environment with pre-populated data. This is the fastest way to set up a testing environment with: - Organizations (schools/districts) - Teachers and students with login credentials - Classes/sections with enrolled students - Formatives with various question types - Assignments linking formatives to classes - Sample student submissions and answers Use this when you need a realistic test environment quickly. All created users have the password "password". Returns a list of teachers with their org roles so you can immediately start using them for further testing.
View tool JSON
{
"name": "createDemoSandbox",
"kind": "act",
"impl": "imperative",
"description": "Create a complete demo environment with pre-populated data.\n\nThis is the fastest way to set up a testing environment with:\n- Organizations (schools/districts)\n- Teachers and students with login credentials\n- Classes/sections with enrolled students\n- Formatives with various question types\n- Assignments linking formatives to classes\n- Sample student submissions and answers\n\nUse this when you need a realistic test environment quickly. All created users\nhave the password \"password\".\n\nReturns a list of teachers with their org roles so you can immediately start\nusing them for further testing.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"properties": {
"name": {
"type": "string"
}
},
"required": [
"name"
],
"additionalProperties": false
},
"page": "/login"
}createOneRosterSftpAccountSensitive Action
Create SFTP account credentials for OneRoster uploads
View tool JSON
{
"name": "createOneRosterSftpAccount",
"kind": "transact",
"impl": "imperative",
"description": "Create SFTP account credentials for OneRoster uploads",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"properties": {
"rosterId": {
"type": "string"
}
},
"required": [
"rosterId"
],
"additionalProperties": false
},
"page": "/login"
}deleteQuickLinkSensitive Action
Delete a quick link
View tool JSON
{
"name": "deleteQuickLink",
"kind": "transact",
"impl": "imperative",
"description": "Delete a quick link",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"properties": {
"id": {
"type": "string"
}
},
"required": [
"id"
],
"additionalProperties": false
},
"page": "/login"
}editQuickLinkAction
Edit a quick link
View tool JSON
{
"name": "editQuickLink",
"kind": "act",
"impl": "imperative",
"description": "Edit a quick link",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"properties": {
"id": {
"type": "string"
},
"input": {
"type": "object",
"properties": {
"customLink": {
"anyOf": [
{
"type": "object",
"properties": {
"title": {
"type": "string"
},
"url": {
"type": "string"
}
},
"required": [
"title",
"url"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"folderId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"formativeId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"parentFolderId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"additionalProperties": false
}
},
"required": [
"id",
"input"
],
"additionalProperties": false
},
"page": "/login"
}enrollmentsAnswer
List enrollments for sections with user details. Supports cursor-based pagination: use `first` to set page size (default 20, max 100) and `after` with the `endCursor` from a previous response to fetch the next page. The response includes `totalCount` and `pageInfo.endCursor`.
View tool JSON
{
"name": "enrollments",
"kind": "answer",
"impl": "imperative",
"description": "List enrollments for sections with user details.\n\nSupports cursor-based pagination: use `first` to set page size (default 20, max 100) and `after` with the `endCursor` from a previous response to fetch the next page. The response includes `totalCount` and `pageInfo.endCursor`.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"properties": {
"after": {
"anyOf": [
{},
{
"type": "null"
}
]
},
"archived": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"first": {
"default": 20,
"type": "integer",
"minimum": 1,
"maximum": 100
},
"orderBy": {
"anyOf": [
{
"type": "array",
"items": {
"type": "object",
"properties": {
"direction": {
"type": "string",
"enum": [
"ASC",
"DESC"
]
},
"field": {
"type": "string",
"enum": [
"CREATED_AT",
"FIRST_NAME",
"LAST_LOGIN",
"LAST_NAME",
"LAST_SEEN",
"UPDATED_AT"
]
}
},
"required": [
"direction",
"field"
],
"additionalProperties": false
}
},
{
"type": "null"
}
]
},
"searchText": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"sectionIds": {
"type": "array",
"items": {
"type": "string"
}
},
"userIds": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
]
}
},
"required": [
"first",
"sectionIds"
],
"additionalProperties": false
},
"page": "/login"
}experimentsAnswer
Retrieve experiments with metadata and author info
View tool JSON
{
"name": "experiments",
"kind": "answer",
"impl": "imperative",
"description": "Retrieve experiments with metadata and author info",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"properties": {},
"additionalProperties": false
},
"page": "/login"
}foldersAnswer
Browse folders with pagination and ownership filters. Supports cursor-based pagination: use `first` to set page size (default 20, max 100) and `after` with the `endCursor` from a previous response to fetch the next page. The response includes `totalCount` and `pageInfo.endCursor`.
View tool JSON
{
"name": "folders",
"kind": "answer",
"impl": "imperative",
"description": "Browse folders with pagination and ownership filters.\n\nSupports cursor-based pagination: use `first` to set page size (default 20, max 100) and `after` with the `endCursor` from a previous response to fetch the next page. The response includes `totalCount` and `pageInfo.endCursor`.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"properties": {
"after": {
"anyOf": [
{},
{
"type": "null"
}
]
},
"deleted": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"first": {
"default": 20,
"type": "integer",
"minimum": 1,
"maximum": 100
},
"ids": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
]
},
"orderBy": {
"anyOf": [
{
"type": "array",
"items": {
"type": "object",
"properties": {
"direction": {
"type": "string",
"enum": [
"ASC",
"DESC"
]
},
"field": {
"type": "string",
"enum": [
"CREATED_AT",
"NAME"
]
}
},
"required": [
"direction",
"field"
],
"additionalProperties": false
}
},
{
"type": "null"
}
]
},
"ownerId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"parentId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"searchText": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"userId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"first"
],
"additionalProperties": false
},
"page": "/login"
}formativeLibraryListingsAnswer
Search formative library listings with filters. Supports cursor-based pagination: use `first` to set page size (default 20, max 100) and `after` with the `endCursor` from a previous response to fetch the next page. The response includes `totalCount` and `pageInfo.endCursor`.
View tool JSON
{
"name": "formativeLibraryListings",
"kind": "answer",
"impl": "imperative",
"description": "Search formative library listings with filters.\n\nSupports cursor-based pagination: use `first` to set page size (default 20, max 100) and `after` with the `endCursor` from a previous response to fetch the next page. The response includes `totalCount` and `pageInfo.endCursor`.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"properties": {
"after": {
"anyOf": [
{},
{
"type": "null"
}
]
},
"first": {
"default": 20,
"type": "integer",
"minimum": 1,
"maximum": 100
},
"grades": {
"anyOf": [
{
"type": "array",
"items": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
}
},
{
"type": "null"
}
]
},
"orderBy": {
"anyOf": [
{
"type": "array",
"items": {
"type": "object",
"properties": {
"direction": {
"type": "string",
"enum": [
"ASC",
"DESC"
]
},
"field": {
"type": "string",
"enum": [
"CLONE_COUNT",
"EDITOR_PICK",
"PUBLISHED_AT",
"RATING",
"TITLE"
]
}
},
"required": [
"direction",
"field"
],
"additionalProperties": false
}
},
{
"type": "null"
}
]
},
"orgs": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
]
},
"public": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"published": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"searchText": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"subjects": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
]
}
},
"required": [
"first"
],
"additionalProperties": false
},
"page": "/login"
}getCurrentPageContextAnswer
Get the current Formative page route, focused element, and normalized entity IDs.
View tool JSON
{
"name": "getCurrentPageContext",
"kind": "answer",
"impl": "imperative",
"description": "Get the current Formative page route, focused element, and normalized entity IDs.",
"inputSchema": {
"type": "object",
"properties": {},
"additionalProperties": false
},
"page": "/login"
}getFormativesAnswer
Query formatives (assessments/lessons) with filters and pagination. Results are filtered based on the authenticated user's permissions. Supports cursor-based pagination: use `first` to set page size (default 20, max 100) and `after` with the `endCursor` from a previous response to fetch the next page. The response includes `totalCount` and `pageInfo.endCursor`.
View tool JSON
{
"name": "getFormatives",
"kind": "answer",
"impl": "imperative",
"description": "Query formatives (assessments/lessons) with filters and pagination. Results are filtered based on the authenticated user's permissions.\n\nSupports cursor-based pagination: use `first` to set page size (default 20, max 100) and `after` with the `endCursor` from a previous response to fetch the next page. The response includes `totalCount` and `pageInfo.endCursor`.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"properties": {
"first": {
"default": 20,
"type": "integer",
"minimum": 1,
"maximum": 100
},
"after": {
"anyOf": [
{},
{
"type": "null"
}
]
},
"ids": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
]
},
"userId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"folderId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"assigned": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"searchText": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"deleted": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
}
},
"required": [
"first"
],
"additionalProperties": false
},
"page": "/login"
}getOrgsAnswer
Query organizations with filters and pagination. Results are filtered based on the authenticated user's permissions. Supports cursor-based pagination: use `first` to set page size (default 50, max 500) and `after` with the `endCursor` from a previous response to fetch the next page. The response includes `totalCount` and `pageInfo.endCursor`.
View tool JSON
{
"name": "getOrgs",
"kind": "answer",
"impl": "imperative",
"description": "Query organizations with filters and pagination. Results are filtered based on the authenticated user's permissions.\n\nSupports cursor-based pagination: use `first` to set page size (default 50, max 500) and `after` with the `endCursor` from a previous response to fetch the next page. The response includes `totalCount` and `pageInfo.endCursor`.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"properties": {
"first": {
"default": 50,
"type": "integer",
"minimum": 1,
"maximum": 500
},
"after": {
"anyOf": [
{},
{
"type": "null"
}
]
},
"ids": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
]
},
"searchTerm": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"type": {
"anyOf": [
{
"type": "string",
"enum": [
"DEPARTMENT",
"DISTRICT",
"LOCAL",
"NATIONAL",
"OTHER",
"SCHOOL",
"STATE"
]
},
{
"type": "null"
}
]
},
"verified": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"includeDescendants": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
}
},
"required": [
"first"
],
"additionalProperties": false
},
"page": "/login"
}getSectionsAnswer
Query sections (classes) with filters and pagination. Note: In Formative, "section" and "class" are interchangeable terms. Results are filtered based on the authenticated user's permissions. Supports cursor-based pagination: use `first` to set page size (default 20, max 100) and `after` with the `endCursor` from a previous response to fetch the next page. The response includes `totalCount` and `pageInfo.endCursor`.
View tool JSON
{
"name": "getSections",
"kind": "answer",
"impl": "imperative",
"description": "Query sections (classes) with filters and pagination. Note: In Formative, \"section\" and \"class\" are interchangeable terms. Results are filtered based on the authenticated user's permissions.\n\nSupports cursor-based pagination: use `first` to set page size (default 20, max 100) and `after` with the `endCursor` from a previous response to fetch the next page. The response includes `totalCount` and `pageInfo.endCursor`.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"properties": {
"first": {
"default": 20,
"type": "integer",
"minimum": 1,
"maximum": 100
},
"after": {
"anyOf": [
{},
{
"type": "null"
}
]
},
"ids": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
]
},
"userId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"orgId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"orgs": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
]
},
"archived": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
}
},
"required": [
"first"
],
"additionalProperties": false
},
"page": "/login"
}getStudentAssignmentsAnswer
Get student assignments for a formative. Returns assignments that are either public (guest) or assigned to a class that the specified user is in. No filtering is done with respect to whether the assignment is currently open or closed, or has settings that could restrict the student from answering or viewing the assignment. Requires permission to view the student's data. Requires permission to view the student's data.
View tool JSON
{
"name": "getStudentAssignments",
"kind": "answer",
"impl": "imperative",
"description": "Get student assignments for a formative.\n\nReturns assignments that are either public (guest) or assigned to a class\nthat the specified user is in.\n\nNo filtering is done with respect to whether the assignment is currently\nopen or closed, or has settings that could restrict the student from\nanswering or viewing the assignment.\n\nRequires permission to view the student's data.\nRequires permission to view the student's data.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"properties": {
"formativeId": {
"type": "string"
},
"userId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"formativeId"
],
"additionalProperties": false
},
"page": "/login"
}getTeacherAssignmentsAnswer
Get teacher assignments for a formative. Returns assignments that the authenticated user can see based on their permissions: - Teachers see assignments for their own sections - Org admins see assignments for sections in their org - Users with data sharing access see all assignments for shared formatives Use filters to narrow down results by section, org, teacher, or assignment type. Use filters to narrow down results by section, org, teacher, or assignment type.
View tool JSON
{
"name": "getTeacherAssignments",
"kind": "answer",
"impl": "imperative",
"description": "Get teacher assignments for a formative.\n\nReturns assignments that the authenticated user can see based on their permissions:\n- Teachers see assignments for their own sections\n- Org admins see assignments for sections in their org\n- Users with data sharing access see all assignments for shared formatives\n\nUse filters to narrow down results by section, org, teacher, or assignment type.\nUse filters to narrow down results by section, org, teacher, or assignment type.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"properties": {
"formativeId": {
"type": "string"
},
"sections": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
]
},
"orgs": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
]
},
"teachers": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
]
},
"archived": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"guest": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"preview": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"createdBefore": {
"anyOf": [
{
"anyOf": [
{
"type": "string"
},
{
"type": "number"
}
]
},
{
"type": "null"
}
]
}
},
"required": [
"formativeId"
],
"additionalProperties": false
},
"page": "/login"
}getUsersAnswer
Query users with filters and pagination. Results are filtered based on the authenticated user's permissions. Supports cursor-based pagination: use `first` to set page size (default 20, max 100) and `after` with the `endCursor` from a previous response to fetch the next page. The response includes `totalCount` and `pageInfo.endCursor`.
View tool JSON
{
"name": "getUsers",
"kind": "answer",
"impl": "imperative",
"description": "Query users with filters and pagination. Results are filtered based on the authenticated user's permissions.\n\nSupports cursor-based pagination: use `first` to set page size (default 20, max 100) and `after` with the `endCursor` from a previous response to fetch the next page. The response includes `totalCount` and `pageInfo.endCursor`.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"properties": {
"first": {
"default": 20,
"type": "integer",
"minimum": 1,
"maximum": 100
},
"after": {
"anyOf": [
{},
{
"type": "null"
}
]
},
"ids": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
]
},
"orgs": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
]
},
"sections": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
]
},
"searchText": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"teacher": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"student": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
}
},
"required": [
"first"
],
"additionalProperties": false
},
"page": "/login"
}itemBankItemsAnswer
Query item bank items with filters by bank, grade, and subject. Supports cursor-based pagination: use `first` to set page size (default 20, max 100) and `after` with the `endCursor` from a previous response to fetch the next page. The response includes `totalCount` and `pageInfo.endCursor`.
View tool JSON
{
"name": "itemBankItems",
"kind": "answer",
"impl": "imperative",
"description": "Query item bank items with filters by bank, grade, and subject.\n\nSupports cursor-based pagination: use `first` to set page size (default 20, max 100) and `after` with the `endCursor` from a previous response to fetch the next page. The response includes `totalCount` and `pageInfo.endCursor`.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"properties": {
"after": {
"anyOf": [
{},
{
"type": "null"
}
]
},
"first": {
"default": 20,
"type": "integer",
"minimum": 1,
"maximum": 100
},
"grades": {
"anyOf": [
{
"type": "array",
"items": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
}
},
{
"type": "null"
}
]
},
"itemBankIds": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string",
"enum": [
"INSTRUCTURE_1",
"newMeridian",
"newsela",
"vaSCL"
]
}
},
{
"type": "null"
}
]
},
"subjects": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
]
},
"subtypes": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string",
"enum": [
"audio",
"audioContent",
"bubbleSheet",
"categorize",
"dragAndDrop",
"embed",
"file",
"fillInTheBlank",
"functionalizedAudio",
"functionalizedBubbleSheet",
"functionalizedEmbed",
"functionalizedImage",
"functionalizedMultiPart",
"functionalizedNewselaArticle",
"functionalizedPairedPassages",
"functionalizedSlides",
"functionalizedText",
"functionalizedVideo",
"functionalizedWhiteBoard",
"graph",
"graphing",
"hotSpot",
"hotText",
"image",
"inlineChoice",
"longAnswer",
"matchTableGrid",
"matching",
"multipleChoice",
"multipleSelection",
"newselaArticle",
"numberLine",
"numeric",
"pairedPassages",
"resequence",
"shortAnswer",
"showYourWork",
"slides",
"text",
"trueOrFalse",
"video",
"videoAnswer",
"whiteBoard"
]
}
},
{
"type": "null"
}
]
}
},
"required": [
"first"
],
"additionalProperties": false
},
"page": "/login"
}itemBankQuestionsCountAnswer
Return aggregate count of item bank questions
View tool JSON
{
"name": "itemBankQuestionsCount",
"kind": "answer",
"impl": "imperative",
"description": "Return aggregate count of item bank questions",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"properties": {
"grades": {
"anyOf": [
{
"type": "array",
"items": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
}
},
{
"type": "null"
}
]
},
"itemBankIds": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string",
"enum": [
"INSTRUCTURE_1",
"newMeridian",
"newsela",
"vaSCL"
]
}
},
{
"type": "null"
}
]
},
"subjects": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
]
},
"subtypes": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string",
"enum": [
"audio",
"audioContent",
"bubbleSheet",
"categorize",
"dragAndDrop",
"embed",
"file",
"fillInTheBlank",
"functionalizedAudio",
"functionalizedBubbleSheet",
"functionalizedEmbed",
"functionalizedImage",
"functionalizedMultiPart",
"functionalizedNewselaArticle",
"functionalizedPairedPassages",
"functionalizedSlides",
"functionalizedText",
"functionalizedVideo",
"functionalizedWhiteBoard",
"graph",
"graphing",
"hotSpot",
"hotText",
"image",
"inlineChoice",
"longAnswer",
"matchTableGrid",
"matching",
"multipleChoice",
"multipleSelection",
"newselaArticle",
"numberLine",
"numeric",
"pairedPassages",
"resequence",
"shortAnswer",
"showYourWork",
"slides",
"text",
"trueOrFalse",
"video",
"videoAnswer",
"whiteBoard"
]
}
},
{
"type": "null"
}
]
}
},
"additionalProperties": false
},
"page": "/login"
}oneRosterAnswer
Fetch a OneRoster import with configuration and org details
View tool JSON
{
"name": "oneRoster",
"kind": "answer",
"impl": "imperative",
"description": "Fetch a OneRoster import with configuration and org details",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"properties": {
"rosterId": {
"type": "string"
},
"withFiles": {
"default": true,
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
}
},
"required": [
"rosterId",
"withFiles"
],
"additionalProperties": false
},
"page": "/login"
}oneRosterAcademicSessionsAnswer
List OneRoster academic sessions with parent relationships. Supports cursor-based pagination: use `first` to set page size (default 20, max 100) and `after` with the `endCursor` from a previous response to fetch the next page. The response includes `totalCount` and `pageInfo.endCursor`.
View tool JSON
{
"name": "oneRosterAcademicSessions",
"kind": "answer",
"impl": "imperative",
"description": "List OneRoster academic sessions with parent relationships.\n\nSupports cursor-based pagination: use `first` to set page size (default 20, max 100) and `after` with the `endCursor` from a previous response to fetch the next page. The response includes `totalCount` and `pageInfo.endCursor`.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"properties": {
"rosterId": {
"type": "string"
},
"after": {
"anyOf": [
{},
{
"type": "null"
}
]
},
"first": {
"default": 20,
"type": "integer",
"minimum": 1,
"maximum": 100
},
"orderBy": {
"anyOf": [
{
"type": "array",
"items": {
"type": "object",
"properties": {
"direction": {
"type": "string",
"enum": [
"ASC",
"DESC"
]
},
"field": {
"type": "string",
"enum": [
"CREATED_AT",
"END_DATE",
"SCHOOL_YEAR",
"SOURCED_ID",
"START_DATE",
"STATUS",
"TITLE",
"TYPE",
"UPDATED_AT"
]
}
},
"required": [
"direction",
"field"
],
"additionalProperties": false
}
},
{
"type": "null"
}
]
},
"parentSourcedId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"sourcedIds": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
]
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"type": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"rosterId",
"first"
],
"additionalProperties": false
},
"page": "/login"
}oneRosterAnalysisAnswer
View OneRoster sync analysis and stats
View tool JSON
{
"name": "oneRosterAnalysis",
"kind": "answer",
"impl": "imperative",
"description": "View OneRoster sync analysis and stats",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"properties": {
"rosterId": {
"type": "string"
}
},
"required": [
"rosterId"
],
"additionalProperties": false
},
"page": "/login"
}oneRosterClassesAnswer
Browse OneRoster classes with related course and school info. Supports cursor-based pagination: use `first` to set page size (default 20, max 100) and `after` with the `endCursor` from a previous response to fetch the next page. The response includes `totalCount` and `pageInfo.endCursor`.
View tool JSON
{
"name": "oneRosterClasses",
"kind": "answer",
"impl": "imperative",
"description": "Browse OneRoster classes with related course and school info.\n\nSupports cursor-based pagination: use `first` to set page size (default 20, max 100) and `after` with the `endCursor` from a previous response to fetch the next page. The response includes `totalCount` and `pageInfo.endCursor`.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"properties": {
"rosterId": {
"type": "string"
},
"after": {
"anyOf": [
{},
{
"type": "null"
}
]
},
"courseSourcedIds": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
]
},
"first": {
"default": 20,
"type": "integer",
"minimum": 1,
"maximum": 100
},
"grades": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
]
},
"orderBy": {
"anyOf": [
{
"type": "array",
"items": {
"type": "object",
"properties": {
"direction": {
"type": "string",
"enum": [
"ASC",
"DESC"
]
},
"field": {
"type": "string",
"enum": [
"CREATED_AT",
"SOURCED_ID",
"TITLE",
"UPDATED_AT"
]
}
},
"required": [
"direction",
"field"
],
"additionalProperties": false
}
},
{
"type": "null"
}
]
},
"schoolSourcedIds": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
]
},
"sourcedIds": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
]
},
"status": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
]
},
"subjects": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
]
},
"termSourcedIds": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
]
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"rosterId",
"first"
],
"additionalProperties": false
},
"page": "/login"
}oneRosterCoursesAnswer
List OneRoster courses with school year and org details. Supports cursor-based pagination: use `first` to set page size (default 20, max 100) and `after` with the `endCursor` from a previous response to fetch the next page. The response includes `totalCount` and `pageInfo.endCursor`.
View tool JSON
{
"name": "oneRosterCourses",
"kind": "answer",
"impl": "imperative",
"description": "List OneRoster courses with school year and org details.\n\nSupports cursor-based pagination: use `first` to set page size (default 20, max 100) and `after` with the `endCursor` from a previous response to fetch the next page. The response includes `totalCount` and `pageInfo.endCursor`.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"properties": {
"rosterId": {
"type": "string"
},
"after": {
"anyOf": [
{},
{
"type": "null"
}
]
},
"courseCode": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"first": {
"default": 20,
"type": "integer",
"minimum": 1,
"maximum": 100
},
"grades": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
]
},
"orderBy": {
"anyOf": [
{
"type": "array",
"items": {
"type": "object",
"properties": {
"direction": {
"type": "string",
"enum": [
"ASC",
"DESC"
]
},
"field": {
"type": "string",
"enum": [
"CREATED_AT",
"SOURCED_ID",
"TITLE",
"UPDATED_AT"
]
}
},
"required": [
"direction",
"field"
],
"additionalProperties": false
}
},
{
"type": "null"
}
]
},
"orgSourcedIds": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
]
},
"sourcedIds": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
]
},
"status": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
]
},
"subjects": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
]
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"rosterId",
"first"
],
"additionalProperties": false
},
"page": "/login"
}oneRosterDemographicsAnswer
List OneRoster demographics for roster users. Supports cursor-based pagination: use `first` to set page size (default 20, max 100) and `after` with the `endCursor` from a previous response to fetch the next page. The response includes `totalCount` and `pageInfo.endCursor`.
View tool JSON
{
"name": "oneRosterDemographics",
"kind": "answer",
"impl": "imperative",
"description": "List OneRoster demographics for roster users.\n\nSupports cursor-based pagination: use `first` to set page size (default 20, max 100) and `after` with the `endCursor` from a previous response to fetch the next page. The response includes `totalCount` and `pageInfo.endCursor`.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"properties": {
"rosterId": {
"type": "string"
},
"after": {
"anyOf": [
{},
{
"type": "null"
}
]
},
"first": {
"default": 20,
"type": "integer",
"minimum": 1,
"maximum": 100
},
"orderBy": {
"anyOf": [
{
"type": "array",
"items": {
"type": "object",
"properties": {
"direction": {
"type": "string",
"enum": [
"ASC",
"DESC"
]
},
"field": {
"type": "string",
"enum": [
"CREATED_AT",
"SOURCED_ID",
"UPDATED_AT"
]
}
},
"required": [
"direction",
"field"
],
"additionalProperties": false
}
},
{
"type": "null"
}
]
},
"sourcedIds": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
]
}
},
"required": [
"rosterId",
"first"
],
"additionalProperties": false
},
"page": "/login"
}oneRosterEnrollmentsAnswer
List OneRoster enrollments with class and user context. Supports cursor-based pagination: use `first` to set page size (default 20, max 100) and `after` with the `endCursor` from a previous response to fetch the next page. The response includes `totalCount` and `pageInfo.endCursor`.
View tool JSON
{
"name": "oneRosterEnrollments",
"kind": "answer",
"impl": "imperative",
"description": "List OneRoster enrollments with class and user context.\n\nSupports cursor-based pagination: use `first` to set page size (default 20, max 100) and `after` with the `endCursor` from a previous response to fetch the next page. The response includes `totalCount` and `pageInfo.endCursor`.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"properties": {
"rosterId": {
"type": "string"
},
"after": {
"anyOf": [
{},
{
"type": "null"
}
]
},
"classSourcedIds": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
]
},
"first": {
"default": 20,
"type": "integer",
"minimum": 1,
"maximum": 100
},
"orderBy": {
"anyOf": [
{
"type": "array",
"items": {
"type": "object",
"properties": {
"direction": {
"type": "string",
"enum": [
"ASC",
"DESC"
]
},
"field": {
"type": "string",
"enum": [
"CREATED_AT",
"SOURCED_ID",
"UPDATED_AT"
]
}
},
"required": [
"direction",
"field"
],
"additionalProperties": false
}
},
{
"type": "null"
}
]
},
"roles": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
]
},
"schoolSourcedIds": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
]
},
"sourcedIds": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
]
},
"status": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
]
},
"userSourcedIds": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
]
}
},
"required": [
"rosterId",
"first"
],
"additionalProperties": false
},
"page": "/login"
}oneRosterOrgsAnswer
List OneRoster orgs for a roster with pagination. Supports cursor-based pagination: use `first` to set page size (default 20, max 100) and `after` with the `endCursor` from a previous response to fetch the next page. The response includes `totalCount` and `pageInfo.endCursor`.
View tool JSON
{
"name": "oneRosterOrgs",
"kind": "answer",
"impl": "imperative",
"description": "List OneRoster orgs for a roster with pagination.\n\nSupports cursor-based pagination: use `first` to set page size (default 20, max 100) and `after` with the `endCursor` from a previous response to fetch the next page. The response includes `totalCount` and `pageInfo.endCursor`.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"properties": {
"rosterId": {
"type": "string"
},
"after": {
"anyOf": [
{},
{
"type": "null"
}
]
},
"first": {
"default": 20,
"type": "integer",
"minimum": 1,
"maximum": 100
},
"orderBy": {
"anyOf": [
{
"type": "array",
"items": {
"type": "object",
"properties": {
"direction": {
"type": "string",
"enum": [
"ASC",
"DESC"
]
},
"field": {
"type": "string",
"enum": [
"CREATED_AT",
"IDENTIFIER",
"NAME",
"SOURCED_ID",
"TYPE",
"UPDATED_AT"
]
}
},
"required": [
"direction",
"field"
],
"additionalProperties": false
}
},
{
"type": "null"
}
]
},
"sourcedIds": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
]
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"types": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
]
}
},
"required": [
"rosterId",
"first"
],
"additionalProperties": false
},
"page": "/login"
}oneRosterRolesAnswer
List OneRoster roles with associated users and schools. Supports cursor-based pagination: use `first` to set page size (default 20, max 100) and `after` with the `endCursor` from a previous response to fetch the next page. The response includes `totalCount` and `pageInfo.endCursor`.
View tool JSON
{
"name": "oneRosterRoles",
"kind": "answer",
"impl": "imperative",
"description": "List OneRoster roles with associated users and schools.\n\nSupports cursor-based pagination: use `first` to set page size (default 20, max 100) and `after` with the `endCursor` from a previous response to fetch the next page. The response includes `totalCount` and `pageInfo.endCursor`.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"properties": {
"rosterId": {
"type": "string"
},
"after": {
"anyOf": [
{},
{
"type": "null"
}
]
},
"first": {
"default": 20,
"type": "integer",
"minimum": 1,
"maximum": 100
},
"orderBy": {
"anyOf": [
{
"type": "array",
"items": {
"type": "object",
"properties": {
"direction": {
"type": "string",
"enum": [
"ASC",
"DESC"
]
},
"field": {
"type": "string",
"enum": [
"CREATED_AT",
"ROLE",
"SOURCED_ID",
"UPDATED_AT"
]
}
},
"required": [
"direction",
"field"
],
"additionalProperties": false
}
},
{
"type": "null"
}
]
},
"roles": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
]
},
"schoolSourcedIds": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
]
},
"sourcedIds": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
]
},
"status": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
]
},
"userSourcedIds": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
]
}
},
"required": [
"rosterId",
"first"
],
"additionalProperties": false
},
"page": "/login"
}oneRosterUsersAnswer
List OneRoster users within a roster with PII redaction. Supports cursor-based pagination: use `first` to set page size (default 20, max 100) and `after` with the `endCursor` from a previous response to fetch the next page. The response includes `totalCount` and `pageInfo.endCursor`.
View tool JSON
{
"name": "oneRosterUsers",
"kind": "answer",
"impl": "imperative",
"description": "List OneRoster users within a roster with PII redaction.\n\nSupports cursor-based pagination: use `first` to set page size (default 20, max 100) and `after` with the `endCursor` from a previous response to fetch the next page. The response includes `totalCount` and `pageInfo.endCursor`.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"properties": {
"rosterId": {
"type": "string"
},
"after": {
"anyOf": [
{},
{
"type": "null"
}
]
},
"first": {
"default": 20,
"type": "integer",
"minimum": 1,
"maximum": 100
},
"email": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"familyName": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"givenName": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"grades": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
]
},
"roles": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
]
},
"status": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
]
},
"sourcedIds": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
]
}
},
"required": [
"rosterId",
"first"
],
"additionalProperties": false
},
"page": "/login"
}oneRostersAnswer
List OneRoster imports with status and org context. Supports cursor-based pagination: use `first` to set page size (default 20, max 100) and `after` with the `endCursor` from a previous response to fetch the next page. The response includes `totalCount` and `pageInfo.endCursor`.
View tool JSON
{
"name": "oneRosters",
"kind": "answer",
"impl": "imperative",
"description": "List OneRoster imports with status and org context.\n\nSupports cursor-based pagination: use `first` to set page size (default 20, max 100) and `after` with the `endCursor` from a previous response to fetch the next page. The response includes `totalCount` and `pageInfo.endCursor`.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"properties": {
"active": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"activitySince": {
"anyOf": [
{
"anyOf": [
{
"type": "string"
},
{
"type": "number"
}
]
},
{
"type": "null"
}
]
},
"after": {
"anyOf": [
{},
{
"type": "null"
}
]
},
"first": {
"default": 20,
"type": "integer",
"minimum": 1,
"maximum": 100
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"orderBy": {
"anyOf": [
{
"type": "array",
"items": {
"type": "object",
"properties": {
"direction": {
"type": "string",
"enum": [
"ASC",
"DESC"
]
},
"field": {
"type": "string",
"enum": [
"ACTIVE",
"CREATED_AT",
"NAME",
"ROSTER_ID",
"UPDATED_AT"
]
}
},
"required": [
"direction",
"field"
],
"additionalProperties": false
}
},
{
"type": "null"
}
]
},
"orgs": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
]
}
},
"required": [
"first"
],
"additionalProperties": false
},
"page": "/login"
}orgInvitesByEmailAnswer
Lookup organization invites sent to an email address
View tool JSON
{
"name": "orgInvitesByEmail",
"kind": "answer",
"impl": "imperative",
"description": "Lookup organization invites sent to an email address",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"properties": {
"email": {
"type": "string"
}
},
"required": [
"email"
],
"additionalProperties": false
},
"page": "/login"
}orgPlansAnswer
List available org billing plans
View tool JSON
{
"name": "orgPlans",
"kind": "answer",
"impl": "imperative",
"description": "List available org billing plans",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"properties": {},
"additionalProperties": false
},
"page": "/login"
}practiceSessionsAnswer
List practice sessions for a practice set. Supports cursor-based pagination: use `first` to set page size (default 20, max 100) and `after` with the `endCursor` from a previous response to fetch the next page. The response includes `totalCount` and `pageInfo.endCursor`.
View tool JSON
{
"name": "practiceSessions",
"kind": "answer",
"impl": "imperative",
"description": "List practice sessions for a practice set.\n\nSupports cursor-based pagination: use `first` to set page size (default 20, max 100) and `after` with the `endCursor` from a previous response to fetch the next page. The response includes `totalCount` and `pageInfo.endCursor`.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"properties": {
"after": {
"anyOf": [
{},
{
"type": "null"
}
]
},
"completed": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"first": {
"default": 20,
"type": "integer",
"minimum": 1,
"maximum": 100
},
"orderBy": {
"anyOf": [
{
"type": "array",
"items": {
"type": "object",
"properties": {
"direction": {
"type": "string",
"enum": [
"ASC",
"DESC"
]
},
"field": {
"type": "string",
"enum": [
"CREATED_AT",
"SCORE",
"TIME",
"UPDATED_AT"
]
}
},
"required": [
"direction",
"field"
],
"additionalProperties": false
}
},
{
"type": "null"
}
]
},
"ownerId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"practiceSetId": {
"type": "string"
},
"type": {
"anyOf": [
{
"type": "string",
"enum": [
"FLASHCARD",
"MATCHING",
"QUIZ",
"WRITE"
]
},
{
"type": "null"
}
]
}
},
"required": [
"first",
"practiceSetId"
],
"additionalProperties": false
},
"page": "/login"
}prepareUploadAction
Prepare a file upload and return signed details
View tool JSON
{
"name": "prepareUpload",
"kind": "act",
"impl": "imperative",
"description": "Prepare a file upload and return signed details",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"properties": {
"input": {
"type": "object",
"properties": {
"contentType": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"filename": {
"type": "string"
},
"type": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"filename"
],
"additionalProperties": false
}
},
"required": [
"input"
],
"additionalProperties": false
},
"page": "/login"
}quickLinksAnswer
Fetch quick links for a user or folder. Supports cursor-based pagination: use `first` to set page size (default 20, max 100) and `after` with the `endCursor` from a previous response to fetch the next page. The response includes `totalCount` and `pageInfo.endCursor`.
View tool JSON
{
"name": "quickLinks",
"kind": "answer",
"impl": "imperative",
"description": "Fetch quick links for a user or folder.\n\nSupports cursor-based pagination: use `first` to set page size (default 20, max 100) and `after` with the `endCursor` from a previous response to fetch the next page. The response includes `totalCount` and `pageInfo.endCursor`.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"properties": {
"after": {
"anyOf": [
{},
{
"type": "null"
}
]
},
"first": {
"default": 20,
"type": "integer",
"minimum": 1,
"maximum": 100
},
"orderBy": {
"anyOf": [
{
"type": "array",
"items": {
"type": "object",
"properties": {
"direction": {
"type": "string",
"enum": [
"ASC",
"DESC"
]
},
"field": {
"type": "string",
"enum": [
"CREATED_AT",
"TITLE",
"UPDATED_AT"
]
}
},
"required": [
"direction",
"field"
],
"additionalProperties": false
}
},
{
"type": "null"
}
]
},
"parentFolderId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"searchText": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"type": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string",
"enum": [
"folder",
"formative",
"url"
]
}
},
{
"type": "null"
}
]
},
"userId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"first"
],
"additionalProperties": false
},
"page": "/login"
}removeFolderSensitive Action
Remove a folder
View tool JSON
{
"name": "removeFolder",
"kind": "transact",
"impl": "imperative",
"description": "Remove a folder",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"properties": {
"id": {
"type": "string"
}
},
"required": [
"id"
],
"additionalProperties": false
},
"page": "/login"
}removeSectionSensitive Action
Delete a section
View tool JSON
{
"name": "removeSection",
"kind": "transact",
"impl": "imperative",
"description": "Delete a section",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"properties": {
"id": {
"type": "string"
}
},
"required": [
"id"
],
"additionalProperties": false
},
"page": "/login"
}rubricTemplatesAnswer
List rubric templates. Supports cursor-based pagination: use `first` to set page size (default 20, max 100) and `after` with the `endCursor` from a previous response to fetch the next page. The response includes `totalCount` and `pageInfo.endCursor`.
View tool JSON
{
"name": "rubricTemplates",
"kind": "answer",
"impl": "imperative",
"description": "List rubric templates.\n\nSupports cursor-based pagination: use `first` to set page size (default 20, max 100) and `after` with the `endCursor` from a previous response to fetch the next page. The response includes `totalCount` and `pageInfo.endCursor`.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"properties": {
"after": {
"anyOf": [
{},
{
"type": "null"
}
]
},
"first": {
"default": 20,
"type": "integer",
"minimum": 1,
"maximum": 100
}
},
"required": [
"first"
],
"additionalProperties": false
},
"page": "/login"
}saveAnswerSensitive Action
Save a student's answer to a formative item (question). **IMPORTANT**: A submission must exist before saving answers. Use saveSubmission first. **Answer Content Formats** (by question type): ``` multipleChoice: { "selected": ["B"] } multipleSelection: { "selected": ["A", "C"] } shortAnswer: { "text": "Paris" } longAnswer: { "text": "Long essay text..." } trueOrFalse: { "selected": ["true"] } or { "selected": ["false"] } numeric: { "text": "42" } fillInTheBlank: { "blanks": { "blank-1": "answer1", "blank-2": "answer2" } } matching: { "matches": { "A": "target1", "B": "target2" } } categorize: { "categories": { "category1": ["itemA", "itemB"], "category2": ["itemC"] } } resequence: { "order": ["C", "A", "B"] } hotSpot: { "selected": ["shape-id-1", "shape-id-2"] } hotText: { "selected": ["choice-id-1"] } ``` **Notes:** - For drawings, use the saveDrawingParts tool instead (saveAnswer rejects drawings) - The content parameter should be a JSON object matching the format above - For choice-based questions, the selected values are the choice IDs (e.g., "A", "B", etc.)
View tool JSON
{
"name": "saveAnswer",
"kind": "transact",
"impl": "imperative",
"description": "Save a student's answer to a formative item (question).\n\n**IMPORTANT**: A submission must exist before saving answers. Use saveSubmission first.\n\n**Answer Content Formats** (by question type):\n\n```\nmultipleChoice: { \"selected\": [\"B\"] }\nmultipleSelection: { \"selected\": [\"A\", \"C\"] }\nshortAnswer: { \"text\": \"Paris\" }\nlongAnswer: { \"text\": \"Long essay text...\" }\ntrueOrFalse: { \"selected\": [\"true\"] } or { \"selected\": [\"false\"] }\nnumeric: { \"text\": \"42\" }\nfillInTheBlank: { \"blanks\": { \"blank-1\": \"answer1\", \"blank-2\": \"answer2\" } }\nmatching: { \"matches\": { \"A\": \"target1\", \"B\": \"target2\" } }\ncategorize: { \"categories\": { \"category1\": [\"itemA\", \"itemB\"], \"category2\": [\"itemC\"] } }\nresequence: { \"order\": [\"C\", \"A\", \"B\"] }\nhotSpot: { \"selected\": [\"shape-id-1\", \"shape-id-2\"] }\nhotText: { \"selected\": [\"choice-id-1\"] }\n```\n\n**Notes:**\n- For drawings, use the saveDrawingParts tool instead (saveAnswer rejects drawings)\n- The content parameter should be a JSON object matching the format above\n- For choice-based questions, the selected values are the choice IDs (e.g., \"A\", \"B\", etc.)",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"properties": {
"input": {
"type": "object",
"properties": {
"answerId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"assignmentId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"content": {},
"drawing": {
"anyOf": [
{
"type": "array",
"items": {
"type": "object",
"properties": {
"d": {
"type": "string"
},
"id": {
"type": "string"
}
},
"required": [
"d",
"id"
],
"additionalProperties": false
}
},
{
"type": "null"
}
]
},
"formativeItemId": {
"type": "string"
},
"onBehalfOfStudentId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"onlyUpdateBlankContent": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"points": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"submissionId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"usedHint": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"usedHintId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"content",
"formativeItemId"
],
"additionalProperties": false
}
},
"required": [
"input"
],
"additionalProperties": false
},
"page": "/login"
}saveDrawingPartsAction
Save drawing annotations for an answer. This is used for questions with drawing enabled (e.g., show your work, long answer with drawing). Each drawing part represents an SVG path. **IMPORTANT**: A submission must exist before saving drawings. Use saveSubmission first. **Drawing Part Format:** Each part has: - id: A unique identifier for the path (generate a random string) - d: SVG path data string (e.g., "M 10 10 L 50 50 L 90 10") **Example:** ```json { "input": { "formativeItemId": "item123", "saveParts": [ { "id": "path-1", "d": "M 10 10 L 50 50" }, { "id": "path-2", "d": "M 20 20 C 40 40, 60 40, 80 20" } ] } } ``` **SVG Path Commands:** - M x y: Move to point - L x y: Line to point - C x1 y1, x2 y2, x y: Cubic bezier curve - Q x1 y1, x y: Quadratic bezier curve - Z: Close path
View tool JSON
{
"name": "saveDrawingParts",
"kind": "act",
"impl": "imperative",
"description": "Save drawing annotations for an answer.\n\nThis is used for questions with drawing enabled (e.g., show your work, long answer with drawing).\nEach drawing part represents an SVG path.\n\n**IMPORTANT**: A submission must exist before saving drawings. Use saveSubmission first.\n\n**Drawing Part Format:**\nEach part has:\n- id: A unique identifier for the path (generate a random string)\n- d: SVG path data string (e.g., \"M 10 10 L 50 50 L 90 10\")\n\n**Example:**\n```json\n{\n \"input\": {\n \"formativeItemId\": \"item123\",\n \"saveParts\": [\n { \"id\": \"path-1\", \"d\": \"M 10 10 L 50 50\" },\n { \"id\": \"path-2\", \"d\": \"M 20 20 C 40 40, 60 40, 80 20\" }\n ]\n }\n}\n```\n\n**SVG Path Commands:**\n- M x y: Move to point\n- L x y: Line to point\n- C x1 y1, x2 y2, x y: Cubic bezier curve\n- Q x1 y1, x y: Quadratic bezier curve\n- Z: Close path",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"properties": {
"input": {
"type": "object",
"properties": {
"assignmentId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"formativeItemId": {
"type": "string"
},
"onBehalfOfStudentId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"parts": {
"anyOf": [
{},
{
"type": "null"
}
]
},
"removeParts": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
]
},
"saveParts": {
"anyOf": [
{
"type": "array",
"items": {
"type": "object",
"properties": {
"d": {
"type": "string"
},
"id": {
"type": "string"
}
},
"required": [
"d",
"id"
],
"additionalProperties": false
}
},
{
"type": "null"
}
]
},
"submissionId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"formativeItemId"
],
"additionalProperties": false
}
},
"required": [
"input"
],
"additionalProperties": false
},
"page": "/login"
}saveFormativeLibraryListingAction
Create or update a formative library listing
View tool JSON
{
"name": "saveFormativeLibraryListing",
"kind": "act",
"impl": "imperative",
"description": "Create or update a formative library listing",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"properties": {
"input": {
"type": "object",
"properties": {
"afterSubmission": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"bundleIds": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
]
},
"commonAssessment": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"editorPick": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"formativeId": {
"type": "string"
},
"grades": {
"anyOf": [
{
"type": "array",
"items": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
}
},
{
"type": "null"
}
]
},
"iconUrl": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
]
},
"orgAccess": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
]
},
"public": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"published": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"randomizeQuestions": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"returnAnswers": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"returnScores": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"schoolYear": {
"anyOf": [
{
"type": "array",
"items": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
}
},
{
"type": "null"
}
]
},
"scoreThresholds": {
"anyOf": [
{
"type": "array",
"items": {
"type": "object",
"properties": {
"category": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"color": {
"type": "string"
},
"score": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
}
},
"required": [
"color",
"score"
],
"additionalProperties": false
}
},
{
"type": "null"
}
]
},
"secureBrowserTestMode": {
"anyOf": [
{
"type": "string",
"enum": [
"chromeKiosk",
"none",
"respondusBrowserHighSecurity",
"respondusBrowserLowSecurity",
"respondusBrowserMediumSecurity",
"safeExamBrowser"
]
},
{
"type": "null"
}
]
},
"singleQuestionView": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"subjects": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
]
},
"tags": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
]
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"formativeId"
],
"additionalProperties": false
}
},
"required": [
"input"
],
"additionalProperties": false
},
"page": "/login"
}saveLibraryBundleAction
Save a library bundle
View tool JSON
{
"name": "saveLibraryBundle",
"kind": "act",
"impl": "imperative",
"description": "Save a library bundle",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"properties": {
"input": {
"type": "object",
"properties": {
"bundleId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"clearListingsNotInFolder": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"grades": {
"anyOf": [
{
"type": "array",
"items": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
}
},
{
"type": "null"
}
]
},
"iconUrl": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"languages": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
]
},
"listingIds": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
]
},
"orgAccess": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
]
},
"public": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"subjects": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
]
},
"title": {
"type": "string"
}
},
"required": [
"title"
],
"additionalProperties": false
}
},
"required": [
"input"
],
"additionalProperties": false
},
"page": "/login"
}saveSubmissionSensitive Action
Create or update a submission for a formative. A submission represents a student's attempt at completing a formative. It tracks: - Whether the student has started the formative - Whether they have submitted their answers - Timing information for timed assessments - Retake information **Common workflows:** 1. **Start a submission** (student begins working): ```json { "input": { "formativeId": "abc123" } } ``` 2. **Submit the formative** (student is done): ```json { "input": { "formativeId": "abc123", "submitted": true } } ``` 3. **Teacher force-submits for a student**: ```json { "input": { "formativeId": "abc123", "onBehalfOfStudentId": "student123", "submitted": true } } ``` 4. **Teacher un-submits (reopen) for a student**: ```json { "input": { "formativeId": "abc123", "onBehalfOfStudentId": "student123", "submitted": false } } ``` 5. **Student starts a retake**: ```json { "input": { "formativeId": "abc123", "startRetake": true } } ``` 6. **Teacher pauses a student**: ```json { "input": { "formativeId": "abc123", "onBehalfOfStudentId": "student123", "pausedState": "teacherPaused" } } ```
View tool JSON
{
"name": "saveSubmission",
"kind": "transact",
"impl": "imperative",
"description": "Create or update a submission for a formative.\n\nA submission represents a student's attempt at completing a formative. It tracks:\n- Whether the student has started the formative\n- Whether they have submitted their answers\n- Timing information for timed assessments\n- Retake information\n\n**Common workflows:**\n\n1. **Start a submission** (student begins working):\n ```json\n { \"input\": { \"formativeId\": \"abc123\" } }\n ```\n\n2. **Submit the formative** (student is done):\n ```json\n { \"input\": { \"formativeId\": \"abc123\", \"submitted\": true } }\n ```\n\n3. **Teacher force-submits for a student**:\n ```json\n { \"input\": { \"formativeId\": \"abc123\", \"onBehalfOfStudentId\": \"student123\", \"submitted\": true } }\n ```\n\n4. **Teacher un-submits (reopen) for a student**:\n ```json\n { \"input\": { \"formativeId\": \"abc123\", \"onBehalfOfStudentId\": \"student123\", \"submitted\": false } }\n ```\n\n5. **Student starts a retake**:\n ```json\n { \"input\": { \"formativeId\": \"abc123\", \"startRetake\": true } }\n ```\n\n6. **Teacher pauses a student**:\n ```json\n { \"input\": { \"formativeId\": \"abc123\", \"onBehalfOfStudentId\": \"student123\", \"pausedState\": \"teacherPaused\" } }\n ```",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"properties": {
"input": {
"type": "object",
"properties": {
"assignmentId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"formativeId": {
"type": "string"
},
"ignoreIfSubmitted": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"onBehalfOfStudentId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"pausedState": {
"anyOf": [
{
"type": "string",
"enum": [
"AUTO_PAUSED",
"STUDENT_CAN_RESUME",
"TEACHER_PAUSED"
]
},
{
"type": "null"
}
]
},
"screenshotTakenAttempts": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"sectionId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"services": {
"anyOf": [
{
"type": "object",
"properties": {
"google": {
"anyOf": [
{
"type": "object",
"properties": {
"accessToken": {
"type": "string"
},
"attachmentId": {
"type": "string"
},
"courseId": {
"type": "string"
},
"postId": {
"type": "string"
},
"submissionId": {
"type": "string"
}
},
"required": [
"accessToken",
"attachmentId",
"courseId",
"postId",
"submissionId"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"lti": {
"anyOf": [
{
"type": "object",
"properties": {
"client_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"deployment_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"iss": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"lis_outcome_service_url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"lis_result_sourcedid": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"oauth_consumer_key": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"oauth_signature_method": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"additionalProperties": false
},
{
"type": "null"
}
]
}
},
"additionalProperties": false
},
{
"type": "null"
}
]
},
"sleepCount": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"startRetake": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"submitted": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"swipeAwayAttempts": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
}
},
"required": [
"formativeId"
],
"additionalProperties": false
}
},
"required": [
"input"
],
"additionalProperties": false
},
"page": "/login"
}sectionInvitesByEmailAnswer
Find section invites sent to an email
View tool JSON
{
"name": "sectionInvitesByEmail",
"kind": "answer",
"impl": "imperative",
"description": "Find section invites sent to an email",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"properties": {
"email": {
"type": "string"
}
},
"required": [
"email"
],
"additionalProperties": false
},
"page": "/login"
}setAssignmentAction
Create or update an assignment for a formative to a section (class). Note: In Formative, "section" and "class" are interchangeable terms. Requires ownership of the formative.
View tool JSON
{
"name": "setAssignment",
"kind": "act",
"impl": "imperative",
"description": "Create or update an assignment for a formative to a section (class). Note: In Formative, \"section\" and \"class\" are interchangeable terms. Requires ownership of the formative.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"properties": {
"formativeId": {
"type": "string"
},
"sectionId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"input": {
"type": "object",
"properties": {
"accentsKeyboard": {
"anyOf": [
{
"type": "string",
"enum": [
"french",
"german",
"italian",
"mandarin",
"spanish"
]
},
{
"type": "null"
}
]
},
"accommodations": {
"anyOf": [
{
"type": "array",
"items": {
"type": "object",
"properties": {
"accommodations": {
"type": "object",
"properties": {
"answerChoiceReduction": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"colorContrast": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"masking": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"textToSpeech": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"timeLimitExtension": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"translatorLanguage": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"additionalProperties": false
},
"studentId": {
"type": "string"
}
},
"required": [
"accommodations",
"studentId"
],
"additionalProperties": false
}
},
{
"type": "null"
}
]
},
"activeItemId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"activePosition": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"activeSectionId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"afterSubmission": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"autoLtiGradePassback": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"calculator": {
"anyOf": [
{
"type": "string",
"enum": [
"basic",
"graphing",
"scientific"
]
},
{
"type": "null"
}
]
},
"checkAnswerAttempts": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"closed": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"dueDate": {
"anyOf": [
{
"anyOf": [
{
"type": "string"
},
{
"type": "number"
}
]
},
{
"type": "null"
}
]
},
"enabledTranslations": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"endTime": {
"anyOf": [
{
"anyOf": [
{
"type": "string"
},
{
"type": "number"
}
]
},
{
"type": "null"
}
]
},
"enforceSingleSession": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"entryPassword": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"gameSound": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"gameType": {
"anyOf": [
{
"type": "string",
"enum": [
"championsChallenge"
]
},
{
"type": "null"
}
]
},
"googleClassroomAttachmentId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"googleClassroomCourseWorkId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"itemPacingDays": {
"anyOf": [
{
"type": "array",
"items": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
}
},
{
"type": "null"
}
]
},
"navGranularity": {
"anyOf": [
{
"type": "string",
"enum": [
"sections",
"sqv",
"topLevelItems"
]
},
{
"type": "null"
}
]
},
"overrides": {
"anyOf": [
{
"type": "array",
"items": {
"type": "object",
"properties": {
"studentId": {
"type": "string"
},
"teacherPaced": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
}
},
"required": [
"studentId"
],
"additionalProperties": false
}
},
{
"type": "null"
}
]
},
"paused": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"pinned": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"preview": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"public": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"publishToGoogleClassroom": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"randomizeQuestions": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"requireLti": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"retakes": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"retakesKeepCorrectAnswers": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"returnAnswers": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"returnScores": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"scheduled": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"secureBrowserAllowZoom": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"secureBrowserExitAfterSubmission": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"secureBrowserPauseAfterSwipeAttempts": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"secureBrowserQuitPassword": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"secureBrowserSecret": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"secureBrowserTestMode": {
"anyOf": [
{
"type": "string",
"enum": [
"chromeKiosk",
"none",
"respondusBrowserHighSecurity",
"respondusBrowserLowSecurity",
"respondusBrowserMediumSecurity",
"safeExamBrowser"
]
},
{
"type": "null"
}
]
},
"showingDescription": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"singleQuestionView": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"spellCheck": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"startTime": {
"anyOf": [
{
"anyOf": [
{
"type": "string"
},
{
"type": "number"
}
]
},
{
"type": "null"
}
]
},
"studentGroups": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
]
},
"studentNotes": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"students": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
]
},
"submissionLimit": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"teacherPaced": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"timeLimit": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
}
},
"additionalProperties": false
}
},
"required": [
"formativeId",
"input"
],
"additionalProperties": false
},
"page": "/login"
}studentGroupsAnswer
List student groups within sections. Supports cursor-based pagination: use `first` to set page size (default 20, max 100) and `after` with the `endCursor` from a previous response to fetch the next page. The response includes `totalCount` and `pageInfo.endCursor`.
View tool JSON
{
"name": "studentGroups",
"kind": "answer",
"impl": "imperative",
"description": "List student groups within sections.\n\nSupports cursor-based pagination: use `first` to set page size (default 20, max 100) and `after` with the `endCursor` from a previous response to fetch the next page. The response includes `totalCount` and `pageInfo.endCursor`.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"properties": {
"after": {
"anyOf": [
{},
{
"type": "null"
}
]
},
"archived": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"first": {
"default": 20,
"type": "integer",
"minimum": 1,
"maximum": 100
},
"orderBy": {
"anyOf": [
{
"type": "array",
"items": {
"type": "object",
"properties": {
"direction": {
"type": "string",
"enum": [
"ASC",
"DESC"
]
},
"field": {
"type": "string",
"enum": [
"createdAt",
"name",
"updatedAt"
]
}
},
"required": [
"direction",
"field"
],
"additionalProperties": false
}
},
{
"type": "null"
}
]
},
"searchText": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"sectionIds": {
"type": "array",
"items": {
"type": "string"
}
},
"userIds": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
]
}
},
"required": [
"first",
"sectionIds"
],
"additionalProperties": false
},
"page": "/login"
}syncOneRosterAction
Trigger a OneRoster sync job and return status
View tool JSON
{
"name": "syncOneRoster",
"kind": "act",
"impl": "imperative",
"description": "Trigger a OneRoster sync job and return status",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"properties": {
"rosterId": {
"type": "string"
}
},
"required": [
"rosterId"
],
"additionalProperties": false
},
"page": "/login"
}tagSetsAnswer
List tag sets filtered by subject or type
View tool JSON
{
"name": "tagSets",
"kind": "answer",
"impl": "imperative",
"description": "List tag sets filtered by subject or type",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"properties": {
"archived": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"hasTags": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"subject": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"type": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"additionalProperties": false
},
"page": "/login"
}teacherGradeAnswersAction
Apply teacher grades to answers
View tool JSON
{
"name": "teacherGradeAnswers",
"kind": "act",
"impl": "imperative",
"description": "Apply teacher grades to answers",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"properties": {
"answerIds": {
"type": "array",
"items": {
"type": "string"
}
},
"points": {
"type": "number"
},
"rubricLevels": {
"anyOf": [
{
"type": "array",
"items": {
"type": "object",
"properties": {
"criterionId": {
"type": "string"
},
"levelId": {
"type": "string"
}
},
"required": [
"criterionId",
"levelId"
],
"additionalProperties": false
}
},
{
"type": "null"
}
]
},
"scoreFactor": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
}
},
"required": [
"answerIds",
"points"
],
"additionalProperties": false
},
"page": "/login"
}updateFolderAction
Update folder metadata
View tool JSON
{
"name": "updateFolder",
"kind": "act",
"impl": "imperative",
"description": "Update folder metadata",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"properties": {
"id": {
"type": "string"
},
"input": {
"type": "object",
"properties": {
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"orgAccess": {
"anyOf": [
{
"type": "array",
"items": {
"type": "object",
"properties": {
"orgId": {
"type": "string"
},
"permissions": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string",
"enum": [
"assign",
"edit",
"viewAllData",
"viewAnonymousData"
]
}
},
{
"type": "null"
}
]
}
},
"required": [
"orgId"
],
"additionalProperties": false
}
},
{
"type": "null"
}
]
},
"ownerId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"parentId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"sourceParentId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"additionalProperties": false
}
},
"required": [
"id",
"input"
],
"additionalProperties": false
},
"page": "/login"
}updateFormativeAction
Update an existing formative (assessment). Requires ownership or appropriate permissions. **Basic update:** ```json { "id": "formative123", "input": { "title": "Updated Title" } } ``` Put all fields to update inside `input`. **Assignment settings** (control what students see): - returnScores: When students can see their scores - "never" - Never show scores - "afterSubmission" - Show after they submit - "immediately" - Show right away - returnAnswers: When students can see correct answers - "never" - Never show - "afterSubmission" - Show after they submit - "immediately" - Show right away **Display settings:** - randomizeQuestions: Randomize question order for students - singleQuestionView: Show one question per page **Appearance:** - headerColor: CSS color for header - headerImage: URL for header background image
View tool JSON
{
"name": "updateFormative",
"kind": "act",
"impl": "imperative",
"description": "Update an existing formative (assessment). Requires ownership or appropriate permissions.\n\n**Basic update:**\n```json\n{ \"id\": \"formative123\", \"input\": { \"title\": \"Updated Title\" } }\n```\n\nPut all fields to update inside `input`.\n\n**Assignment settings** (control what students see):\n- returnScores: When students can see their scores\n - \"never\" - Never show scores\n - \"afterSubmission\" - Show after they submit\n - \"immediately\" - Show right away\n\n- returnAnswers: When students can see correct answers\n - \"never\" - Never show\n - \"afterSubmission\" - Show after they submit\n - \"immediately\" - Show right away\n\n**Display settings:**\n- randomizeQuestions: Randomize question order for students\n- singleQuestionView: Show one question per page\n\n**Appearance:**\n- headerColor: CSS color for header\n- headerImage: URL for header background image",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"properties": {
"id": {
"type": "string"
},
"input": {
"type": "object",
"properties": {
"afterSubmission": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"aiGenerateFormative": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"aiGeneratePracticeSet": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"assessmentScheduledReleaseDate": {
"anyOf": [
{
"anyOf": [
{
"type": "string"
},
{
"type": "number"
}
]
},
{
"type": "null"
}
]
},
"assessmentWindowEndsAt": {
"anyOf": [
{
"anyOf": [
{
"type": "string"
},
{
"type": "number"
}
]
},
{
"type": "null"
}
]
},
"assessmentWindowStartsAt": {
"anyOf": [
{
"anyOf": [
{
"type": "string"
},
{
"type": "number"
}
]
},
{
"type": "null"
}
]
},
"benchmark": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"commonAssessment": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"disableAiGrading": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"enforceSingleSession": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"folderId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"grades": {
"anyOf": [
{
"type": "array",
"items": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
}
},
{
"type": "null"
}
]
},
"gradingMethod": {
"anyOf": [
{
"type": "string",
"enum": [
"progress",
"total"
]
},
{
"type": "null"
}
]
},
"headerColor": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"headerImage": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"headerInsetImage": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"isLessonBuilderActive": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"items": {
"anyOf": [
{
"type": "array",
"items": {
"type": "object",
"properties": {
"input": {
"type": "object",
"properties": {
"allowEquivalencies": {
"anyOf": [
{
"type": "string",
"enum": [
"ALGEBRAIC",
"BASIC",
"PERCENTAGE_TOLERANCE",
"RANGE",
"TOLERANCE"
]
},
{
"type": "null"
}
]
},
"alternateText": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"answerChoicePoints": {
"anyOf": [
{
"type": "array",
"items": {
"type": "number"
}
},
{
"type": "null"
}
]
},
"areChoiceExplanationsEnabled": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"blanks": {
"anyOf": [
{
"type": "array",
"items": {
"type": "object",
"properties": {
"choiceLabels": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
]
},
"choices": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
]
},
"correctAnswers": {
"type": "array",
"items": {
"type": "string"
}
},
"key": {
"type": "string"
},
"numeric": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
}
},
"required": [
"correctAnswers",
"key"
],
"additionalProperties": false
}
},
{
"type": "null"
}
]
},
"canvas": {
"anyOf": [
{},
{
"type": "null"
}
]
},
"canvasImageList": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
]
},
"childItemBankItemId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"choiceLabels": {
"anyOf": [
{
"type": "array",
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
{
"type": "null"
}
]
},
"choices": {
"anyOf": [
{
"type": "array",
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
{
"type": "null"
}
]
},
"citation": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"correctAnswers": {
"anyOf": [
{
"type": "array",
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
{
"type": "null"
}
]
},
"deleted": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"deletedAt": {
"anyOf": [
{
"anyOf": [
{
"type": "string"
},
{
"type": "number"
}
]
},
{
"type": "null"
}
]
},
"dragAndDrop": {
"anyOf": [
{
"type": "object",
"properties": {
"choices": {
"anyOf": [
{
"type": "array",
"items": {
"type": "object",
"properties": {
"key": {
"type": "string"
},
"label": {
"type": "string"
}
},
"required": [
"key",
"label"
],
"additionalProperties": false
}
},
{
"type": "null"
}
]
},
"correctAnswers": {
"anyOf": [
{
"type": "array",
"items": {
"type": "object",
"properties": {
"choiceKey": {
"type": "string"
},
"targetKey": {
"type": "string"
}
},
"required": [
"choiceKey",
"targetKey"
],
"additionalProperties": false
}
},
{
"type": "null"
}
]
},
"dropLocations": {
"anyOf": [
{
"type": "array",
"items": {
"type": "object",
"properties": {
"placement": {
"anyOf": [
{
"type": "string",
"enum": [
"auto",
"bottom",
"left",
"right",
"top"
]
},
{
"type": "null"
}
]
},
"targetKey": {
"type": "string"
},
"x": {
"type": "number"
},
"y": {
"type": "number"
}
},
"required": [
"targetKey",
"x",
"y"
],
"additionalProperties": false
}
},
{
"type": "null"
}
]
},
"imageSrc": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"source": {
"anyOf": [
{
"type": "string",
"enum": [
"image",
"text"
]
},
{
"type": "null"
}
]
}
},
"additionalProperties": false
},
{
"type": "null"
}
]
},
"formativeSectionId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"googleSlidePageId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"googleSlidePresentationId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"graph": {
"anyOf": [
{
"type": "object",
"properties": {
"correctAnswers": {
"type": "object",
"properties": {
"expressions": {
"anyOf": [
{
"type": "array",
"items": {
"type": "object",
"properties": {
"expression": {
"type": "string"
},
"id": {
"type": "string"
}
},
"required": [
"expression",
"id"
],
"additionalProperties": false
}
},
{
"type": "null"
}
]
},
"graphElements": {
"type": "array",
"items": {
"type": "object",
"properties": {
"asymptote": {
"anyOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"y": {
"type": "number"
}
},
"required": [
"id",
"y"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"dashed": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"function": {
"anyOf": [
{
"type": "string",
"enum": [
"ARCCOS",
"ARCSIN",
"ARCTAN",
"COS",
"SIN",
"TAN"
]
},
{
"type": "null"
}
]
},
"id": {
"type": "string"
},
"pointA": {
"anyOf": [
{
"type": "object",
"properties": {
"dotted": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"id": {
"type": "string"
},
"x": {
"type": "number"
},
"y": {
"type": "number"
}
},
"required": [
"id",
"x",
"y"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"pointB": {
"anyOf": [
{
"type": "object",
"properties": {
"dotted": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"id": {
"type": "string"
},
"x": {
"type": "number"
},
"y": {
"type": "number"
}
},
"required": [
"id",
"x",
"y"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"pointC": {
"anyOf": [
{
"type": "object",
"properties": {
"dotted": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"id": {
"type": "string"
},
"x": {
"type": "number"
},
"y": {
"type": "number"
}
},
"required": [
"id",
"x",
"y"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"points": {
"anyOf": [
{
"type": "array",
"items": {
"type": "object",
"properties": {
"dotted": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"id": {
"type": "string"
},
"x": {
"type": "number"
},
"y": {
"type": "number"
}
},
"required": [
"id",
"x",
"y"
],
"additionalProperties": false
}
},
{
"type": "null"
}
]
},
"rightPoint": {
"anyOf": [
{
"type": "object",
"properties": {
"dotted": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"id": {
"type": "string"
},
"x": {
"type": "number"
},
"y": {
"type": "number"
}
},
"required": [
"id",
"x",
"y"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"type": {
"type": "string",
"enum": [
"EXPONENTIAL",
"LINE",
"NUMBER_LINE",
"PARABOLA",
"POINTS",
"TRIG"
]
},
"vertex": {
"anyOf": [
{
"type": "object",
"properties": {
"dotted": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"id": {
"type": "string"
},
"x": {
"type": "number"
},
"y": {
"type": "number"
}
},
"required": [
"id",
"x",
"y"
],
"additionalProperties": false
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"type"
],
"additionalProperties": false
}
},
"inequalitySets": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"inequalities": {
"type": "array",
"items": {
"type": "object",
"properties": {
"graphElementId": {
"type": "string"
},
"inverse": {
"type": "boolean"
}
},
"required": [
"graphElementId",
"inverse"
],
"additionalProperties": false
}
}
},
"required": [
"id",
"inequalities"
],
"additionalProperties": false
}
}
},
"required": [
"graphElements",
"inequalitySets"
],
"additionalProperties": false
},
"pointDisplayToStudents": {
"anyOf": [
{
"type": "string",
"enum": [
"hidden",
"optional",
"visible"
]
},
{
"type": "null"
}
]
},
"shadingEnabled": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"studentsChooseLineType": {
"type": "boolean"
},
"tickLabelDisplay": {
"anyOf": [
{
"type": "string",
"enum": [
"all",
"endpoints",
"none",
"wholeNumbers"
]
},
{
"type": "null"
}
]
},
"tickType": {
"anyOf": [
{
"type": "string",
"enum": [
"decimal",
"fraction",
"pi"
]
},
{
"type": "null"
}
]
},
"viewBoundingBox": {
"anyOf": [
{
"type": "object",
"properties": {
"xMax": {
"type": "number"
},
"xMin": {
"type": "number"
},
"yMax": {
"type": "number"
},
"yMin": {
"type": "number"
}
},
"required": [
"xMax",
"xMin",
"yMax",
"yMin"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"xAxisLabel": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"xAxisMax": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"xAxisMin": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"xAxisStep": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"xInterceptEnabled": {
"type": "boolean"
},
"xTickType": {
"anyOf": [
{
"type": "string",
"enum": [
"decimal",
"fraction",
"pi"
]
},
{
"type": "null"
}
]
},
"yAxisLabel": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"yAxisMax": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"yAxisMin": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"yAxisStep": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"yInterceptEnabled": {
"type": "boolean"
},
"yTickType": {
"anyOf": [
{
"type": "string",
"enum": [
"decimal",
"fraction",
"pi"
]
},
{
"type": "null"
}
]
}
},
"required": [
"correctAnswers",
"studentsChooseLineType",
"xInterceptEnabled",
"yInterceptEnabled"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"helpText": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"hint": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"hints": {
"anyOf": [
{
"type": "array",
"items": {
"type": "object",
"properties": {
"hint": {
"type": "string"
},
"id": {
"type": "string"
}
},
"required": [
"hint",
"id"
],
"additionalProperties": false
}
},
{
"type": "null"
}
]
},
"hotSpot": {
"anyOf": [
{
"type": "object",
"properties": {
"correctAnswers": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
]
},
"isMultiSelect": {
"type": "boolean"
},
"shapes": {
"anyOf": [
{
"type": "array",
"items": {
"type": "object",
"properties": {
"key": {
"type": "string"
},
"shape": {}
},
"required": [
"key",
"shape"
],
"additionalProperties": false
}
},
{
"type": "null"
}
]
}
},
"required": [
"isMultiSelect"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"hotText": {
"anyOf": [
{
"type": "object",
"properties": {
"choices": {
"anyOf": [
{
"type": "array",
"items": {
"type": "object",
"properties": {
"choice": {
"type": "string"
},
"key": {
"type": "string"
}
},
"required": [
"choice",
"key"
],
"additionalProperties": false
}
},
{
"type": "null"
}
]
},
"correctAnswers": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
]
},
"isMultiSelect": {
"type": "boolean"
},
"text": {
"type": "string"
}
},
"required": [
"isMultiSelect",
"text"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"isCaseSensitive": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"isDrawingEnabled": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"isExtraCreditEnabled": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"isKeywordGrading": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"isPartialCredit": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"isRandomized": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"isRequired": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"isRubricEnabled": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"isRubricStudentViewDisabled": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"itemBankItemId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"labels": {
"anyOf": [
{
"type": "array",
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
{
"type": "null"
}
]
},
"lexileLevel": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"matchTableGrid": {
"anyOf": [
{
"type": "object",
"properties": {
"isMultiSelect": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
}
},
"additionalProperties": false
},
{
"type": "null"
}
]
},
"moveAfter": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"moveBefore": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"newselaContentId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"parentId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"partialCreditMode": {
"anyOf": [
{
"type": "string",
"enum": [
"ignoreIncorrect",
"original",
"standard",
"subtractIncorrect"
]
},
{
"type": "null"
}
]
},
"pinPosition": {
"anyOf": [
{
"type": "object",
"properties": {
"x": {
"type": "number"
},
"y": {
"type": "number"
}
},
"required": [
"x",
"y"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"points": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"preventReuseChoices": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"preventSkippingVideo": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"preventVideoCC": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"preventVideoPlaybackSpeed": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"removeCanvasParts": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
]
},
"rubric": {
"anyOf": [
{
"type": "object",
"properties": {
"criteria": {
"type": "array",
"items": {
"type": "object",
"properties": {
"description": {
"type": "string"
},
"id": {
"type": "string"
},
"levels": {
"type": "array",
"items": {
"type": "object",
"properties": {
"description": {
"type": "string"
},
"id": {
"type": "string"
},
"points": {
"type": "number"
},
"title": {
"type": "string"
}
},
"required": [
"description",
"id",
"points",
"title"
],
"additionalProperties": false
}
},
"tagIds": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
]
},
"title": {
"type": "string"
}
},
"required": [
"description",
"id",
"levels",
"title"
],
"additionalProperties": false
}
},
"description": {
"type": "string"
},
"title": {
"type": "string"
}
},
"required": [
"criteria",
"description",
"title"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"saveCanvasParts": {
"anyOf": [
{
"type": "array",
"items": {
"type": "object",
"properties": {
"d": {
"type": "string"
},
"id": {
"type": "string"
}
},
"required": [
"d",
"id"
],
"additionalProperties": false
}
},
{
"type": "null"
}
]
},
"sequenceScoringMethod": {
"anyOf": [
{
"type": "string",
"enum": [
"exactPosition",
"relativeOrder"
]
},
{
"type": "null"
}
]
},
"setChoiceExplanation": {
"anyOf": [
{
"type": "object",
"properties": {
"choice": {
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"choice",
"value"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"setChoiceExplanations": {
"anyOf": [
{
"type": "array",
"items": {
"type": "object",
"properties": {
"choice": {
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"choice",
"value"
],
"additionalProperties": false
}
},
{
"type": "null"
}
]
},
"showWordCount": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"src": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"styleId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"subtype": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"tabs": {
"anyOf": [
{
"type": "array",
"items": {
"type": "object",
"properties": {
"position": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"text": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"position"
],
"additionalProperties": false
}
},
{
"type": "null"
}
]
},
"tags": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
]
},
"targets": {
"anyOf": [
{
"type": "array",
"items": {
"type": "object",
"properties": {
"choices": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
]
},
"label": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"additionalProperties": false
}
},
{
"type": "null"
}
]
},
"text": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"timestamp": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"variants": {
"anyOf": [
{
"type": "array",
"items": {
"type": "object",
"properties": {
"correctAnswer": {
"type": "string"
},
"statement": {
"type": "string"
}
},
"required": [
"correctAnswer",
"statement"
],
"additionalProperties": false
}
},
{
"type": "null"
}
]
},
"videoPlaybackRate": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"videoTrimLocations": {
"anyOf": [
{
"type": "array",
"items": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
}
},
{
"type": "null"
}
]
},
"whiteboardGridSettings": {
"anyOf": [
{
"type": "object",
"properties": {
"active": {
"anyOf": [
{
"type": "object",
"properties": {
"enabled": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"locked": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
}
},
"additionalProperties": false
},
{
"type": "null"
}
]
},
"dots": {
"anyOf": [
{
"type": "object",
"properties": {
"enabled": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"locked": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
}
},
"additionalProperties": false
},
{
"type": "null"
}
]
},
"snap": {
"anyOf": [
{
"type": "object",
"properties": {
"enabled": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"locked": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
}
},
"additionalProperties": false
},
{
"type": "null"
}
]
}
},
"additionalProperties": false
},
{
"type": "null"
}
]
}
},
"additionalProperties": false
},
"subtype": {
"type": "string",
"enum": [
"audio",
"audioContent",
"bubbleSheet",
"categorize",
"dragAndDrop",
"embed",
"file",
"fillInTheBlank",
"functionalizedAudio",
"functionalizedBubbleSheet",
"functionalizedEmbed",
"functionalizedImage",
"functionalizedMultiPart",
"functionalizedNewselaArticle",
"functionalizedPairedPassages",
"functionalizedSlides",
"functionalizedText",
"functionalizedVideo",
"functionalizedWhiteBoard",
"graph",
"graphing",
"hotSpot",
"hotText",
"image",
"inlineChoice",
"longAnswer",
"matchTableGrid",
"matching",
"multipleChoice",
"multipleSelection",
"newselaArticle",
"numberLine",
"numeric",
"pairedPassages",
"resequence",
"shortAnswer",
"showYourWork",
"slides",
"text",
"trueOrFalse",
"video",
"videoAnswer",
"whiteBoard"
]
}
},
"required": [
"input",
"subtype"
],
"additionalProperties": false
}
},
{
"type": "null"
}
]
},
"newselaContentGrantIds": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
]
},
"note": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"numberOfRetakes": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"orgAccess": {
"anyOf": [
{
"type": "array",
"items": {
"type": "object",
"properties": {
"orgId": {
"type": "string"
},
"permissions": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string",
"enum": [
"assign",
"edit",
"viewAllData",
"viewAnonymousData"
]
}
},
{
"type": "null"
}
]
}
},
"required": [
"orgId"
],
"additionalProperties": false
}
},
{
"type": "null"
}
]
},
"ownerId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"questionNumberingScheme": {
"anyOf": [
{
"type": "string",
"enum": [
"BY_SECTION",
"DEFAULT"
]
},
{
"type": "null"
}
]
},
"randomizeQuestions": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"retakesAllowed": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"returnAnswers": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"returnScores": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"richTextV2": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"schoolYear": {
"anyOf": [
{
"type": "array",
"items": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
}
},
{
"type": "null"
}
]
},
"scoreThresholds": {
"anyOf": [
{
"type": "array",
"items": {
"type": "object",
"properties": {
"category": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"color": {
"type": "string"
},
"score": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
}
},
"required": [
"color",
"score"
],
"additionalProperties": false
}
},
{
"type": "null"
}
]
},
"sections": {
"anyOf": [
{
"type": "array",
"items": {
"type": "object",
"properties": {
"addBeforeFormativeItemId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"description": {
"type": "string"
},
"headerImage": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"id": {
"type": "string"
},
"instructions": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"note": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"position": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"preserveItemOrder": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"sectionColor": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"description",
"id",
"position"
],
"additionalProperties": false
}
},
{
"type": "null"
}
]
},
"secureBrowserTestMode": {
"anyOf": [
{
"type": "string",
"enum": [
"chromeKiosk",
"none",
"respondusBrowserHighSecurity",
"respondusBrowserLowSecurity",
"respondusBrowserMediumSecurity",
"safeExamBrowser"
]
},
{
"type": "null"
}
]
},
"singleQuestionView": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"sourceFolderId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"subjects": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
]
},
"tags": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
]
},
"themeId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"additionalProperties": false
}
},
"required": [
"id",
"input"
],
"additionalProperties": false
},
"page": "/login"
}updateFormativeItemAction
Update an existing formative item (question). Requires ownership of the formative. Supports all the same fields as addFormativeItem for updating: - text: Question text/prompt - points: Point value - choices, choiceLabels, correctAnswers: For choice-based questions - isCaseSensitive, allowEquivalencies: For text/numeric answers - isPartialCredit, partialCreditMode: Scoring options - isRandomized: Randomize choices - hints: Hint array - blanks, targets, hotSpot, hotText: For specialized question types - src, alternateText: For media content **Example:** ```json { "id": "item123", "input": { "text": "Updated question text", "correctAnswers": ["B", "C"] } } ``` Put all fields to update inside `input`. Set `input.deleted` to `true` to soft-delete an item.
View tool JSON
{
"name": "updateFormativeItem",
"kind": "act",
"impl": "imperative",
"description": "Update an existing formative item (question). Requires ownership of the formative.\n\nSupports all the same fields as addFormativeItem for updating:\n- text: Question text/prompt\n- points: Point value\n- choices, choiceLabels, correctAnswers: For choice-based questions\n- isCaseSensitive, allowEquivalencies: For text/numeric answers\n- isPartialCredit, partialCreditMode: Scoring options\n- isRandomized: Randomize choices\n- hints: Hint array\n- blanks, targets, hotSpot, hotText: For specialized question types\n- src, alternateText: For media content\n\n**Example:**\n```json\n{\n \"id\": \"item123\",\n \"input\": {\n \"text\": \"Updated question text\",\n \"correctAnswers\": [\"B\", \"C\"]\n }\n}\n```\n\nPut all fields to update inside `input`. Set `input.deleted` to `true` to soft-delete an item.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"properties": {
"id": {
"type": "string"
},
"input": {
"type": "object",
"properties": {
"allowEquivalencies": {
"anyOf": [
{
"type": "string",
"enum": [
"ALGEBRAIC",
"BASIC",
"PERCENTAGE_TOLERANCE",
"RANGE",
"TOLERANCE"
]
},
{
"type": "null"
}
]
},
"alternateText": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"answerChoicePoints": {
"anyOf": [
{
"type": "array",
"items": {
"type": "number"
}
},
{
"type": "null"
}
]
},
"areChoiceExplanationsEnabled": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"blanks": {
"anyOf": [
{
"type": "array",
"items": {
"type": "object",
"properties": {
"choiceLabels": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
]
},
"choices": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
]
},
"correctAnswers": {
"type": "array",
"items": {
"type": "string"
}
},
"key": {
"type": "string"
},
"numeric": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
}
},
"required": [
"correctAnswers",
"key"
],
"additionalProperties": false
}
},
{
"type": "null"
}
]
},
"canvas": {
"anyOf": [
{},
{
"type": "null"
}
]
},
"canvasImageList": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
]
},
"childItemBankItemId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"choiceLabels": {
"anyOf": [
{
"type": "array",
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
{
"type": "null"
}
]
},
"choices": {
"anyOf": [
{
"type": "array",
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
{
"type": "null"
}
]
},
"citation": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"correctAnswers": {
"anyOf": [
{
"type": "array",
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
{
"type": "null"
}
]
},
"deleted": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"deletedAt": {
"anyOf": [
{
"anyOf": [
{
"type": "string"
},
{
"type": "number"
}
]
},
{
"type": "null"
}
]
},
"dragAndDrop": {
"anyOf": [
{
"type": "object",
"properties": {
"choices": {
"anyOf": [
{
"type": "array",
"items": {
"type": "object",
"properties": {
"key": {
"type": "string"
},
"label": {
"type": "string"
}
},
"required": [
"key",
"label"
],
"additionalProperties": false
}
},
{
"type": "null"
}
]
},
"correctAnswers": {
"anyOf": [
{
"type": "array",
"items": {
"type": "object",
"properties": {
"choiceKey": {
"type": "string"
},
"targetKey": {
"type": "string"
}
},
"required": [
"choiceKey",
"targetKey"
],
"additionalProperties": false
}
},
{
"type": "null"
}
]
},
"dropLocations": {
"anyOf": [
{
"type": "array",
"items": {
"type": "object",
"properties": {
"placement": {
"anyOf": [
{
"type": "string",
"enum": [
"auto",
"bottom",
"left",
"right",
"top"
]
},
{
"type": "null"
}
]
},
"targetKey": {
"type": "string"
},
"x": {
"type": "number"
},
"y": {
"type": "number"
}
},
"required": [
"targetKey",
"x",
"y"
],
"additionalProperties": false
}
},
{
"type": "null"
}
]
},
"imageSrc": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"source": {
"anyOf": [
{
"type": "string",
"enum": [
"image",
"text"
]
},
{
"type": "null"
}
]
}
},
"additionalProperties": false
},
{
"type": "null"
}
]
},
"formativeSectionId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"googleSlidePageId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"googleSlidePresentationId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"graph": {
"anyOf": [
{
"type": "object",
"properties": {
"correctAnswers": {
"type": "object",
"properties": {
"expressions": {
"anyOf": [
{
"type": "array",
"items": {
"type": "object",
"properties": {
"expression": {
"type": "string"
},
"id": {
"type": "string"
}
},
"required": [
"expression",
"id"
],
"additionalProperties": false
}
},
{
"type": "null"
}
]
},
"graphElements": {
"type": "array",
"items": {
"type": "object",
"properties": {
"asymptote": {
"anyOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"y": {
"type": "number"
}
},
"required": [
"id",
"y"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"dashed": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"function": {
"anyOf": [
{
"type": "string",
"enum": [
"ARCCOS",
"ARCSIN",
"ARCTAN",
"COS",
"SIN",
"TAN"
]
},
{
"type": "null"
}
]
},
"id": {
"type": "string"
},
"pointA": {
"anyOf": [
{
"type": "object",
"properties": {
"dotted": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"id": {
"type": "string"
},
"x": {
"type": "number"
},
"y": {
"type": "number"
}
},
"required": [
"id",
"x",
"y"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"pointB": {
"anyOf": [
{
"type": "object",
"properties": {
"dotted": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"id": {
"type": "string"
},
"x": {
"type": "number"
},
"y": {
"type": "number"
}
},
"required": [
"id",
"x",
"y"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"pointC": {
"anyOf": [
{
"type": "object",
"properties": {
"dotted": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"id": {
"type": "string"
},
"x": {
"type": "number"
},
"y": {
"type": "number"
}
},
"required": [
"id",
"x",
"y"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"points": {
"anyOf": [
{
"type": "array",
"items": {
"type": "object",
"properties": {
"dotted": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"id": {
"type": "string"
},
"x": {
"type": "number"
},
"y": {
"type": "number"
}
},
"required": [
"id",
"x",
"y"
],
"additionalProperties": false
}
},
{
"type": "null"
}
]
},
"rightPoint": {
"anyOf": [
{
"type": "object",
"properties": {
"dotted": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"id": {
"type": "string"
},
"x": {
"type": "number"
},
"y": {
"type": "number"
}
},
"required": [
"id",
"x",
"y"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"type": {
"type": "string",
"enum": [
"EXPONENTIAL",
"LINE",
"NUMBER_LINE",
"PARABOLA",
"POINTS",
"TRIG"
]
},
"vertex": {
"anyOf": [
{
"type": "object",
"properties": {
"dotted": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"id": {
"type": "string"
},
"x": {
"type": "number"
},
"y": {
"type": "number"
}
},
"required": [
"id",
"x",
"y"
],
"additionalProperties": false
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"type"
],
"additionalProperties": false
}
},
"inequalitySets": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"inequalities": {
"type": "array",
"items": {
"type": "object",
"properties": {
"graphElementId": {
"type": "string"
},
"inverse": {
"type": "boolean"
}
},
"required": [
"graphElementId",
"inverse"
],
"additionalProperties": false
}
}
},
"required": [
"id",
"inequalities"
],
"additionalProperties": false
}
}
},
"required": [
"graphElements",
"inequalitySets"
],
"additionalProperties": false
},
"pointDisplayToStudents": {
"anyOf": [
{
"type": "string",
"enum": [
"hidden",
"optional",
"visible"
]
},
{
"type": "null"
}
]
},
"shadingEnabled": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"studentsChooseLineType": {
"type": "boolean"
},
"tickLabelDisplay": {
"anyOf": [
{
"type": "string",
"enum": [
"all",
"endpoints",
"none",
"wholeNumbers"
]
},
{
"type": "null"
}
]
},
"tickType": {
"anyOf": [
{
"type": "string",
"enum": [
"decimal",
"fraction",
"pi"
]
},
{
"type": "null"
}
]
},
"viewBoundingBox": {
"anyOf": [
{
"type": "object",
"properties": {
"xMax": {
"type": "number"
},
"xMin": {
"type": "number"
},
"yMax": {
"type": "number"
},
"yMin": {
"type": "number"
}
},
"required": [
"xMax",
"xMin",
"yMax",
"yMin"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"xAxisLabel": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"xAxisMax": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"xAxisMin": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"xAxisStep": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"xInterceptEnabled": {
"type": "boolean"
},
"xTickType": {
"anyOf": [
{
"type": "string",
"enum": [
"decimal",
"fraction",
"pi"
]
},
{
"type": "null"
}
]
},
"yAxisLabel": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"yAxisMax": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"yAxisMin": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"yAxisStep": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"yInterceptEnabled": {
"type": "boolean"
},
"yTickType": {
"anyOf": [
{
"type": "string",
"enum": [
"decimal",
"fraction",
"pi"
]
},
{
"type": "null"
}
]
}
},
"required": [
"correctAnswers",
"studentsChooseLineType",
"xInterceptEnabled",
"yInterceptEnabled"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"helpText": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"hint": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"hints": {
"anyOf": [
{
"type": "array",
"items": {
"type": "object",
"properties": {
"hint": {
"type": "string"
},
"id": {
"type": "string"
}
},
"required": [
"hint",
"id"
],
"additionalProperties": false
}
},
{
"type": "null"
}
]
},
"hotSpot": {
"anyOf": [
{
"type": "object",
"properties": {
"correctAnswers": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
]
},
"isMultiSelect": {
"type": "boolean"
},
"shapes": {
"anyOf": [
{
"type": "array",
"items": {
"type": "object",
"properties": {
"key": {
"type": "string"
},
"shape": {}
},
"required": [
"key",
"shape"
],
"additionalProperties": false
}
},
{
"type": "null"
}
]
}
},
"required": [
"isMultiSelect"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"hotText": {
"anyOf": [
{
"type": "object",
"properties": {
"choices": {
"anyOf": [
{
"type": "array",
"items": {
"type": "object",
"properties": {
"choice": {
"type": "string"
},
"key": {
"type": "string"
}
},
"required": [
"choice",
"key"
],
"additionalProperties": false
}
},
{
"type": "null"
}
]
},
"correctAnswers": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
]
},
"isMultiSelect": {
"type": "boolean"
},
"text": {
"type": "string"
}
},
"required": [
"isMultiSelect",
"text"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"isCaseSensitive": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"isDrawingEnabled": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"isExtraCreditEnabled": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"isKeywordGrading": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"isPartialCredit": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"isRandomized": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"isRequired": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"isRubricEnabled": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"isRubricStudentViewDisabled": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"itemBankItemId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"labels": {
"anyOf": [
{
"type": "array",
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
{
"type": "null"
}
]
},
"lexileLevel": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"matchTableGrid": {
"anyOf": [
{
"type": "object",
"properties": {
"isMultiSelect": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
}
},
"additionalProperties": false
},
{
"type": "null"
}
]
},
"moveAfter": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"moveBefore": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"newselaContentId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"parentId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"partialCreditMode": {
"anyOf": [
{
"type": "string",
"enum": [
"ignoreIncorrect",
"original",
"standard",
"subtractIncorrect"
]
},
{
"type": "null"
}
]
},
"pinPosition": {
"anyOf": [
{
"type": "object",
"properties": {
"x": {
"type": "number"
},
"y": {
"type": "number"
}
},
"required": [
"x",
"y"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"points": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"preventReuseChoices": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"preventSkippingVideo": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"preventVideoCC": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"preventVideoPlaybackSpeed": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"removeCanvasParts": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
]
},
"rubric": {
"anyOf": [
{
"type": "object",
"properties": {
"criteria": {
"type": "array",
"items": {
"type": "object",
"properties": {
"description": {
"type": "string"
},
"id": {
"type": "string"
},
"levels": {
"type": "array",
"items": {
"type": "object",
"properties": {
"description": {
"type": "string"
},
"id": {
"type": "string"
},
"points": {
"type": "number"
},
"title": {
"type": "string"
}
},
"required": [
"description",
"id",
"points",
"title"
],
"additionalProperties": false
}
},
"tagIds": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
]
},
"title": {
"type": "string"
}
},
"required": [
"description",
"id",
"levels",
"title"
],
"additionalProperties": false
}
},
"description": {
"type": "string"
},
"title": {
"type": "string"
}
},
"required": [
"criteria",
"description",
"title"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"saveCanvasParts": {
"anyOf": [
{
"type": "array",
"items": {
"type": "object",
"properties": {
"d": {
"type": "string"
},
"id": {
"type": "string"
}
},
"required": [
"d",
"id"
],
"additionalProperties": false
}
},
{
"type": "null"
}
]
},
"sequenceScoringMethod": {
"anyOf": [
{
"type": "string",
"enum": [
"exactPosition",
"relativeOrder"
]
},
{
"type": "null"
}
]
},
"setChoiceExplanation": {
"anyOf": [
{
"type": "object",
"properties": {
"choice": {
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"choice",
"value"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"setChoiceExplanations": {
"anyOf": [
{
"type": "array",
"items": {
"type": "object",
"properties": {
"choice": {
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"choice",
"value"
],
"additionalProperties": false
}
},
{
"type": "null"
}
]
},
"showWordCount": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"src": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"styleId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"subtype": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"tabs": {
"anyOf": [
{
"type": "array",
"items": {
"type": "object",
"properties": {
"position": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"text": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"position"
],
"additionalProperties": false
}
},
{
"type": "null"
}
]
},
"tags": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
]
},
"targets": {
"anyOf": [
{
"type": "array",
"items": {
"type": "object",
"properties": {
"choices": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
]
},
"label": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"additionalProperties": false
}
},
{
"type": "null"
}
]
},
"text": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"timestamp": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"variants": {
"anyOf": [
{
"type": "array",
"items": {
"type": "object",
"properties": {
"correctAnswer": {
"type": "string"
},
"statement": {
"type": "string"
}
},
"required": [
"correctAnswer",
"statement"
],
"additionalProperties": false
}
},
{
"type": "null"
}
]
},
"videoPlaybackRate": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"videoTrimLocations": {
"anyOf": [
{
"type": "array",
"items": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
}
},
{
"type": "null"
}
]
},
"whiteboardGridSettings": {
"anyOf": [
{
"type": "object",
"properties": {
"active": {
"anyOf": [
{
"type": "object",
"properties": {
"enabled": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"locked": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
}
},
"additionalProperties": false
},
{
"type": "null"
}
]
},
"dots": {
"anyOf": [
{
"type": "object",
"properties": {
"enabled": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"locked": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
}
},
"additionalProperties": false
},
{
"type": "null"
}
]
},
"snap": {
"anyOf": [
{
"type": "object",
"properties": {
"enabled": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"locked": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
}
},
"additionalProperties": false
},
{
"type": "null"
}
]
}
},
"additionalProperties": false
},
{
"type": "null"
}
]
}
},
"additionalProperties": false
}
},
"required": [
"id",
"input"
],
"additionalProperties": false
},
"page": "/login"
}updateFormativeLibraryListingAction
Update a formative library listing
View tool JSON
{
"name": "updateFormativeLibraryListing",
"kind": "act",
"impl": "imperative",
"description": "Update a formative library listing",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"properties": {
"id": {
"type": "string"
},
"input": {
"type": "object",
"properties": {
"editorPick": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
}
},
"additionalProperties": false
}
},
"required": [
"id",
"input"
],
"additionalProperties": false
},
"page": "/login"
}updateFormativeLibraryListingDisabledStatusAction
Enable or disable a formative library listing
View tool JSON
{
"name": "updateFormativeLibraryListingDisabledStatus",
"kind": "act",
"impl": "imperative",
"description": "Enable or disable a formative library listing",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"properties": {
"input": {
"type": "object",
"properties": {
"disabled": {
"type": "boolean"
},
"id": {
"type": "string"
}
},
"required": [
"disabled",
"id"
],
"additionalProperties": false
}
},
"required": [
"input"
],
"additionalProperties": false
},
"page": "/login"
}updateFormativeLibraryListingPublishedStatusSensitive Action
Publish or unpublish a formative library listing
View tool JSON
{
"name": "updateFormativeLibraryListingPublishedStatus",
"kind": "transact",
"impl": "imperative",
"description": "Publish or unpublish a formative library listing",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"properties": {
"input": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"published": {
"type": "boolean"
}
},
"required": [
"id",
"published"
],
"additionalProperties": false
}
},
"required": [
"input"
],
"additionalProperties": false
},
"page": "/login"
}updateOneRosterAction
Update OneRoster configuration settings
View tool JSON
{
"name": "updateOneRoster",
"kind": "act",
"impl": "imperative",
"description": "Update OneRoster configuration settings",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"properties": {
"rosterId": {
"type": "string"
},
"input": {
"type": "object",
"properties": {
"active": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"applyChanges": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"archiveUsersWhenDeleted": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"classEndGracePeriod": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"classStartGracePeriod": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"dataSourceName": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"defaultStudentPasswords": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"emailDomains": {
"anyOf": [
{
"type": "array",
"items": {
"type": "object",
"properties": {
"aliases": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
]
},
"domain": {
"type": "string"
},
"verified": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
}
},
"required": [
"domain"
],
"additionalProperties": false
}
},
{
"type": "null"
}
]
},
"endDate": {
"anyOf": [
{
"anyOf": [
{
"type": "string"
},
{
"type": "number"
}
]
},
{
"type": "null"
}
]
},
"fetchBatchSize": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"gradeWhitelist": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
]
},
"ignoreUsernames": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"importConcurrency": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"importDemographics": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"importSections": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"maxConcurrentRequests": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"mergeConflictingUsers": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"notificationEmails": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
]
},
"notificationFailurePeriod": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"oauthKey": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"oauthMethod": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"oauthSecret": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"oauthUrl": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"oneRosterLogin": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"orgId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"orgWhitelist": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
]
},
"preferredHour": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"reuseExistingSectionOnTermsMismatch": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"roleWhitelist": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
]
},
"sendAccountCreatedNotification": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"startDate": {
"anyOf": [
{
"anyOf": [
{
"type": "string"
},
{
"type": "number"
}
]
},
{
"type": "null"
}
]
},
"subjects": {
"anyOf": [
{
"type": "array",
"items": {
"type": "object",
"properties": {
"mapping": {
"type": "string"
},
"name": {
"type": "string"
}
},
"required": [
"mapping",
"name"
],
"additionalProperties": false
}
},
{
"type": "null"
}
]
},
"uploadUrlWithEncryptedPassword": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"version": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"additionalProperties": false
},
"withFiles": {
"default": false,
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
}
},
"required": [
"rosterId",
"input",
"withFiles"
],
"additionalProperties": false
},
"page": "/login"
}updateOrgAction
Update organization details
View tool JSON
{
"name": "updateOrg",
"kind": "act",
"impl": "imperative",
"description": "Update organization details",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"properties": {
"id": {
"type": "string"
},
"input": {
"type": "object",
"properties": {
"addresses": {
"anyOf": [
{
"type": "array",
"items": {
"anyOf": [
{
"type": "object",
"properties": {
"city": {
"type": "string"
},
"country": {
"type": "string"
},
"state": {
"type": "string"
},
"street": {
"type": "string"
},
"zip": {
"type": "string"
}
},
"required": [
"city",
"country",
"state",
"street",
"zip"
],
"additionalProperties": false
},
{
"type": "null"
}
]
}
},
{
"type": "null"
}
]
},
"aiConfigurationIdsToAdd": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
]
},
"aiConfigurationIdsToRemove": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
]
},
"brand": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"contract": {
"anyOf": [
{
"type": "object",
"properties": {
"billingType": {
"anyOf": [
{
"type": "string",
"enum": [
"MANUAL",
"STRIPE"
]
},
{
"type": "null"
}
]
},
"teacherLicenses": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
}
},
"additionalProperties": false
},
{
"type": "null"
}
]
},
"descendantIdsToDowngrade": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
]
},
"domains": {
"anyOf": [
{
"type": "array",
"items": {
"type": "object",
"properties": {
"domain": {
"type": "string"
},
"loginMethods": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string",
"enum": [
"authToken",
"clever",
"google",
"lti",
"magicLinkByEmail",
"microsoft",
"newsela",
"password",
"respondus"
]
}
},
{
"type": "null"
}
]
},
"method": {
"type": "string",
"enum": [
"MANUAL"
]
},
"role": {
"anyOf": [
{
"type": "string",
"enum": [
"STUDENT",
"TEACHER"
]
},
{
"type": "null"
}
]
}
},
"required": [
"domain",
"method"
],
"additionalProperties": false
}
},
{
"type": "null"
}
]
},
"featureWhitelist": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
]
},
"identifier": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"parentId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"rosterSyncMethods": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string",
"enum": [
"clever",
"google",
"microsoft",
"oneRoster"
]
}
},
{
"type": "null"
}
]
},
"serviceEndDate": {
"anyOf": [
{
"anyOf": [
{
"type": "string"
},
{
"type": "number"
}
]
},
{
"type": "null"
}
]
},
"serviceStartDate": {
"anyOf": [
{
"anyOf": [
{
"type": "string"
},
{
"type": "number"
}
]
},
{
"type": "null"
}
]
},
"serviceType": {
"anyOf": [
{
"type": "string",
"enum": [
"FREE",
"PARTNER",
"PILOT"
]
},
{
"type": "null"
}
]
},
"services": {
"anyOf": [
{
"type": "object",
"properties": {
"lti": {
"anyOf": [
{
"type": "object",
"properties": {
"enable": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"platforms": {
"anyOf": [
{
"type": "array",
"items": {
"type": "object",
"properties": {
"authRedirectUrl": {
"type": "string"
},
"authTokenUrl": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"clientId": {
"type": "string"
},
"deploymentId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"iss": {
"type": "string"
},
"keySetUrl": {
"type": "string"
}
},
"required": [
"authRedirectUrl",
"clientId",
"iss",
"keySetUrl"
],
"additionalProperties": false
}
},
{
"type": "null"
}
]
}
},
"additionalProperties": false
},
{
"type": "null"
}
]
},
"oneRoster": {
"anyOf": [
{
"type": "object",
"properties": {
"rosterId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"sourcedId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"additionalProperties": false
},
{
"type": "null"
}
]
},
"stripe": {
"anyOf": [
{
"type": "object",
"properties": {
"collectionMethod": {
"anyOf": [
{
"type": "string",
"enum": [
"CHARGE_AUTOMATICALLY",
"SEND_INVOICE"
]
},
{
"type": "null"
}
]
},
"confirmationToken": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"customerEmail": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"customerName": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"paymentMethodToken": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"planId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"quantity": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
}
},
"additionalProperties": false
},
{
"type": "null"
}
]
}
},
"additionalProperties": false
},
{
"type": "null"
}
]
},
"tagSets": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
]
},
"verified": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
}
},
"additionalProperties": false
}
},
"required": [
"id",
"input"
],
"additionalProperties": false
},
"page": "/login"
}updatePracticeItemAction
Update a practice item
View tool JSON
{
"name": "updatePracticeItem",
"kind": "act",
"impl": "imperative",
"description": "Update a practice item",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"properties": {
"id": {
"type": "string"
},
"input": {
"type": "object",
"properties": {
"flashcard": {
"anyOf": [
{
"type": "object",
"properties": {
"backContent": {
"anyOf": [
{
"type": "object",
"properties": {
"audioSrc": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"imageSrc": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"text": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"additionalProperties": false
},
{
"type": "null"
}
]
},
"frontContent": {
"anyOf": [
{
"type": "object",
"properties": {
"audioSrc": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"imageSrc": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"text": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"additionalProperties": false
},
{
"type": "null"
}
]
}
},
"additionalProperties": false
},
{
"type": "null"
}
]
}
},
"additionalProperties": false
}
},
"required": [
"id",
"input"
],
"additionalProperties": false
},
"page": "/login"
}updatePracticeSessionAction
Update practice session settings
View tool JSON
{
"name": "updatePracticeSession",
"kind": "act",
"impl": "imperative",
"description": "Update practice session settings",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"properties": {
"id": {
"type": "string"
},
"input": {
"type": "object",
"properties": {
"flashcard": {
"anyOf": [
{
"type": "object",
"properties": {
"completed": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"numAttempted": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"numCorrectOnFirstAttempt": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"progress": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"time": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
}
},
"additionalProperties": false
},
{
"type": "null"
}
]
},
"matching": {
"anyOf": [
{
"type": "object",
"properties": {
"completed": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"numAttempted": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"numCorrectOnFirstAttempt": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"score": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"time": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
}
},
"additionalProperties": false
},
{
"type": "null"
}
]
},
"quiz": {
"anyOf": [
{
"type": "object",
"properties": {
"completed": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"numAttempted": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"numCorrectOnFirstAttempt": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"progress": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"time": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
}
},
"additionalProperties": false
},
{
"type": "null"
}
]
},
"write": {
"anyOf": [
{
"type": "object",
"properties": {
"completed": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"numAttempted": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"numCorrectOnFirstAttempt": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"progress": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"time": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
}
},
"additionalProperties": false
},
{
"type": "null"
}
]
}
},
"additionalProperties": false
}
},
"required": [
"id",
"input"
],
"additionalProperties": false
},
"page": "/login"
}updateRubricTemplateAction
Update a rubric template
View tool JSON
{
"name": "updateRubricTemplate",
"kind": "act",
"impl": "imperative",
"description": "Update a rubric template",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"properties": {
"id": {
"type": "string"
},
"input": {
"type": "object",
"properties": {
"deleted": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"rubric": {
"anyOf": [
{
"type": "object",
"properties": {
"criteria": {
"type": "array",
"items": {
"type": "object",
"properties": {
"description": {
"type": "string"
},
"id": {
"type": "string"
},
"levels": {
"type": "array",
"items": {
"type": "object",
"properties": {
"description": {
"type": "string"
},
"id": {
"type": "string"
},
"points": {
"type": "number"
},
"title": {
"type": "string"
}
},
"required": [
"description",
"id",
"points",
"title"
],
"additionalProperties": false
}
},
"tagIds": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
]
},
"title": {
"type": "string"
}
},
"required": [
"description",
"id",
"levels",
"title"
],
"additionalProperties": false
}
},
"description": {
"type": "string"
},
"title": {
"type": "string"
}
},
"required": [
"criteria",
"description",
"title"
],
"additionalProperties": false
},
{
"type": "null"
}
]
}
},
"additionalProperties": false
}
},
"required": [
"id",
"input"
],
"additionalProperties": false
},
"page": "/login"
}updateSectionAction
Update an existing section (class). Note: In Formative, "section" and "class" are interchangeable terms. Requires ownership or appropriate permissions. **Common fields:** - title: Section name - abbreviation: Short code displayed in UI - color: Hex color code for the section - archived: Archive/unarchive the section **Organization and access:** - orgId: Move section to a different organization (requires org membership) - locked: Lock section to prevent students from joining via code - ownerId: Transfer ownership to an existing collaborator **Classification:** - grades: Array of grade levels (K=0, 1-12, Higher Ed=13) - subjects: Array of subject names **Example:** ```json { "id": "section123", "input": { "title": "Math Period 2", "color": "#3498db", "grades": [9, 10], "subjects": ["Math", "Algebra"] } } ```
View tool JSON
{
"name": "updateSection",
"kind": "act",
"impl": "imperative",
"description": "Update an existing section (class). Note: In Formative, \"section\" and \"class\" are interchangeable terms. Requires ownership or appropriate permissions.\n\n**Common fields:**\n- title: Section name\n- abbreviation: Short code displayed in UI\n- color: Hex color code for the section\n- archived: Archive/unarchive the section\n\n**Organization and access:**\n- orgId: Move section to a different organization (requires org membership)\n- locked: Lock section to prevent students from joining via code\n- ownerId: Transfer ownership to an existing collaborator\n\n**Classification:**\n- grades: Array of grade levels (K=0, 1-12, Higher Ed=13)\n- subjects: Array of subject names\n\n**Example:**\n```json\n{\n \"id\": \"section123\",\n \"input\": {\n \"title\": \"Math Period 2\",\n \"color\": \"#3498db\",\n \"grades\": [9, 10],\n \"subjects\": [\"Math\", \"Algebra\"]\n }\n}\n```",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"properties": {
"id": {
"type": "string"
},
"input": {
"type": "object",
"properties": {
"abbreviation": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"archived": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"cleverId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"color": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"googleClassroomId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"grades": {
"anyOf": [
{
"type": "array",
"items": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
}
},
{
"type": "null"
}
]
},
"locked": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"microsoft": {
"anyOf": [
{
"type": "object",
"properties": {
"classCode": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"course": {
"anyOf": [
{
"type": "object",
"properties": {
"courseNumber": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"displayName": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"externalId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"subject": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"additionalProperties": false
},
{
"type": "null"
}
]
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"displayName": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"externalId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"externalName": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"externalSource": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"externalSourceDetail": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"grade": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"members": {
"anyOf": [
{
"type": "array",
"items": {
"type": "object",
"properties": {
"accountEnabled": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"classes": {
"anyOf": [
{
"type": "array",
"items": {}
},
{
"type": "null"
}
]
},
"displayName": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"externalSource": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"externalSourceDetail": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"givenName": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"mail": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"mailNickname": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"microsoftTeamsClassroomUserId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"middleName": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"primaryRole": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"schools": {
"anyOf": [
{
"type": "array",
"items": {
"type": "object",
"properties": {
"address": {
"anyOf": [
{
"type": "object",
"properties": {
"city": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"countryOrRegion": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"postalCode": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"state": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"street": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"additionalProperties": false
},
{
"type": "null"
}
]
},
"classes": {
"anyOf": [
{
"type": "array",
"items": {}
},
{
"type": "null"
}
]
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"displayName": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"externalId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"externalPrincipalId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"externalSource": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"externalSourceDetail": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"fax": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"highestGrade": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"lowestGrade": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"phone": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"principalEmail": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"principalName": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"schoolNumber": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"users": {
"anyOf": [
{
"type": "array",
"items": {}
},
{
"type": "null"
}
]
}
},
"additionalProperties": false
}
},
{
"type": "null"
}
]
},
"student": {
"anyOf": [
{
"type": "object",
"properties": {
"birthDate": {
"anyOf": [
{
"anyOf": [
{
"type": "string"
},
{
"type": "number"
}
]
},
{
"type": "null"
}
]
},
"externalId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"gender": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"grade": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"graduationYear": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"studentNumber": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"additionalProperties": false
},
{
"type": "null"
}
]
},
"surname": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"teacher": {
"anyOf": [
{
"type": "object",
"properties": {
"externalId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"teacherNumber": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"additionalProperties": false
},
{
"type": "null"
}
]
},
"userPrincipalName": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"userType": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"additionalProperties": false
}
},
{
"type": "null"
}
]
},
"microsoftTeamsClassroomId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"schools": {
"anyOf": [
{
"type": "array",
"items": {
"type": "object",
"properties": {
"address": {
"anyOf": [
{
"type": "object",
"properties": {
"city": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"countryOrRegion": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"postalCode": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"state": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"street": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"additionalProperties": false
},
{
"type": "null"
}
]
},
"classes": {
"anyOf": [
{
"type": "array",
"items": {}
},
{
"type": "null"
}
]
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"displayName": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"externalId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"externalPrincipalId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"externalSource": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"externalSourceDetail": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"fax": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"highestGrade": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"lowestGrade": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"phone": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"principalEmail": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"principalName": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"schoolNumber": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"users": {
"anyOf": [
{
"type": "array",
"items": {
"type": "object",
"properties": {
"accountEnabled": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"classes": {
"anyOf": [
{
"type": "array",
"items": {}
},
{
"type": "null"
}
]
},
"displayName": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"externalSource": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"externalSourceDetail": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"givenName": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"mail": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"mailNickname": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"microsoftTeamsClassroomUserId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"middleName": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"primaryRole": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"schools": {
"anyOf": [
{
"type": "array",
"items": {}
},
{
"type": "null"
}
]
},
"student": {
"anyOf": [
{
"type": "object",
"properties": {
"birthDate": {
"anyOf": [
{
"anyOf": [
{
"type": "string"
},
{
"type": "number"
}
]
},
{
"type": "null"
}
]
},
"externalId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"gender": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"grade": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"graduationYear": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"studentNumber": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"additionalProperties": false
},
{
"type": "null"
}
]
},
"surname": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"teacher": {
"anyOf": [
{
"type": "object",
"properties": {
"externalId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"teacherNumber": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"additionalProperties": false
},
{
"type": "null"
}
]
},
"userPrincipalName": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"userType": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"additionalProperties": false
}
},
{
"type": "null"
}
]
}
},
"additionalProperties": false
}
},
{
"type": "null"
}
]
},
"teachers": {
"anyOf": [
{
"type": "array",
"items": {
"type": "object",
"properties": {
"accountEnabled": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"classes": {
"anyOf": [
{
"type": "array",
"items": {}
},
{
"type": "null"
}
]
},
"displayName": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"externalSource": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"externalSourceDetail": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"givenName": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"mail": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"mailNickname": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"microsoftTeamsClassroomUserId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"middleName": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"primaryRole": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"schools": {
"anyOf": [
{
"type": "array",
"items": {
"type": "object",
"properties": {
"address": {
"anyOf": [
{
"type": "object",
"properties": {
"city": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"countryOrRegion": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"postalCode": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"state": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"street": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"additionalProperties": false
},
{
"type": "null"
}
]
},
"classes": {
"anyOf": [
{
"type": "array",
"items": {}
},
{
"type": "null"
}
]
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"displayName": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"externalId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"externalPrincipalId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"externalSource": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"externalSourceDetail": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"fax": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"highestGrade": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"lowestGrade": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"phone": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"principalEmail": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"principalName": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"schoolNumber": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"users": {
"anyOf": [
{
"type": "array",
"items": {}
},
{
"type": "null"
}
]
}
},
"additionalProperties": false
}
},
{
"type": "null"
}
]
},
"student": {
"anyOf": [
{
"type": "object",
"properties": {
"birthDate": {
"anyOf": [
{
"anyOf": [
{
"type": "string"
},
{
"type": "number"
}
]
},
{
"type": "null"
}
]
},
"externalId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"gender": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"grade": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"graduationYear": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"studentNumber": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"additionalProperties": false
},
{
"type": "null"
}
]
},
"surname": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"teacher": {
"anyOf": [
{
"type": "object",
"properties": {
"externalId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"teacherNumber": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"additionalProperties": false
},
{
"type": "null"
}
]
},
"userPrincipalName": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"userType": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"additionalProperties": false
}
},
{
"type": "null"
}
]
},
"term": {
"anyOf": [
{
"type": "object",
"properties": {
"displayName": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"endDate": {
"anyOf": [
{
"anyOf": [
{
"type": "string"
},
{
"type": "number"
}
]
},
{
"type": "null"
}
]
},
"externalId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"microsoftTeamsClassroomTerm": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"startDate": {
"anyOf": [
{
"anyOf": [
{
"type": "string"
},
{
"type": "number"
}
]
},
{
"type": "null"
}
]
}
},
"additionalProperties": false
},
{
"type": "null"
}
]
}
},
"additionalProperties": false
},
{
"type": "null"
}
]
},
"notifyOwner": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"onBehalfOfTeacherId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"orgId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"ownerId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"subjects": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
]
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"additionalProperties": false
}
},
"required": [
"id",
"input"
],
"additionalProperties": false
},
"page": "/login"
}updateStudentGroupAction
Update a student group
View tool JSON
{
"name": "updateStudentGroup",
"kind": "act",
"impl": "imperative",
"description": "Update a student group",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"properties": {
"id": {
"type": "string"
},
"input": {
"type": "object",
"properties": {
"addStudentIds": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
]
},
"archived": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"removeStudentIds": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
]
},
"sectionId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"sourceFormativeId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"additionalProperties": false
}
},
"required": [
"id",
"input"
],
"additionalProperties": false
},
"page": "/login"
}updateUserAction
Update an existing user account. **Identity:** - firstName, lastName: User's name - nickname: Display name (optional) - emails: Array of email addresses - username: Username for login - password: Account password **Role & type:** - teacher: Set true for teacher accounts - student: Set true for student accounts - role: Professional role (TEACHER, SCHOOL_ADMINISTRATOR, DISTRICT_ADMINISTRATOR, INSTRUCTIONAL_COACH, etc.) - position: Job title/position **Service tiers (admin only):** - partner: Set partner (gold) status - pilot: Set pilot status - premium: Set premium (silver) status **Organization management:** - addToOrg: Add user to an organization { id, roles, verified } - updateOrg: Update user's org membership { id, roles, verified } - removeFromOrg: Remove user from an organization (org ID string) **Additional:** - identifier: External system ID - demographics: Demographic information object - vertical: User category - commandCenterRole: Internal admin role (requires formative team member status) - mergeRequest: Set a pending merge request { sourceUserId, comment } or null to clear **Example - Update profile:** ```json { "id": "userId123", "input": { "firstName": "John", "lastName": "Smith", "nickname": "Johnny", "role": "TEACHER", "position": "Math Teacher" } } ``` **Example - Add user to org:** ```json { "id": "userId123", "input": { "addToOrg": { "id": "orgId456", "roles": ["teacher"], "verified": true } } } ```
View tool JSON
{
"name": "updateUser",
"kind": "act",
"impl": "imperative",
"description": "Update an existing user account.\n\n**Identity:**\n- firstName, lastName: User's name\n- nickname: Display name (optional)\n- emails: Array of email addresses\n- username: Username for login\n- password: Account password\n\n**Role & type:**\n- teacher: Set true for teacher accounts\n- student: Set true for student accounts\n- role: Professional role (TEACHER, SCHOOL_ADMINISTRATOR, DISTRICT_ADMINISTRATOR, INSTRUCTIONAL_COACH, etc.)\n- position: Job title/position\n\n**Service tiers (admin only):**\n- partner: Set partner (gold) status\n- pilot: Set pilot status\n- premium: Set premium (silver) status\n\n**Organization management:**\n- addToOrg: Add user to an organization { id, roles, verified }\n- updateOrg: Update user's org membership { id, roles, verified }\n- removeFromOrg: Remove user from an organization (org ID string)\n\n**Additional:**\n- identifier: External system ID\n- demographics: Demographic information object\n- vertical: User category\n- commandCenterRole: Internal admin role (requires formative team member status)\n- mergeRequest: Set a pending merge request { sourceUserId, comment } or null to clear\n\n**Example - Update profile:**\n```json\n{\n \"id\": \"userId123\",\n \"input\": {\n \"firstName\": \"John\",\n \"lastName\": \"Smith\",\n \"nickname\": \"Johnny\",\n \"role\": \"TEACHER\",\n \"position\": \"Math Teacher\"\n }\n}\n```\n\n**Example - Add user to org:**\n```json\n{\n \"id\": \"userId123\",\n \"input\": {\n \"addToOrg\": { \"id\": \"orgId456\", \"roles\": [\"teacher\"], \"verified\": true }\n }\n}\n```",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"properties": {
"id": {
"type": "string"
},
"input": {
"type": "object",
"properties": {
"addBadge": {
"anyOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string",
"enum": [
"aiGenerated",
"aiHintsGenerated",
"aiQuestionsGenerated",
"completedKeyMilestoneChecklist",
"formativeCertifiedEducator",
"formativeChampion",
"formativeFanatic",
"formativesAssigned",
"formativesShared",
"foundations101Admin",
"foundations101Teachers",
"newselaArticle",
"questionOfTheDay",
"responseFeedbackGiven",
"responsesReceived",
"showYourKnowledge",
"standardsTagged"
]
},
"toast": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
}
},
"required": [
"id"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"addToOrg": {
"anyOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"roles": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
]
},
"verified": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
}
},
"required": [
"id"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"addToSection": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"animationPreferences": {
"anyOf": [
{
"type": "object",
"properties": {
"lunaHolidayCostumeDisabled": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
}
},
"additionalProperties": false
},
{
"type": "null"
}
]
},
"brand": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"cleverCreds": {
"anyOf": [
{
"type": "object",
"properties": {
"accessToken": {
"type": "string"
}
},
"required": [
"accessToken"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"commandCenterRole": {
"anyOf": [
{
"type": "string",
"enum": [
"business",
"csm",
"csmRestricted",
"design",
"dev",
"implementation",
"itemBankManager",
"product",
"qa",
"sales",
"support"
]
},
{
"type": "null"
}
]
},
"defaultAccommodations": {
"anyOf": [
{
"type": "object",
"properties": {
"answerChoiceReduction": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"colorContrast": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"masking": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"textToSpeech": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"timeLimitExtension": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"translatorLanguage": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"additionalProperties": false
},
{
"type": "null"
}
]
},
"defaultAssignOptions": {
"anyOf": [
{
"type": "object",
"properties": {
"accentsKeyboard": {
"anyOf": [
{
"type": "string",
"enum": [
"french",
"german",
"italian",
"mandarin",
"spanish"
]
},
{
"type": "null"
}
]
},
"afterSubmission": {
"type": "string"
},
"calculator": {
"anyOf": [
{
"type": "string",
"enum": [
"basic",
"graphing",
"scientific"
]
},
{
"type": "null"
}
]
},
"editAfterSubmit": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"publishToGoogleClassroom": {
"type": "boolean"
},
"randomizeQuestions": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"returnAnswers": {
"type": "string"
},
"returnScores": {
"type": "string"
},
"scheduled": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"singleQuestionView": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"studentNotes": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"submissionLimit": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
}
},
"required": [
"afterSubmission",
"publishToGoogleClassroom",
"returnAnswers",
"returnScores"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"defaultGradingMethod": {
"anyOf": [
{
"type": "string",
"enum": [
"progress",
"total"
]
},
{
"type": "null"
}
]
},
"defaultPointValue": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"demographics": {
"anyOf": [
{
"type": "object",
"properties": {
"americanIndianOrAlaskaNative": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"asian": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"birthDate": {
"anyOf": [
{
"anyOf": [
{
"type": "string"
},
{
"type": "number"
}
]
},
{
"type": "null"
}
]
},
"blackOrAfricanAmerican": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"cityOfBirth": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"countryOfBirthCode": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"demographicRaceTwoOrMoreRaces": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"ed": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"hispanicOrLatinoEthnicity": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"lep": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"nativeHawaiianOrOtherPacificIslander": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"publicSchoolResidenceStatus": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"sex": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"sped": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"stateOfBirthAbbreviation": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"status": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"white": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
}
},
"additionalProperties": false
},
{
"type": "null"
}
]
},
"editorPreferences": {
"anyOf": [
{
"type": "object",
"properties": {
"mathKeyboard": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
}
},
"additionalProperties": false
},
{
"type": "null"
}
]
},
"emails": {
"anyOf": [
{
"type": "array",
"items": {
"type": "object",
"properties": {
"address": {
"type": "string"
},
"verified": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
}
},
"required": [
"address"
],
"additionalProperties": false
}
},
{
"type": "null"
}
]
},
"featureWhitelist": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
]
},
"firstName": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"geoIpData": {
"anyOf": [
{
"type": "object",
"properties": {
"city": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"country": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"region": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"sig": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"additionalProperties": false
},
{
"type": "null"
}
]
},
"googleCreds": {
"anyOf": [
{
"type": "object",
"properties": {
"accessToken": {
"type": "string"
},
"clientId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"hostedDomain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"idToken": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"scope": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"accessToken",
"scope"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"grades": {
"anyOf": [
{
"type": "array",
"items": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
}
},
{
"type": "null"
}
]
},
"guest": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"homePage": {
"anyOf": [
{
"type": "object",
"properties": {
"shelves": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string",
"enum": [
"classes",
"quickLinks",
"recentFormatives"
]
}
},
{
"type": "null"
}
]
}
},
"additionalProperties": false
},
{
"type": "null"
}
]
},
"identifier": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"lastName": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"lastSecurityReviewAt": {
"anyOf": [
{
"anyOf": [
{
"type": "string"
},
{
"type": "number"
}
]
},
{
"type": "null"
}
]
},
"lastSeen": {
"anyOf": [
{
"anyOf": [
{
"type": "string"
},
{
"type": "number"
}
]
},
{
"type": "null"
}
]
},
"mergeRequest": {
"anyOf": [
{
"type": "object",
"properties": {
"comment": {
"type": "string"
},
"sourceUserId": {
"type": "string"
}
},
"required": [
"comment",
"sourceUserId"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"microsoftCreds": {
"anyOf": [
{
"type": "object",
"properties": {
"accessToken": {
"type": "string"
},
"idToken": {
"type": "string"
}
},
"required": [
"accessToken",
"idToken"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"newselaOAuthCreds": {
"anyOf": [
{
"type": "object",
"properties": {
"accessToken": {
"type": "string"
}
},
"required": [
"accessToken"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"nickname": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"notificationPreferences": {
"anyOf": [
{
"type": "object",
"properties": {
"coTeacherAddedToClass": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"editedAfterGraded": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"ltiGradePassbackFailed": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"reminderEmails": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"studentLateSubmissionOnly": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"studentSubmission": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"usedHint": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
}
},
"additionalProperties": false
},
{
"type": "null"
}
]
},
"partner": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"partnerSetAt": {
"anyOf": [
{
"anyOf": [
{
"type": "string"
},
{
"type": "number"
}
]
},
{
"type": "null"
}
]
},
"password": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"passwordChangeToken": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"passwordSalt": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"passwordVerifier": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"pendingMilestones": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
]
},
"pilot": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"pilotSetAt": {
"anyOf": [
{
"anyOf": [
{
"type": "string"
},
{
"type": "number"
}
]
},
{
"type": "null"
}
]
},
"position": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"preferredLanguage": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"premium": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"premiumSetAt": {
"anyOf": [
{
"anyOf": [
{
"type": "string"
},
{
"type": "number"
}
]
},
{
"type": "null"
}
]
},
"privacyPolicyAcceptDate": {
"anyOf": [
{
"anyOf": [
{
"type": "string"
},
{
"type": "number"
}
]
},
{
"type": "null"
}
]
},
"quotas": {
"anyOf": [
{
"type": "object",
"properties": {
"aiImageGeneration": {
"anyOf": [
{
"type": "object",
"properties": {
"month": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"remaining": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"used": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"year": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
}
},
"required": [
"month",
"used",
"year"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"aiInputTokens": {
"anyOf": [
{
"type": "object",
"properties": {
"month": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"remaining": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"used": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"year": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
}
},
"required": [
"month",
"used",
"year"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"aiOutputTokens": {
"anyOf": [
{
"type": "object",
"properties": {
"month": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"remaining": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"used": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"year": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
}
},
"required": [
"month",
"used",
"year"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"resultsExports": {
"anyOf": [
{
"type": "object",
"properties": {
"month": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"remaining": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"used": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"year": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
}
},
"required": [
"month",
"used",
"year"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"uploads": {
"anyOf": [
{
"type": "object",
"properties": {
"month": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"remaining": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"used": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"year": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
}
},
"required": [
"month",
"used",
"year"
],
"additionalProperties": false
},
{
"type": "null"
}
]
}
},
"additionalProperties": false
},
{
"type": "null"
}
]
},
"referralId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"removeBadge": {
"anyOf": [
{
"type": "string",
"enum": [
"aiGenerated",
"aiHintsGenerated",
"aiQuestionsGenerated",
"completedKeyMilestoneChecklist",
"formativeCertifiedEducator",
"formativeChampion",
"formativeFanatic",
"formativesAssigned",
"formativesShared",
"foundations101Admin",
"foundations101Teachers",
"newselaArticle",
"questionOfTheDay",
"responseFeedbackGiven",
"responsesReceived",
"showYourKnowledge",
"standardsTagged"
]
},
{
"type": "null"
}
]
},
"removeFromOrg": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"removeFromSection": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"role": {
"anyOf": [
{
"type": "string",
"enum": [
"DISTRICT_ADMINISTRATOR",
"INSTRUCTIONAL_COACH",
"LIBRARY_OR_MEDIA_SPECIALIST",
"OTHER",
"PARENT_TUTOR_OR_CAREGIVER",
"SCHOOL_ADMINISTRATOR",
"TEACHER",
"TECHNOLOGY_ADMINISTRATOR",
"admin",
"reviewer",
"writer"
]
},
{
"type": "null"
}
]
},
"scoreThresholds": {
"anyOf": [
{
"type": "array",
"items": {
"type": "object",
"properties": {
"category": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"color": {
"type": "string"
},
"score": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
}
},
"required": [
"color",
"score"
],
"additionalProperties": false
}
},
{
"type": "null"
}
]
},
"sectionInviteCode": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"sectionJoinCode": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"services": {
"anyOf": [
{
"type": "object",
"properties": {
"clever": {
"anyOf": [
{
"type": "object",
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"additionalProperties": false
},
{
"type": "null"
}
]
},
"google": {
"anyOf": [
{
"type": "object",
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"additionalProperties": false
},
{
"type": "null"
}
]
},
"lti": {
"anyOf": [
{
"type": "object",
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"additionalProperties": false
},
{
"type": "null"
}
]
},
"microsoft": {
"anyOf": [
{
"type": "object",
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"additionalProperties": false
},
{
"type": "null"
}
]
},
"newsela": {
"anyOf": [
{
"type": "object",
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"additionalProperties": false
},
{
"type": "null"
}
]
},
"oneRoster": {
"anyOf": [
{
"type": "object",
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"additionalProperties": false
},
{
"type": "null"
}
]
},
"password": {
"anyOf": [
{
"type": "object",
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"additionalProperties": false
},
{
"type": "null"
}
]
}
},
"additionalProperties": false
},
{
"type": "null"
}
]
},
"signUpTrackingParams": {
"anyOf": [
{
"type": "object",
"properties": {
"clickid": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"utm_campaign": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"utm_campaign_1": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"utm_campaign_2": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"utm_campaign_3": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"utm_campaign_4": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"utm_campaign_5": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"utm_content": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"utm_content_1": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"utm_content_2": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"utm_content_3": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"utm_content_4": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"utm_content_5": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"utm_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"utm_id_1": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"utm_id_2": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"utm_id_3": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"utm_id_4": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"utm_id_5": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"utm_medium": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"utm_medium_1": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"utm_medium_2": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"utm_medium_3": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"utm_medium_4": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"utm_medium_5": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"utm_source": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"utm_source_1": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"utm_source_2": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"utm_source_3": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"utm_source_4": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"utm_source_5": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"utm_term": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"utm_term_1": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"utm_term_2": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"utm_term_3": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"utm_term_4": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"utm_term_5": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"additionalProperties": false
},
{
"type": "null"
}
]
},
"startTrial": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"student": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"subjects": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
]
},
"tagSets": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
]
},
"teacher": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"tempUpgrade": {
"anyOf": [
{
"type": "object",
"properties": {
"endDate": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
}
]
},
"reason": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"startDate": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
}
]
}
},
"required": [
"endDate",
"startDate"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"tutorials": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
]
},
"updateOrg": {
"anyOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"roles": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
]
},
"verified": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
}
},
"required": [
"id"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"username": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"vertical": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"wondeCreds": {
"anyOf": [
{
"type": "object",
"properties": {
"accessToken": {
"type": "string"
}
},
"required": [
"accessToken"
],
"additionalProperties": false
},
{
"type": "null"
}
]
}
},
"additionalProperties": false
}
},
"required": [
"id",
"input"
],
"additionalProperties": false
},
"page": "/login"
}userByEmailAnswer
Look up a user by their email address. Requires appropriate permissions.
View tool JSON
{
"name": "userByEmail",
"kind": "answer",
"impl": "imperative",
"description": "Look up a user by their email address. Requires appropriate permissions.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"properties": {
"email": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"additionalProperties": false
},
"page": "/login"
}userByGoogleAccountIdAnswer
Fetch a user by Google account id with PII redaction
View tool JSON
{
"name": "userByGoogleAccountId",
"kind": "answer",
"impl": "imperative",
"description": "Fetch a user by Google account id with PII redaction",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"properties": {
"id": {
"type": "string"
}
},
"required": [
"id"
],
"additionalProperties": false
},
"page": "/login"
}userByUsernameAnswer
Look up a user by their username. Requires appropriate permissions.
View tool JSON
{
"name": "userByUsername",
"kind": "answer",
"impl": "imperative",
"description": "Look up a user by their username. Requires appropriate permissions.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"properties": {
"username": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"additionalProperties": false
},
"page": "/login"
}userNotificationsAnswer
Retrieve user notifications. Supports cursor-based pagination: use `first` to set page size (default 20, max 100) and `after` with the `endCursor` from a previous response to fetch the next page. The response includes `totalCount` and `pageInfo.endCursor`.
View tool JSON
{
"name": "userNotifications",
"kind": "answer",
"impl": "imperative",
"description": "Retrieve user notifications.\n\nSupports cursor-based pagination: use `first` to set page size (default 20, max 100) and `after` with the `endCursor` from a previous response to fetch the next page. The response includes `totalCount` and `pageInfo.endCursor`.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"properties": {
"after": {
"anyOf": [
{},
{
"type": "null"
}
]
},
"first": {
"default": 20,
"type": "integer",
"minimum": 1,
"maximum": 100
},
"orderBy": {
"anyOf": [
{
"type": "array",
"items": {
"type": "object",
"properties": {
"direction": {
"type": "string",
"enum": [
"ASC",
"DESC"
]
},
"field": {
"type": "string",
"enum": [
"IS_READ",
"UPDATED_AT"
]
}
},
"required": [
"direction",
"field"
],
"additionalProperties": false
}
},
{
"type": "null"
}
]
},
"startDate": {
"anyOf": [
{
"anyOf": [
{
"type": "string"
},
{
"type": "number"
}
]
},
{
"type": "null"
}
]
},
"types": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string",
"enum": [
"addAiFormative",
"adminBroadcast",
"answerEditedAfterGrading",
"autoLtiGradePassbackFailed",
"extendedTempUpgrade",
"feedbackMessage",
"inactiveUserAccount",
"orgInvite",
"referralCompleted",
"referralSignedUp",
"sectionArchived",
"sectionToBeAutoArchived",
"serviceEnd",
"studentSectionInvite",
"studentSubmission",
"usedHint"
]
}
},
{
"type": "null"
}
]
},
"userId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"first"
],
"additionalProperties": false
},
"page": "/login"
}userOrInviteExistsAnswer
Check if a user or invite exists for an identifier
View tool JSON
{
"name": "userOrInviteExists",
"kind": "answer",
"impl": "imperative",
"description": "Check if a user or invite exists for an identifier",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"properties": {
"usernameOrEmail": {
"type": "string"
}
},
"required": [
"usernameOrEmail"
],
"additionalProperties": false
},
"page": "/login"
}viewerAnswer
Get information about the authenticated user (the viewer). Returns profile, account status, organization membership, connected services, and more.
View tool JSON
{
"name": "viewer",
"kind": "answer",
"impl": "imperative",
"description": "Get information about the authenticated user (the viewer). Returns profile, account status, organization membership, connected services, and more.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"properties": {},
"additionalProperties": false
},
"page": "/login"
}