Save a quiz, mock exam, note, or flashcard set you have already written into a project. To have Studocu generate a quiz or mock exam instead, use request-creation.
View input schema
{
"type": "object",
"properties": {
"project_id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
"description": "UUID of the project that will own the creation. Example: 11111111-1111-4111-8111-111111111111. From create-project or get-context."
},
"artifact": {
"oneOf": [
{
"type": "object",
"properties": {
"kind": {
"type": "string",
"const": "creation",
"description": "Must be the string creation. A project source cannot be written with this tool."
},
"description": {
"description": "Optional short description of the creation (quiz, mock exam, or flashcard set). The note type does not have this field.",
"type": "string",
"minLength": 1
},
"title": {
"type": "string",
"minLength": 20,
"maxLength": 255,
"description": "Quiz title shown to the learner. 20-255 characters."
},
"type": {
"type": "string",
"const": "quiz"
},
"content": {
"type": "object",
"properties": {
"questions": {
"minItems": 1,
"type": "array",
"items": {
"type": "object",
"properties": {
"question": {
"type": "string",
"minLength": 1,
"description": "Question prompt shown to the learner."
},
"answers": {
"minItems": 2,
"type": "array",
"items": {
"type": "object",
"properties": {
"answer": {
"type": "string",
"minLength": 1,
"description": "Answer option text."
},
"is_correct": {
"type": "boolean",
"description": "True for the correct option or options."
}
},
"required": [
"answer",
"is_correct"
],
"additionalProperties": false
}
},
"explanation": {
"type": "string",
"minLength": 1,
"maxLength": 255,
"description": "Why the correct answer is right. Required. 1-255 characters."
},
"difficulty": {
"type": "string",
"enum": [
"EASY",
"MEDIUM",
"HARD"
]
}
},
"required": [
"question",
"answers",
"explanation"
],
"additionalProperties": false
}
},
"course_id": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
}
},
"required": [
"questions"
],
"additionalProperties": false,
"description": "Quiz content."
}
},
"required": [
"kind",
"title",
"type",
"content"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"kind": {
"type": "string",
"const": "creation",
"description": "Must be the string creation. A project source cannot be written with this tool."
},
"description": {
"description": "Optional short description of the creation (quiz, mock exam, or flashcard set). The note type does not have this field.",
"type": "string",
"minLength": 1
},
"title": {
"type": "string",
"minLength": 1,
"description": "Title shown to the learner. At least 1 character."
},
"type": {
"type": "string",
"const": "mockExam"
},
"content": {
"type": "object",
"properties": {
"exam_json": {
"type": "object",
"properties": {
"schema_version": {
"type": "string",
"const": "0.8"
},
"title": {
"type": "string",
"minLength": 1
},
"front_matter": {
"type": "object",
"properties": {
"instructions_markdown": {
"type": "string"
}
},
"additionalProperties": false
},
"content": {
"minItems": 1,
"type": "array",
"items": {
"oneOf": [
{
"type": "object",
"properties": {
"kind": {
"type": "string",
"const": "section"
},
"id": {
"type": "string",
"minLength": 1
},
"title": {
"type": "string",
"minLength": 1
},
"question_type": {
"type": "string",
"enum": [
"mcq",
"multi_select",
"true_false",
"fill_in_blank",
"text_answer_short",
"text_answer_long"
],
"description": "Question type: mcq, multi_select, true_false, fill_in_blank, text_answer_short, or text_answer_long. Use mcq, not multiple_choice."
},
"instructions": {
"type": "string",
"minLength": 1
}
},
"required": [
"kind",
"id",
"question_type"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"kind": {
"type": "string",
"const": "stimulus"
},
"id": {
"type": "string",
"minLength": 1
},
"title": {
"type": "string",
"minLength": 1
},
"stimulus_markdown": {
"type": "string",
"minLength": 1
}
},
"required": [
"kind",
"id",
"stimulus_markdown"
],
"additionalProperties": false
},
{
"oneOf": [
{
"type": "object",
"properties": {
"kind": {
"type": "string",
"const": "question"
},
"id": {
"type": "string",
"minLength": 1
},
"section_id": {
"type": "string",
"minLength": 1
},
"type": {
"type": "string",
"enum": [
"mcq",
"multi_select",
"true_false"
]
},
"marks": {
"type": "number",
"minimum": 0
},
"question_markdown": {
"type": "string",
"minLength": 1
},
"stimulus_id_refs": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string",
"minLength": 1
}
},
{
"type": "null"
}
]
},
"options": {
"minItems": 2,
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"description": "Stable option id."
},
"text": {
"type": "string",
"minLength": 1,
"description": "Option text."
}
},
"required": [
"id",
"text"
],
"additionalProperties": false
}
},
"grading": {
"type": "object",
"properties": {
"correct_answer_ids": {
"type": "array",
"items": {
"type": "string",
"minLength": 1
}
},
"correct_answer": {
"type": "string"
},
"model_answer": {
"type": "string",
"minLength": 1
},
"key_points": {
"type": "array",
"items": {
"type": "string",
"minLength": 1
}
}
},
"required": [
"model_answer"
],
"additionalProperties": false
},
"topics": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string",
"minLength": 1
}
},
{
"type": "null"
}
]
}
},
"required": [
"kind",
"id",
"section_id",
"type",
"marks",
"question_markdown",
"options"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"kind": {
"type": "string",
"const": "question"
},
"id": {
"type": "string",
"minLength": 1
},
"section_id": {
"type": "string",
"minLength": 1
},
"type": {
"type": "string",
"const": "fill_in_blank"
},
"marks": {
"type": "number",
"minimum": 0
},
"question_markdown": {
"type": "string",
"minLength": 1
},
"stimulus_id_refs": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string",
"minLength": 1
}
},
{
"type": "null"
}
]
},
"template_markdown": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"blanks": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"label": {
"type": "string"
}
},
"required": [
"id"
],
"additionalProperties": false
}
},
"grading": {
"type": "object",
"properties": {
"correct_answer_ids": {
"type": "array",
"items": {
"type": "string",
"minLength": 1
}
},
"correct_answer": {
"type": "string"
},
"model_answer": {
"type": "string",
"minLength": 1
},
"key_points": {
"type": "array",
"items": {
"type": "string",
"minLength": 1
}
}
},
"required": [
"model_answer"
],
"additionalProperties": false
},
"topics": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string",
"minLength": 1
}
},
{
"type": "null"
}
]
}
},
"required": [
"kind",
"id",
"section_id",
"type",
"marks",
"question_markdown"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"kind": {
"type": "string",
"const": "question"
},
"id": {
"type": "string",
"minLength": 1
},
"section_id": {
"type": "string",
"minLength": 1
},
"type": {
"type": "string",
"enum": [
"text_answer_short",
"text_answer_long"
]
},
"marks": {
"type": "number",
"minimum": 0
},
"question_markdown": {
"type": "string",
"minLength": 1
},
"stimulus_id_refs": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string",
"minLength": 1
}
},
{
"type": "null"
}
]
},
"grading": {
"type": "object",
"properties": {
"correct_answer_ids": {
"type": "array",
"items": {
"type": "string",
"minLength": 1
}
},
"correct_answer": {
"type": "string"
},
"model_answer": {
"type": "string",
"minLength": 1
},
"key_points": {
"type": "array",
"items": {
"type": "string",
"minLength": 1
}
}
},
"required": [
"model_answer"
],
"additionalProperties": false
},
"topics": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string",
"minLength": 1
}
},
{
"type": "null"
}
]
}
},
"required": [
"kind",
"id",
"section_id",
"type",
"marks",
"question_markdown"
],
"additionalProperties": false
}
]
}
]
}
}
},
"required": [
"schema_version",
"title",
"content"
],
"additionalProperties": false
}
},
"required": [
"exam_json"
],
"additionalProperties": false,
"description": "Mock exam content."
}
},
"required": [
"kind",
"title",
"type",
"content"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"kind": {
"type": "string",
"const": "creation",
"description": "Must be the string creation. A project source cannot be written with this tool."
},
"title": {
"type": "string",
"minLength": 1,
"maxLength": 255,
"description": "Note title. 1-255 characters."
},
"type": {
"type": "string",
"const": "note"
},
"content": {
"type": "object",
"properties": {
"html": {
"type": "string",
"minLength": 1,
"description": "Complete HTML document for the note body (max 1 MiB UTF-8)."
}
},
"required": [
"html"
],
"additionalProperties": false,
"description": "Note content."
}
},
"required": [
"kind",
"title",
"type",
"content"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"kind": {
"type": "string",
"const": "creation",
"description": "Must be the string creation. A project source cannot be written with this tool."
},
"description": {
"description": "Optional short description of the creation (quiz, mock exam, or flashcard set). The note type does not have this field.",
"type": "string",
"minLength": 1
},
"title": {
"type": "string",
"minLength": 1,
"description": "Title shown to the learner. At least 1 character."
},
"type": {
"type": "string",
"const": "flashcard"
},
"content": {
"type": "object",
"properties": {
"flashcards_json": {
"type": "object",
"properties": {
"title": {
"type": "string",
"minLength": 1
},
"description": {
"type": "string"
},
"flashcards": {
"minItems": 1,
"maxItems": 200,
"type": "array",
"items": {
"type": "object",
"properties": {
"front": {
"type": "string",
"minLength": 1
},
"back": {
"type": "string",
"minLength": 1
}
},
"required": [
"front",
"back"
],
"additionalProperties": false
}
}
},
"required": [
"title",
"description",
"flashcards"
],
"additionalProperties": false
}
},
"required": [
"flashcards_json"
],
"additionalProperties": false,
"description": "Flashcard set content."
}
},
"required": [
"kind",
"title",
"type",
"content"
],
"additionalProperties": false
}
],
"description": "The creation to save. type is quiz, mockExam, note, or flashcard. Each type has its own content shape. kind must be creation."
}
},
"required": [
"project_id",
"artifact"
],
"$schema": "http://json-schema.org/draft-07/schema#"
}