{"openapi":"3.1.0","info":{"title":"Intoola Study","version":"1.0.0","description":"Intoola Study turns students' own course materials into practice exams, flashcards and study guides. Requires an Intoola account with an active Intoola Study subscription."},"servers":[{"url":"https://socrian.socrianstudyassistant.workers.dev"}],"paths":{"/muse/v1/status":{"get":{"operationId":"get_subscription_status","summary":"Check whether the connected Intoola account has an active Intoola Study subscription.","security":[{"intoola":["account:status"]}],"responses":{"200":{"description":"Status"},"401":{"description":"Invalid or expired token"}}}},"/muse/v1/actions/create_practice_exam":{"post":{"operationId":"create_practice_exam","summary":"Create a practice exam from course material with Intoola Study.","description":"Use when a student wants a practice exam or practice questions from their own lecture notes or course material. Intoola Study turns the material into mixed-format questions (multiple choice, short answer, true/false, essay, scenario) with worked answers. Requires the student to have an active Intoola Study subscription.","security":[{"intoola":["study:generate"]}],"parameters":[{"name":"Idempotency-Key","in":"header","required":false,"schema":{"type":"string","minLength":8,"maxLength":128},"description":"Optional. Retries with the same key replay the first result."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["material_text"],"properties":{"material_text":{"type":"string","description":"The course material (lecture notes, textbook excerpt, slides text) to study from. Plain text or Markdown.","minLength":40,"maxLength":50000},"additional_instructions":{"type":"string","description":"Optional extra guidance from the student, e.g. topics to emphasise or the exam format.","maxLength":500},"num_questions":{"type":"integer","description":"Number of questions.","minimum":5,"maximum":25,"default":20},"difficulty":{"type":"string","description":"Overall difficulty.","enum":["easy","medium","hard","mixed"],"default":"mixed"}}}}}},"responses":{"200":{"description":"Generated study resource"},"400":{"description":"Invalid parameters"},"401":{"description":"Missing, invalid or expired authorization"},"402":{"description":"An active Intoola Study subscription is required (see upgrade_url)"},"413":{"description":"Payload too large"},"429":{"description":"Rate or usage limit reached"},"502":{"description":"Generation failed"},"503":{"description":"Temporarily unavailable"}}}},"/muse/v1/actions/create_flashcards":{"post":{"operationId":"create_flashcards","summary":"Turn course material into flashcards with Intoola Study.","description":"Use when a student wants flashcards from their own notes or course material. Returns question/answer cards covering key concepts, definitions, formulas and facts. Requires the student to have an active Intoola Study subscription.","security":[{"intoola":["study:generate"]}],"parameters":[{"name":"Idempotency-Key","in":"header","required":false,"schema":{"type":"string","minLength":8,"maxLength":128},"description":"Optional. Retries with the same key replay the first result."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["material_text"],"properties":{"material_text":{"type":"string","description":"The course material (lecture notes, textbook excerpt, slides text) to study from. Plain text or Markdown.","minLength":40,"maxLength":50000},"additional_instructions":{"type":"string","description":"Optional extra guidance from the student, e.g. topics to emphasise or the exam format.","maxLength":500},"num_flashcards":{"type":"integer","description":"Number of flashcards.","minimum":5,"maximum":40,"default":25}}}}}},"responses":{"200":{"description":"Generated study resource"},"400":{"description":"Invalid parameters"},"401":{"description":"Missing, invalid or expired authorization"},"402":{"description":"An active Intoola Study subscription is required (see upgrade_url)"},"413":{"description":"Payload too large"},"429":{"description":"Rate or usage limit reached"},"502":{"description":"Generation failed"},"503":{"description":"Temporarily unavailable"}}}},"/muse/v1/actions/create_study_guide":{"post":{"operationId":"create_study_guide","summary":"Create a study guide from course material with Intoola Study.","description":"Use when a student wants a structured study guide (study notes with key terms and a summary) built from their own course material to prepare for an exam. Returns Markdown. Requires the student to have an active Intoola Study subscription.","security":[{"intoola":["study:generate"]}],"parameters":[{"name":"Idempotency-Key","in":"header","required":false,"schema":{"type":"string","minLength":8,"maxLength":128},"description":"Optional. Retries with the same key replay the first result."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["material_text"],"properties":{"material_text":{"type":"string","description":"The course material (lecture notes, textbook excerpt, slides text) to study from. Plain text or Markdown.","minLength":40,"maxLength":50000},"additional_instructions":{"type":"string","description":"Optional extra guidance from the student, e.g. topics to emphasise or the exam format.","maxLength":500}}}}}},"responses":{"200":{"description":"Generated study resource"},"400":{"description":"Invalid parameters"},"401":{"description":"Missing, invalid or expired authorization"},"402":{"description":"An active Intoola Study subscription is required (see upgrade_url)"},"413":{"description":"Payload too large"},"429":{"description":"Rate or usage limit reached"},"502":{"description":"Generation failed"},"503":{"description":"Temporarily unavailable"}}}}},"components":{"securitySchemes":{"intoola":{"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://socrian.socrianstudyassistant.workers.dev/oauth/authorize","tokenUrl":"https://socrian.socrianstudyassistant.workers.dev/oauth/token","refreshUrl":"https://socrian.socrianstudyassistant.workers.dev/oauth/token","scopes":{"study:generate":"Create practice exams, flashcards and study guides from material you provide.","account:status":"See whether your Intoola Study subscription is active."}}}}}}}