{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"StudyFetch","colors":{"primary":"#4F46E5","light":"#818CF8","dark":"#3730A3"},"logo":{"light":"https://mintcdn.com/studyfetch/CQRvQEWVGA3CHAKn/logo/light.svg?fit=max\u0026auto=format\u0026n=CQRvQEWVGA3CHAKn\u0026q=85\u0026s=c79964d0b112ad9c8b58569c43aa3a4f","dark":"https://mintcdn.com/studyfetch/CQRvQEWVGA3CHAKn/logo/dark.svg?fit=max\u0026auto=format\u0026n=CQRvQEWVGA3CHAKn\u0026q=85\u0026s=5fee1a6f977862d86933fc5eec24df60"},"favicon":"https://mintcdn.com/studyfetch/jOnyPtbzZQFAjP93/favicon-32x32.png?fit=max\u0026auto=format\u0026n=jOnyPtbzZQFAjP93\u0026q=85\u0026s=7b1cac27c13466a6c7bc7f4f80fb6fd1","api":{"playground":{"display":"interactive"},"examples":{"languages":["javascript","curl","python"]}},"navbar":{"primary":{"type":"button","label":"Try StudyFetch","href":"https://studyfetch.com/platform"}},"footer":{"socials":{"twitter":"https://twitter.com/studyfetch","instagram":"https://instagram.com/studyfetch","linkedin":"https://linkedin.com/company/studyfetch"}},"contextual":{"options":["copy","view","chatgpt","claude","perplexity","grok","mcp","cursor","vscode"],"display":"header"},"styling":{"latex":false},"navigation":{"global":{"anchors":[{"anchor":"StudyFetch Website","icon":"book-open-cover","href":"https://studyfetch.com"},{"anchor":"Use Platform","icon":"rocket","href":"https://studyfetch.com/platform"},{"anchor":"Blog","icon":"newspaper","href":"https://studyfetch.com/blog"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"studyfetch","hasAudioNarration":false,"actualSubdomain":"studyfetch","customDomains":["www.studyfetch.com","imagineexplainers.com"],"gitSource":{"type":"github","owner":"gostudyfetchgo","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6a3c3c437b6d498d08ec381f","collectionId":"88c0fd49-342e-4dc9-a6c1-42bf0cee6fdb","schemaVersion":"v2"},"feedback":{"thumbs":true,"edits":true,"issues":true},"entitlements":{"AI_CHAT":{"status":"DISABLED"}},"buildId":"6ae925a41df85160c46142cd:success","clientVersion":"0.0.4067","searchFilterCounts":[{"language":"default","tag":"StudyFetch API","count":77},{"language":"default","tag":"REST API","count":54},{"language":"default","tag":"Materials","count":25},{"language":"default","tag":"Component API","count":23},{"language":"default","tag":"Tutorials","count":17},{"language":"default","tag":"All Tutorials","count":16},{"language":"default","tag":"Support","count":11},{"language":"default","tag":"All Support","count":11},{"language":"default","tag":"Org Analytics API","count":10},{"language":"default","tag":"Platform Usage API","count":10}]},"assistantConfig":{"enableStarterQuestions":false,"deflection":{"enabled":true,"email":"support@studyfetch.com","showHelpButton":true}},"basePath":"/docs","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/components/create-a-new-component","slug":"/api-reference/components/create-a-new-component","pageMetadata":{"title":"Create a new component","description":null,"deprecated":null,"version":null,"openapi":"/openapi-components.json post /api/v1/components","href":"/api-reference/components/create-a-new-component","autogeneratedByOpenApi":true},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Create a new component","description":null,"deprecated":null,"version":null,"openapi":"/openapi-components.json post /api/v1/components","href":"/api-reference/components/create-a-new-component","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/docs/_mintlify/custom/studyfetch/65db80c016c8f478/download-images.js"],"openApiReferenceData":{"operation":{"operationId":"create","summary":"Create a new component","parameters":[],"requestBody":"4f8d8d37-2d6c-4fd1-a64a-bce70532f6f6","responses":{"201":"2bdebd05-cd72-4044-ad28-6290aca7005d"},"tags":["Components"],"security":["f00497a3-c719-4e3e-aa6a-935ca01e7b68"],"method":"post","type":"path","servers":["fb4f65aa-537f-4d04-980c-e7c7ec7e8311"],"path":"/api/v1/components","baseUrlOptions":["https://studyfetchapi.com"],"title":"Create a new component","description":"","codeSamples":[],"requestExampleLanguages":["javascript","bash","python"],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string","enum":["chat","data_analyst","flashcards","scenarios","practice_test","audio_recap","tutor_me","explainers","uploads","chat_analytics"],"description":"Type of component to create","isRequired":true,"uniqueKey":"type","typeLabel":"enum\u003cstring>"},"name":{"type":"string","example":"My Study Component","description":"Name of the component","isRequired":true,"uniqueKey":"name","typeLabel":"string"},"config":{"oneOf":[{"type":"object","description":"Component-specific configuration","required":["model"],"properties":{"model":{"type":"string","example":"gpt-4o-mini-2024-07-18","description":"AI model to use","isRequired":true,"uniqueKey":"config.oneOf.0.model","typeLabel":"string"},"materials":{"description":"Material IDs","type":"array","items":{"type":"string","uniqueKey":"config.oneOf.0.materials.items.[INDEX]","typeLabel":"string"},"uniqueKey":"config.oneOf.0.materials","typeLabel":"string[]"},"folders":{"description":"Folder IDs","type":"array","items":{"type":"string","uniqueKey":"config.oneOf.0.folders.items.[INDEX]","typeLabel":"string"},"uniqueKey":"config.oneOf.0.folders","typeLabel":"string[]"},"systemPrompt":{"type":"string","description":"System prompt for the chat","uniqueKey":"config.oneOf.0.systemPrompt","typeLabel":"string"},"temperature":{"type":"number","minimum":0,"maximum":2,"description":"Temperature for response generation","uniqueKey":"config.oneOf.0.temperature","typeLabel":"number"},"maxTokens":{"type":"number","description":"Maximum tokens for response","uniqueKey":"config.oneOf.0.maxTokens","typeLabel":"number"},"enableWebSearch":{"type":"boolean","description":"Enable web search","uniqueKey":"config.oneOf.0.enableWebSearch","typeLabel":"boolean"},"enableRAGSearch":{"type":"boolean","description":"Enable RAG search","uniqueKey":"config.oneOf.0.enableRAGSearch","typeLabel":"boolean"},"enableHistory":{"type":"boolean","description":"Enable conversation history","uniqueKey":"config.oneOf.0.enableHistory","typeLabel":"boolean"},"enableVoice":{"type":"boolean","description":"Enable voice interactions","uniqueKey":"config.oneOf.0.enableVoice","typeLabel":"boolean"},"enableFollowUps":{"type":"boolean","description":"Enable follow-up questions","uniqueKey":"config.oneOf.0.enableFollowUps","typeLabel":"boolean"},"enableComponentCreation":{"type":"boolean","description":"Enable component creation","uniqueKey":"config.oneOf.0.enableComponentCreation","typeLabel":"boolean"},"maxSteps":{"type":"number","description":"Maximum steps for multi-step tool calls","uniqueKey":"config.oneOf.0.maxSteps","typeLabel":"number"},"enableGuardrails":{"type":"boolean","description":"Enable guardrails for content moderation","uniqueKey":"config.oneOf.0.enableGuardrails","typeLabel":"boolean"},"enableMessageGrading":{"type":"boolean","description":"Enable message grading for prompt improvement suggestions","default":true,"uniqueKey":"config.oneOf.0.enableMessageGrading","typeLabel":"boolean"},"guardrailRules":{"description":"Guardrail rules for content moderation","example":[{"id":"rule-1","description":"No direct homework answers","condition":"The AI response provides direct answers to homework","action":"block","message":"I cannot provide direct answers to homework questions."}],"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier for the rule","isRequired":true,"uniqueKey":"config.oneOf.0.guardrailRules.items.[INDEX].id","typeLabel":"string"},"description":{"type":"string","description":"Description of the rule","isRequired":true,"uniqueKey":"config.oneOf.0.guardrailRules.items.[INDEX].description","typeLabel":"string"},"condition":{"type":"string","description":"Condition to check","isRequired":true,"uniqueKey":"config.oneOf.0.guardrailRules.items.[INDEX].condition","typeLabel":"string"},"action":{"type":"string","enum":["block","warn","modify"],"description":"Action to take when rule is triggered","isRequired":true,"uniqueKey":"config.oneOf.0.guardrailRules.items.[INDEX].action","typeLabel":"enum\u003cstring>"},"message":{"type":"string","description":"Message to show when rule is triggered","uniqueKey":"config.oneOf.0.guardrailRules.items.[INDEX].message","typeLabel":"string"}},"required":["id","description","condition","action"],"uniqueKey":"config.oneOf.0.guardrailRules.items.[INDEX]","typeLabel":"object"},"uniqueKey":"config.oneOf.0.guardrailRules","typeLabel":"object[]"},"enableReferenceMode":{"type":"boolean","description":"Enable reference mode - show references instead of source content","uniqueKey":"config.oneOf.0.enableReferenceMode","typeLabel":"boolean"}},"isRequired":true,"uniqueKey":"config.oneOf.0","typeLabel":"object"},{"type":"object","description":"Component-specific configuration","required":["model"],"properties":{"model":{"type":"string","example":"gpt-4o-mini-2024-07-18","description":"AI model to use","isRequired":true,"uniqueKey":"config.oneOf.1.model","typeLabel":"string"},"materials":{"description":"Material IDs","type":"array","items":{"type":"string","uniqueKey":"config.oneOf.1.materials.items.[INDEX]","typeLabel":"string"},"uniqueKey":"config.oneOf.1.materials","typeLabel":"string[]"},"folders":{"description":"Folder IDs","type":"array","items":{"type":"string","uniqueKey":"config.oneOf.1.folders.items.[INDEX]","typeLabel":"string"},"uniqueKey":"config.oneOf.1.folders","typeLabel":"string[]"},"systemPrompt":{"type":"string","description":"System prompt for the data analyst","uniqueKey":"config.oneOf.1.systemPrompt","typeLabel":"string"},"temperature":{"type":"number","minimum":0,"maximum":2,"description":"Temperature for response generation","uniqueKey":"config.oneOf.1.temperature","typeLabel":"number"},"maxTokens":{"type":"number","description":"Maximum tokens for response","uniqueKey":"config.oneOf.1.maxTokens","typeLabel":"number"},"enableWebSearch":{"type":"boolean","description":"Enable web search","uniqueKey":"config.oneOf.1.enableWebSearch","typeLabel":"boolean"},"enableRAGSearch":{"type":"boolean","description":"Enable RAG search","uniqueKey":"config.oneOf.1.enableRAGSearch","typeLabel":"boolean"},"enableHistory":{"type":"boolean","description":"Enable conversation history","uniqueKey":"config.oneOf.1.enableHistory","typeLabel":"boolean"},"enableVoice":{"type":"boolean","description":"Enable voice interactions","uniqueKey":"config.oneOf.1.enableVoice","typeLabel":"boolean"},"enableFollowUps":{"type":"boolean","description":"Enable follow-up questions","uniqueKey":"config.oneOf.1.enableFollowUps","typeLabel":"boolean"},"enableComponentCreation":{"type":"boolean","description":"Enable component creation","uniqueKey":"config.oneOf.1.enableComponentCreation","typeLabel":"boolean"},"maxSteps":{"type":"number","description":"Maximum steps for multi-step tool calls","uniqueKey":"config.oneOf.1.maxSteps","typeLabel":"number"},"groupIds":{"description":"Group IDs to filter data","type":"array","items":{"type":"string","uniqueKey":"config.oneOf.1.groupIds.items.[INDEX]","typeLabel":"string"},"uniqueKey":"config.oneOf.1.groupIds","typeLabel":"string[]"}},"isRequired":true,"uniqueKey":"config.oneOf.1","typeLabel":"object"},{"type":"object","description":"Component-specific configuration","properties":{"materials":{"description":"Material IDs","type":"array","items":{"type":"string","uniqueKey":"config.oneOf.2.materials.items.[INDEX]","typeLabel":"string"},"uniqueKey":"config.oneOf.2.materials","typeLabel":"string[]"},"folders":{"description":"Folder IDs","type":"array","items":{"type":"string","uniqueKey":"config.oneOf.2.folders.items.[INDEX]","typeLabel":"string"},"uniqueKey":"config.oneOf.2.folders","typeLabel":"string[]"},"model":{"type":"string","description":"AI model to use for flashcard generation","example":"gpt-4o-mini-2024-07-18","uniqueKey":"config.oneOf.2.model","typeLabel":"string"},"difficulty":{"type":"string","enum":["easy","medium","hard","mixed"],"description":"Difficulty level","uniqueKey":"config.oneOf.2.difficulty","typeLabel":"enum\u003cstring>"},"totalFlashcards":{"type":"number","description":"Total number of flashcards to generate","uniqueKey":"config.oneOf.2.totalFlashcards","typeLabel":"number"},"viewMode":{"type":"string","enum":["spaced_repetition","normal"],"description":"View mode for flashcards","uniqueKey":"config.oneOf.2.viewMode","typeLabel":"enum\u003cstring>"},"cardTypes":{"description":"Types of flashcards","type":"array","items":{"type":"string","uniqueKey":"config.oneOf.2.cardTypes.items.[INDEX]","typeLabel":"string"},"uniqueKey":"config.oneOf.2.cardTypes","typeLabel":"string[]"},"maxReviewInterval":{"type":"number","description":"Maximum review interval in days","uniqueKey":"config.oneOf.2.maxReviewInterval","typeLabel":"number"},"learningSteps":{"type":"string","description":"Learning steps configuration","uniqueKey":"config.oneOf.2.learningSteps","typeLabel":"string"}},"isRequired":true,"uniqueKey":"config.oneOf.2","typeLabel":"object"},{"type":"object","description":"Component-specific configuration","properties":{"materials":{"description":"Material IDs","type":"array","items":{"type":"string","uniqueKey":"config.oneOf.3.materials.items.[INDEX]","typeLabel":"string"},"uniqueKey":"config.oneOf.3.materials","typeLabel":"string[]"},"folders":{"description":"Folder IDs","type":"array","items":{"type":"string","uniqueKey":"config.oneOf.3.folders.items.[INDEX]","typeLabel":"string"},"uniqueKey":"config.oneOf.3.folders","typeLabel":"string[]"},"model":{"type":"string","description":"AI model to use for scenario generation","example":"gpt-4o-mini-2024-07-18","uniqueKey":"config.oneOf.3.model","typeLabel":"string"},"context":{"type":"string","description":"Scenario context","uniqueKey":"config.oneOf.3.context","typeLabel":"string"},"goal":{"type":"string","description":"Scenario goal","uniqueKey":"config.oneOf.3.goal","typeLabel":"string"},"format":{"type":"string","description":"Scenario format","uniqueKey":"config.oneOf.3.format","typeLabel":"string"},"greetingMessage":{"type":"string","description":"Greeting message","uniqueKey":"config.oneOf.3.greetingMessage","typeLabel":"string"},"greetingCharacterId":{"type":"string","description":"Character ID for greeting","uniqueKey":"config.oneOf.3.greetingCharacterId","typeLabel":"string"},"requiresFinalAnswer":{"type":"boolean","description":"Requires final answer","uniqueKey":"config.oneOf.3.requiresFinalAnswer","typeLabel":"boolean"},"finalAnswerPrompt":{"type":"string","description":"Final answer prompt","uniqueKey":"config.oneOf.3.finalAnswerPrompt","typeLabel":"string"},"characters":{"description":"Scenario characters","type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Character ID","isRequired":true,"uniqueKey":"config.oneOf.3.characters.items.[INDEX].id","typeLabel":"string"},"name":{"type":"string","description":"Character name","isRequired":true,"uniqueKey":"config.oneOf.3.characters.items.[INDEX].name","typeLabel":"string"},"role":{"type":"string","description":"Character role","isRequired":true,"uniqueKey":"config.oneOf.3.characters.items.[INDEX].role","typeLabel":"string"},"description":{"type":"string","description":"Character description","uniqueKey":"config.oneOf.3.characters.items.[INDEX].description","typeLabel":"string"}},"required":["id","name","role"],"uniqueKey":"config.oneOf.3.characters.items.[INDEX]","typeLabel":"object"},"uniqueKey":"config.oneOf.3.characters","typeLabel":"object[]"},"tools":{"description":"Available tools","type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Tool ID","isRequired":true,"uniqueKey":"config.oneOf.3.tools.items.[INDEX].id","typeLabel":"string"},"name":{"type":"string","description":"Tool name","isRequired":true,"uniqueKey":"config.oneOf.3.tools.items.[INDEX].name","typeLabel":"string"},"description":{"type":"string","description":"Tool description (what it does / shows)","isRequired":true,"uniqueKey":"config.oneOf.3.tools.items.[INDEX].description","typeLabel":"string"},"type":{"type":"string","description":"Tool type (e.g. Database, Document)","isRequired":true,"uniqueKey":"config.oneOf.3.tools.items.[INDEX].type","typeLabel":"string"},"dataFormat":{"type":"string","description":"Data format provided by the tool","uniqueKey":"config.oneOf.3.tools.items.[INDEX].dataFormat","typeLabel":"string"}},"required":["id","name","description","type"],"uniqueKey":"config.oneOf.3.tools.items.[INDEX]","typeLabel":"object"},"uniqueKey":"config.oneOf.3.tools","typeLabel":"object[]"},"criteria":{"description":"Authored evaluation criteria. If omitted or empty at create time, the AI will generate criteria.","type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Stable identifier for this criterion","isRequired":true,"uniqueKey":"config.oneOf.3.criteria.items.[INDEX].id","typeLabel":"string"},"description":{"type":"string","description":"What this criterion measures","isRequired":true,"uniqueKey":"config.oneOf.3.criteria.items.[INDEX].description","typeLabel":"string"},"weight":{"type":"number","minimum":1,"maximum":10,"description":"Importance weight 1-10","isRequired":true,"uniqueKey":"config.oneOf.3.criteria.items.[INDEX].weight","typeLabel":"number"}},"required":["id","description","weight"],"uniqueKey":"config.oneOf.3.criteria.items.[INDEX]","typeLabel":"object"},"uniqueKey":"config.oneOf.3.criteria","typeLabel":"object[]"},"enableHistory":{"type":"boolean","description":"Enable history","uniqueKey":"config.oneOf.3.enableHistory","typeLabel":"boolean"},"enableVoice":{"type":"boolean","description":"Enable voice","uniqueKey":"config.oneOf.3.enableVoice","typeLabel":"boolean"},"placeholderText":{"type":"string","description":"Placeholder text","uniqueKey":"config.oneOf.3.placeholderText","typeLabel":"string"}},"isRequired":true,"uniqueKey":"config.oneOf.3","typeLabel":"object"},{"type":"object","description":"Component-specific configuration","required":["questionTypes"],"properties":{"questionTypes":{"description":"Question types","example":["multiplechoice","truefalse"],"type":"array","items":{"type":"string","uniqueKey":"config.oneOf.4.questionTypes.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"config.oneOf.4.questionTypes","typeLabel":"string[]"},"materials":{"description":"Material IDs","type":"array","items":{"type":"string","uniqueKey":"config.oneOf.4.materials.items.[INDEX]","typeLabel":"string"},"uniqueKey":"config.oneOf.4.materials","typeLabel":"string[]"},"folders":{"description":"Folder IDs","type":"array","items":{"type":"string","uniqueKey":"config.oneOf.4.folders.items.[INDEX]","typeLabel":"string"},"uniqueKey":"config.oneOf.4.folders","typeLabel":"string[]"},"model":{"type":"string","description":"AI model to use for question generation and grading","example":"gpt-4o-mini-2024-07-18","uniqueKey":"config.oneOf.4.model","typeLabel":"string"},"questionsPerTest":{"type":"number","description":"Number of questions per test","uniqueKey":"config.oneOf.4.questionsPerTest","typeLabel":"number"},"difficulty":{"type":"string","enum":["easy","medium","hard","mixed"],"description":"Difficulty level","uniqueKey":"config.oneOf.4.difficulty","typeLabel":"enum\u003cstring>"},"timeLimit":{"type":"number","description":"Time limit in minutes","uniqueKey":"config.oneOf.4.timeLimit","typeLabel":"number"},"allowRetakes":{"type":"boolean","description":"Allow retakes","uniqueKey":"config.oneOf.4.allowRetakes","typeLabel":"boolean"},"showCorrectAnswers":{"type":"boolean","description":"Show correct answers after submission","uniqueKey":"config.oneOf.4.showCorrectAnswers","typeLabel":"boolean"},"randomizeQuestions":{"type":"boolean","description":"Randomize question order","uniqueKey":"config.oneOf.4.randomizeQuestions","typeLabel":"boolean"},"randomizeAnswers":{"type":"boolean","description":"Randomize answer order","uniqueKey":"config.oneOf.4.randomizeAnswers","typeLabel":"boolean"},"maxAttempts":{"type":"number","description":"Maximum attempts allowed","uniqueKey":"config.oneOf.4.maxAttempts","typeLabel":"number"},"passingScore":{"type":"number","description":"Passing score percentage","uniqueKey":"config.oneOf.4.passingScore","typeLabel":"number"},"showExplanations":{"type":"boolean","description":"Show explanations for answers","uniqueKey":"config.oneOf.4.showExplanations","typeLabel":"boolean"},"aiGenerationMode":{"type":"string","enum":["balanced","comprehensive","focused","adaptive"],"description":"AI generation mode","uniqueKey":"config.oneOf.4.aiGenerationMode","typeLabel":"enum\u003cstring>"},"questionDistribution":{"type":"object","description":"Distribution of question types","properties":{"multiplechoice":{"type":"number","description":"Number of multiple choice questions","uniqueKey":"config.oneOf.4.questionDistribution.multiplechoice","typeLabel":"number"},"truefalse":{"type":"number","description":"Number of true/false questions","uniqueKey":"config.oneOf.4.questionDistribution.truefalse","typeLabel":"number"},"shortanswer":{"type":"number","description":"Number of short answer questions","uniqueKey":"config.oneOf.4.questionDistribution.shortanswer","typeLabel":"number"},"frq":{"type":"number","description":"Number of free response questions","uniqueKey":"config.oneOf.4.questionDistribution.frq","typeLabel":"number"},"fillinblank":{"type":"number","description":"Number of fill in the blank questions","uniqueKey":"config.oneOf.4.questionDistribution.fillinblank","typeLabel":"number"}},"uniqueKey":"config.oneOf.4.questionDistribution","typeLabel":"object"}},"isRequired":true,"uniqueKey":"config.oneOf.4","typeLabel":"object"},{"type":"object","description":"Component-specific configuration","properties":{"materials":{"description":"Material IDs","type":"array","items":{"type":"string","uniqueKey":"config.oneOf.5.materials.items.[INDEX]","typeLabel":"string"},"uniqueKey":"config.oneOf.5.materials","typeLabel":"string[]"},"folders":{"description":"Folder IDs","type":"array","items":{"type":"string","uniqueKey":"config.oneOf.5.folders.items.[INDEX]","typeLabel":"string"},"uniqueKey":"config.oneOf.5.folders","typeLabel":"string[]"},"excludedMaterialIds":{"description":"Material IDs to exclude when expanding selected folders. Has no effect on materials picked directly via `materials`.","type":"array","items":{"type":"string","uniqueKey":"config.oneOf.5.excludedMaterialIds.items.[INDEX]","typeLabel":"string"},"uniqueKey":"config.oneOf.5.excludedMaterialIds","typeLabel":"string[]"},"duration":{"type":"number","description":"Duration of audio recap in minutes","example":10,"uniqueKey":"config.oneOf.5.duration","typeLabel":"number"},"numParts":{"type":"number","description":"Number of parts to split the audio into","example":5,"uniqueKey":"config.oneOf.5.numParts","typeLabel":"number"},"isMultiVoice":{"type":"boolean","description":"Enable multi-voice conversation mode","uniqueKey":"config.oneOf.5.isMultiVoice","typeLabel":"boolean"},"voice1":{"type":"string","description":"Primary voice for narration","example":"Puck","uniqueKey":"config.oneOf.5.voice1","typeLabel":"string"},"voice2":{"type":"string","description":"Secondary voice for multi-voice mode","example":"Aoede","uniqueKey":"config.oneOf.5.voice2","typeLabel":"string"},"topic":{"type":"string","description":"Specific topic to focus on","uniqueKey":"config.oneOf.5.topic","typeLabel":"string"},"theme":{"type":"string","description":"Theme or style for the audio recap","uniqueKey":"config.oneOf.5.theme","typeLabel":"string"},"model":{"type":"string","description":"AI model to use for generation","example":"gpt-4.1-2025-04-14","uniqueKey":"config.oneOf.5.model","typeLabel":"string"},"recapType":{"type":"string","enum":["SUMMARY","LECTURE","PODCAST","AUDIO_BOOK"],"description":"Type of audio recap","uniqueKey":"config.oneOf.5.recapType","typeLabel":"enum\u003cstring>"}},"isRequired":true,"uniqueKey":"config.oneOf.5","typeLabel":"object"},{"type":"object","description":"Component-specific configuration","properties":{"materials":{"description":"Material IDs","type":"array","items":{"type":"string","uniqueKey":"config.oneOf.6.materials.items.[INDEX]","typeLabel":"string"},"uniqueKey":"config.oneOf.6.materials","typeLabel":"string[]"},"folders":{"description":"Folder IDs","type":"array","items":{"type":"string","uniqueKey":"config.oneOf.6.folders.items.[INDEX]","typeLabel":"string"},"uniqueKey":"config.oneOf.6.folders","typeLabel":"string[]"},"title":{"type":"string","description":"Video title (defaults to component name if not provided)","uniqueKey":"config.oneOf.6.title","typeLabel":"string"},"model":{"type":"string","description":"AI model to use for generation","example":"gpt-4o-mini-2024-07-18","uniqueKey":"config.oneOf.6.model","typeLabel":"string"},"style":{"type":"string","description":"Video style","example":"professional","uniqueKey":"config.oneOf.6.style","typeLabel":"string"},"targetLength":{"type":"number","description":"Target length in seconds","minimum":15,"maximum":1200,"uniqueKey":"config.oneOf.6.targetLength","typeLabel":"number"},"webSearch":{"type":"boolean","description":"Enable web search for additional content","uniqueKey":"config.oneOf.6.webSearch","typeLabel":"boolean"},"imageSearch":{"type":"boolean","description":"Enable image search for visuals","uniqueKey":"config.oneOf.6.imageSearch","typeLabel":"boolean"},"verticalVideo":{"type":"boolean","description":"Create vertical video format (9:16)","uniqueKey":"config.oneOf.6.verticalVideo","typeLabel":"boolean"}},"isRequired":true,"uniqueKey":"config.oneOf.6","typeLabel":"object"},{"type":"object","description":"Component-specific configuration","required":["folderId"],"properties":{"folderId":{"type":"string","description":"Folder ID where uploads will be stored","isRequired":true,"uniqueKey":"config.oneOf.7.folderId","typeLabel":"string"},"materials":{"description":"Material IDs","type":"array","items":{"type":"string","uniqueKey":"config.oneOf.7.materials.items.[INDEX]","typeLabel":"string"},"uniqueKey":"config.oneOf.7.materials","typeLabel":"string[]"},"folders":{"description":"Folder IDs","type":"array","items":{"type":"string","uniqueKey":"config.oneOf.7.folders.items.[INDEX]","typeLabel":"string"},"uniqueKey":"config.oneOf.7.folders","typeLabel":"string[]"}},"isRequired":true,"uniqueKey":"config.oneOf.7","typeLabel":"object"},{"type":"object","description":"Component-specific configuration","properties":{"materials":{"description":"Material IDs","type":"array","items":{"type":"string","uniqueKey":"config.oneOf.8.materials.items.[INDEX]","typeLabel":"string"},"uniqueKey":"config.oneOf.8.materials","typeLabel":"string[]"},"folders":{"description":"Folder IDs","type":"array","items":{"type":"string","uniqueKey":"config.oneOf.8.folders.items.[INDEX]","typeLabel":"string"},"uniqueKey":"config.oneOf.8.folders","typeLabel":"string[]"},"tutorPersonality":{"type":"string","description":"Tutor personality","uniqueKey":"config.oneOf.8.tutorPersonality","typeLabel":"string"},"sessionDuration":{"type":"number","description":"Session duration in minutes","uniqueKey":"config.oneOf.8.sessionDuration","typeLabel":"number"},"enableVideo":{"type":"boolean","description":"Enable video","uniqueKey":"config.oneOf.8.enableVideo","typeLabel":"boolean"},"enableVoice":{"type":"boolean","description":"Enable voice","uniqueKey":"config.oneOf.8.enableVoice","typeLabel":"boolean"}},"isRequired":true,"uniqueKey":"config.oneOf.8","typeLabel":"object"},{"type":"object","description":"Component-specific configuration","required":["chatComponentId"],"properties":{"chatComponentId":{"type":"string","description":"ID of the chat component to analyze","isRequired":true,"uniqueKey":"config.oneOf.9.chatComponentId","typeLabel":"string"},"dateRange":{"type":"number","description":"Default date range in days","default":30,"uniqueKey":"config.oneOf.9.dateRange","typeLabel":"number"},"autoRefresh":{"type":"boolean","description":"Enable auto-refresh","uniqueKey":"config.oneOf.9.autoRefresh","typeLabel":"boolean"},"refreshInterval":{"type":"number","description":"Refresh interval in minutes","minimum":1,"maximum":60,"uniqueKey":"config.oneOf.9.refreshInterval","typeLabel":"number"},"showUserStats":{"type":"boolean","description":"Show user statistics section","default":true,"uniqueKey":"config.oneOf.9.showUserStats","typeLabel":"boolean"},"showSummary":{"type":"boolean","description":"Show summary section","default":true,"uniqueKey":"config.oneOf.9.showSummary","typeLabel":"boolean"},"showTopics":{"type":"boolean","description":"Show top topics","default":true,"uniqueKey":"config.oneOf.9.showTopics","typeLabel":"boolean"},"enableExport":{"type":"boolean","description":"Enable CSV export functionality","default":true,"uniqueKey":"config.oneOf.9.enableExport","typeLabel":"boolean"}},"isRequired":true,"uniqueKey":"config.oneOf.9","typeLabel":"object"}],"isRequired":true,"uniqueKey":"config","typeLabel":"object"},"description":{"type":"string","example":"A component for studying biology","description":"Component description","uniqueKey":"description","typeLabel":"string"},"metadata":{"type":"object","description":"Additional metadata","uniqueKey":"metadata","typeLabel":"object"}},"required":["type","name","config"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"name":"My Study Component","config":{"model":"gpt-4o-mini-2024-07-18","materials":["\u003cstring>"],"folders":["\u003cstring>"],"systemPrompt":"\u003cstring>","temperature":1,"maxTokens":123,"enableWebSearch":true,"enableRAGSearch":true,"enableHistory":true,"enableVoice":true,"enableFollowUps":true,"enableComponentCreation":true,"maxSteps":123,"enableGuardrails":true,"enableMessageGrading":true,"guardrailRules":[{"id":"rule-1","description":"No direct homework answers","condition":"The AI response provides direct answers to homework","action":"block","message":"I cannot provide direct answers to homework questions."}],"enableReferenceMode":true},"description":"A component for studying biology","metadata":{}}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"2bdebd05-cd72-4044-ad28-6290aca7005d":{"description":"Component created successfully","content":{"application/json":{"schema":{"type":"object","properties":{"_id":{"type":"string","description":"Component ID (MongoDB ObjectId)","isRequired":true,"uniqueKey":"_id","typeLabel":"string"},"componentId":{"type":"string","description":"Unique component identifier","isRequired":true,"uniqueKey":"componentId","typeLabel":"string"},"type":{"type":"string","description":"Component type","enum":["chat","data_analyst","flashcards","scenarios","practice_test","audio_recap","tutor_me","explainers","uploads","chat_analytics"],"isRequired":true,"uniqueKey":"type","typeLabel":"enum\u003cstring>"},"name":{"type":"string","description":"Component name","isRequired":true,"uniqueKey":"name","typeLabel":"string"},"organization":{"type":"string","description":"Organization ID","isRequired":true,"uniqueKey":"organization","typeLabel":"string"},"config":{"type":"object","description":"Component configuration","isRequired":true,"uniqueKey":"config","typeLabel":"object"},"status":{"type":"string","description":"Component status","enum":["active","inactive","draft"],"isRequired":true,"uniqueKey":"status","typeLabel":"enum\u003cstring>"},"usage":{"type":"object","description":"Usage statistics","isRequired":true,"uniqueKey":"usage","typeLabel":"object"},"createdAt":{"format":"date-time","type":"string","description":"Creation timestamp","isRequired":true,"uniqueKey":"createdAt","typeLabel":"string\u003cdate-time>"},"updatedAt":{"format":"date-time","type":"string","description":"Last update timestamp","isRequired":true,"uniqueKey":"updatedAt","typeLabel":"string\u003cdate-time>"},"description":{"type":"string","description":"Component description","uniqueKey":"description","typeLabel":"string"}},"required":["_id","componentId","type","name","organization","config","status","usage","createdAt","updatedAt"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"_id":"\u003cstring>","componentId":"\u003cstring>","type":"chat","name":"\u003cstring>","organization":"\u003cstring>","config":{},"status":"active","usage":{},"createdAt":"2023-11-07T05:31:56Z","updatedAt":"2023-11-07T05:31:56Z","description":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"f00497a3-c719-4e3e-aa6a-935ca01e7b68":{"x-api-key":{"type":"apiKey","in":"header","name":"x-api-key","description":"API Key for server-to-server authentication. Resolves to the owning organization.","scopes":[]}}},"servers":{"fb4f65aa-537f-4d04-980c-e7c7ec7e8311":{"url":"https://studyfetchapi.com","description":"Production API Server"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","in":"header","name":"x-api-key","description":"API Key for server-to-server authentication. Resolves to the owning organization.","scopes":[]},"schema":{"title":"x-api-key","type":"string","description":"API Key for server-to-server authentication. Resolves to the owning organization.","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"x-api-key","name":"x-api-key"}],"title":"x-api-key"}]},"originalFileLocation":"openapi-components.json"},"subdomain":"studyfetch","siteName":"StudyFetch","title":"Create a new component - StudyFetch","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-06-24T20:21:32.132Z","originalFileLocation":"api-reference/components/create-a-new-component.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"application-name\" content=\"StudyFetch\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/docs/mintlify-assets/_mintlify/favicons/studyfetch/16lQJOsSjgVNDxpq/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/docs/mintlify-assets/_mintlify/favicons/studyfetch/16lQJOsSjgVNDxpq/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/docs/mintlify-assets/_mintlify/favicons/studyfetch/16lQJOsSjgVNDxpq/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/docs/mintlify-assets/_mintlify/favicons/studyfetch/16lQJOsSjgVNDxpq/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/docs/mintlify-assets/_mintlify/favicons/studyfetch/16lQJOsSjgVNDxpq/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/docs/mintlify-assets/_mintlify/favicons/studyfetch/16lQJOsSjgVNDxpq/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/docs/mintlify-assets/_mintlify/favicons/studyfetch/16lQJOsSjgVNDxpq/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/docs/mintlify-assets/_mintlify/favicons/studyfetch/16lQJOsSjgVNDxpq/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/docs/mintlify-assets/_mintlify/favicons/studyfetch/16lQJOsSjgVNDxpq/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Create a new component - StudyFetch\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"StudyFetch\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://www.studyfetch.com/docs/api-reference/components/create-a-new-component\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://studyfetch.mintlify.app/_mintlify/api/og/v2?division=Components\u0026amp;title=Create+a+new+component\u0026amp;theme=85141dfe5c502fd07920b27a\u0026amp;signature=052c31fef3c958700b2d81eb033f50c9729c2e5c4fe188c5c733f79d22fe1b1c\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Create a new component - StudyFetch\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://studyfetch.mintlify.app/_mintlify/api/og/v2?division=Components\u0026amp;title=Create+a+new+component\u0026amp;theme=85141dfe5c502fd07920b27a\u0026amp;signature=052c31fef3c958700b2d81eb033f50c9729c2e5c4fe188c5c733f79d22fe1b1c\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/docs/mintlify-assets/_mintlify/favicons/studyfetch/16lQJOsSjgVNDxpq/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"StudyFetch\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#4F46E5\">\u003clink data-mint-head rel=\"canonical\" href=\"https://www.studyfetch.com/docs/api-reference/components/create-a-new-component\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/docs/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/docs/api-reference/components/create-a-new-component.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://www.studyfetch.com/#organization\",\"name\":\"StudyFetch\",\"url\":\"https://www.studyfetch.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/studyfetch/CQRvQEWVGA3CHAKn/logo/light.svg?fit=max\u0026auto=format\u0026n=CQRvQEWVGA3CHAKn\u0026q=85\u0026s=c79964d0b112ad9c8b58569c43aa3a4f\"}},{\"@type\":\"WebSite\",\"@id\":\"https://www.studyfetch.com/docs#website\",\"name\":\"StudyFetch\",\"url\":\"https://www.studyfetch.com/docs\",\"publisher\":{\"@id\":\"https://www.studyfetch.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://www.studyfetch.com/docs/api-reference/components/create-a-new-component#webpage\",\"url\":\"https://www.studyfetch.com/docs/api-reference/components/create-a-new-component\",\"name\":\"Create a new component\",\"dateModified\":\"2026-06-24T20:21:32.132Z\",\"isPartOf\":{\"@id\":\"https://www.studyfetch.com/docs#website\"},\"breadcrumb\":{\"@id\":\"https://www.studyfetch.com/docs/api-reference/components/create-a-new-component#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://www.studyfetch.com/docs/api-reference/components/create-a-new-component#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"REST API\",\"item\":\"https://www.studyfetch.com/docs/api-reference/materials/get-all-materials-for-organization\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Components\",\"item\":\"https://www.studyfetch.com/docs/api-reference/components/get-all-components\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Create a new component\",\"item\":\"https://www.studyfetch.com/docs/api-reference/components/create-a-new-component\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://www.studyfetch.com/docs/api-reference/components/create-a-new-component#apireference\",\"headline\":\"Create a new component\",\"name\":\"Create a new component\",\"url\":\"https://www.studyfetch.com/docs/api-reference/components/create-a-new-component\",\"mainEntityOfPage\":{\"@id\":\"https://www.studyfetch.com/docs/api-reference/components/create-a-new-component#webpage\"},\"dateModified\":\"2026-06-24T20:21:32.132Z\",\"publisher\":{\"@id\":\"https://www.studyfetch.com/#organization\"},\"isPartOf\":{\"@id\":\"https://www.studyfetch.com/docs#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"StudyFetch\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"StudyFetch","nav":{"global":{"anchors":[{"anchor":"StudyFetch Website","icon":"book-open-cover","href":"https://studyfetch.com"},{"anchor":"Use Platform","icon":"rocket","href":"https://studyfetch.com/platform"},{"anchor":"Blog","icon":"newspaper","href":"https://studyfetch.com/blog"}]},"tabs":[{"tab":"Tutorials","pages":[{"title":"Tutorials","href":"/tutorial-doc-format/full-tutorial"}]},{"tab":"Org Analytics API","pages":[{"title":"Org Analytics API","href":"/api-docs/chat"}]},{"tab":"Support","pages":[{"title":"Support","href":"/support-pages/contactsupport"}]},{"tab":"StudyFetch API","groups":[{"group":"Component API","pages":[{"title":"Introduction","href":"/components/introduction"},{"title":"Authentication","href":"/components/authentication"},{"title":"Changelog","href":"/changelog"},{"title":"Quickstart","href":"/components/quickstart"},{"group":"Materials","pages":[{"title":"Materials API Overview","icon":"folder","href":"/api-docs/materials/overview"},{"title":"Uploading Files","icon":"upload","href":"/api-docs/materials/uploading-files"},{"title":"Managing Materials","icon":"folder-gear","href":"/api-docs/materials/managing-materials"},{"title":"Generating Materials","icon":"sparkles","href":"/api-docs/materials/generating-materials"},{"title":"Working with Folders","icon":"folder-tree","href":"/api-docs/materials/folders"},{"title":"Search Materials","icon":"magnifying-glass","href":"/api-docs/materials/search"}]},{"group":"Component API Reference","pages":[{"title":"Chat","icon":"comments","href":"/api-docs/components/chat"},{"title":"Data Analyst","icon":"chart-line","href":"/api-docs/components/data-analyst"},{"title":"Flashcards","icon":"cards","href":"/api-docs/components/flashcards"},{"title":"Practice Test","icon":"file-pen","href":"/api-docs/components/practice-test"},{"title":"Scenarios","icon":"route","href":"/api-docs/components/scenarios"},{"title":"Audio Recap","icon":"headphones","href":"/api-docs/components/audio-recap"},{"title":"Explainers","icon":"presentation-screen","href":"/api-docs/components/explainers"},{"title":"Client Uploads","icon":"upload","href":"/api-docs/components/uploads"},{"title":"Chat Analytics","icon":"chart-mixed","href":"/api-docs/components/chat-analytics"}]},{"title":"User \u0026 Usage Tracking","href":"/api-docs/user-tracking"},{"title":"Assignment Grader","href":"/api-docs/assignment-grader"},{"title":"Chat Analytics API","href":"/api-docs/chat-analytics"},{"title":"PDF Generator","href":"/api-docs/pdf-generator"}]},{"group":"REST API","pages":[{"group":"Materials","pages":[{"title":"Get all materials for organization","deprecated":null,"version":null,"openapi":"/openapi-components.json get /api/v1/materials","href":"/api-reference/materials/get-all-materials-for-organization"},{"title":"Create a new material","deprecated":null,"version":null,"openapi":"/openapi-components.json post /api/v1/materials","href":"/api-reference/materials/create-a-new-material"},{"title":"Generate material from a topic","deprecated":null,"version":null,"openapi":"/openapi-components.json post /api/v1/materials/generate","href":"/api-reference/materials/generate-material-from-a-topic"},{"title":"Generate and process material from a topic","deprecated":null,"version":null,"openapi":"/openapi-components.json post /api/v1/materials/generate-and-process","href":"/api-reference/materials/generate-and-process-material-from-a-topic"},{"title":"Upload a material file","deprecated":null,"version":null,"openapi":"/openapi-components.json post /api/v1/materials/upload","href":"/api-reference/materials/upload-a-material-file"},{"title":"Upload material from URL","deprecated":null,"version":null,"openapi":"/openapi-components.json post /api/v1/materials/upload/url","href":"/api-reference/materials/upload-material-from-url"},{"title":"Create material and wait for processing to complete","deprecated":null,"version":null,"openapi":"/openapi-components.json post /api/v1/materials/upload-and-process","href":"/api-reference/materials/create-material-and-wait-for-processing-to-complete"},{"title":"Upload material file and wait for processing to complete","deprecated":null,"version":null,"openapi":"/openapi-components.json post /api/v1/materials/upload/file-and-process","href":"/api-reference/materials/upload-material-file-and-wait-for-processing-to-complete"},{"title":"Upload material from URL and wait for processing to complete","deprecated":null,"version":null,"openapi":"/openapi-components.json post /api/v1/materials/upload/url-and-process","href":"/api-reference/materials/upload-material-from-url-and-wait-for-processing-to-complete"},{"title":"Get presigned URL for direct S3 upload","deprecated":null,"version":null,"openapi":"/openapi-components.json post /api/v1/materials/upload/presigned-url","href":"/api-reference/materials/get-presigned-url-for-direct-s3-upload"},{"title":"Complete upload after using presigned URL","deprecated":null,"version":null,"openapi":"/openapi-components.json post /api/v1/materials/upload/complete","href":"/api-reference/materials/complete-upload-after-using-presigned-url"},{"title":"Create batch upload URLs for multiple materials","deprecated":null,"version":null,"openapi":"/openapi-components.json post /api/v1/materials/batch","href":"/api-reference/materials/create-batch-upload-urls-for-multiple-materials"},{"title":"Get material by ID","deprecated":null,"version":null,"openapi":"/openapi-components.json get /api/v1/materials/{id}","href":"/api-reference/materials/get-material-by-id"},{"title":"Delete material","deprecated":null,"version":null,"openapi":"/openapi-components.json delete /api/v1/materials/{id}","href":"/api-reference/materials/delete-material"},{"title":"Update a material","deprecated":null,"version":null,"openapi":"/openapi-components.json patch /api/v1/materials/{id}","href":"/api-reference/materials/update-a-material"},{"title":"Bulk move materials to a different folder","deprecated":null,"version":null,"openapi":"/openapi-components.json post /api/v1/materials/bulk/move","href":"/api-reference/materials/bulk-move-materials-to-a-different-folder"},{"title":"Move material to a different folder","deprecated":null,"version":null,"openapi":"/openapi-components.json post /api/v1/materials/{id}/move","href":"/api-reference/materials/move-material-to-a-different-folder"},{"title":"Rename a material","deprecated":null,"version":null,"openapi":"/openapi-components.json post /api/v1/materials/{id}/rename","href":"/api-reference/materials/rename-a-material"},{"title":"Search for materials","deprecated":null,"version":null,"openapi":"/openapi-components.json post /api/v1/materials/search","href":"/api-reference/materials/search-for-materials"}]},{"group":"Folders","pages":[{"title":"Get all folders","deprecated":null,"version":null,"openapi":"/openapi-components.json get /api/v1/folders","href":"/api-reference/folders/get-all-folders"},{"title":"Create a new folder","deprecated":null,"version":null,"openapi":"/openapi-components.json post /api/v1/folders","href":"/api-reference/folders/create-a-new-folder"},{"title":"Get folder tree structure","deprecated":null,"version":null,"openapi":"/openapi-components.json get /api/v1/folders/tree","href":"/api-reference/folders/get-folder-tree-structure"},{"title":"Get folder by ID","deprecated":null,"version":null,"openapi":"/openapi-components.json get /api/v1/folders/{id}","href":"/api-reference/folders/get-folder-by-id"},{"title":"Delete folder","deprecated":null,"version":null,"openapi":"/openapi-components.json delete /api/v1/folders/{id}","href":"/api-reference/folders/delete-folder"},{"title":"Update folder","deprecated":null,"version":null,"openapi":"/openapi-components.json patch /api/v1/folders/{id}","href":"/api-reference/folders/update-folder"},{"title":"Get all materials in folder","deprecated":null,"version":null,"openapi":"/openapi-components.json get /api/v1/folders/{id}/materials","href":"/api-reference/folders/get-all-materials-in-folder"},{"title":"Move folder to new parent","deprecated":null,"version":null,"openapi":"/openapi-components.json patch /api/v1/folders/{id}/move","href":"/api-reference/folders/move-folder-to-new-parent"}]},{"group":"Components","pages":[{"title":"Get all components","description":null,"deprecated":null,"version":null,"openapi":"/openapi-components.json get /api/v1/components","href":"/api-reference/components/get-all-components"},{"title":"Create a new component","deprecated":null,"version":null,"openapi":"/openapi-components.json post /api/v1/components","href":"/api-reference/components/create-a-new-component"},{"title":"Get component by ID","description":null,"deprecated":null,"version":null,"openapi":"/openapi-components.json get /api/v1/components/{id}","href":"/api-reference/components/get-component-by-id"},{"title":"Delete component","deprecated":null,"version":null,"openapi":"/openapi-components.json delete /api/v1/components/{id}","href":"/api-reference/components/delete-component"},{"title":"Update component","deprecated":null,"version":null,"openapi":"/openapi-components.json patch /api/v1/components/{id}","href":"/api-reference/components/update-component"},{"title":"Generate embed code for component","deprecated":null,"version":null,"openapi":"/openapi-components.json post /api/v1/components/{id}/embed","href":"/api-reference/components/generate-embed-code-for-component"}]},{"group":"Usage Tracking","pages":[{"title":"Get usage events","deprecated":null,"version":null,"openapi":"/openapi-components.json get /api/v1/usage/events","href":"/api-reference/usage-tracking/get-usage-events"},{"title":"Get usage summary","deprecated":null,"version":null,"openapi":"/openapi-components.json get /api/v1/usage/summary","href":"/api-reference/usage-tracking/get-usage-summary"},{"title":"Get usage statistics","deprecated":null,"version":null,"openapi":"/openapi-components.json get /api/v1/usage/stats","href":"/api-reference/usage-tracking/get-usage-statistics"}]},{"group":"Usage Analyst","pages":[{"title":"Get all events based on filters","deprecated":null,"version":null,"openapi":"/openapi-components.json get /api/v1/usage-analyst/events","href":"/api-reference/usage-analyst/get-all-events-based-on-filters"},{"title":"Get test results with full question data for user or group","deprecated":null,"version":null,"openapi":"/openapi-components.json get /api/v1/usage-analyst/test-questions","href":"/api-reference/usage-analyst/get-test-results-with-full-question-data-for-user-or-group"},{"title":"Get all chat messages from sessions for user or group","deprecated":null,"version":null,"openapi":"/openapi-components.json get /api/v1/usage-analyst/chat-messages","href":"/api-reference/usage-analyst/get-all-chat-messages-from-sessions-for-user-or-group"}]},{"group":"Embed","pages":[{"title":"Verify embed token","deprecated":null,"version":null,"openapi":"/openapi-components.json get /api/v1/embed/verify","href":"/api-reference/embed/verify-embed-token"},{"title":"Get component data for embed","deprecated":null,"version":null,"openapi":"/openapi-components.json get /api/v1/embed/component/{componentId}","href":"/api-reference/embed/get-component-data-for-embed"}]},{"group":"Chat","pages":[{"title":"Stream chat response","deprecated":null,"version":null,"openapi":"/openapi-components.json post /api/v1/chat/stream","href":"/api-reference/chat/stream-chat-response"}]},{"group":"Chat Analytics","pages":[{"title":"Get chat analytics and user statistics","deprecated":null,"version":null,"openapi":"/openapi-components.json get /api/v1/chat-analytics/analyze","href":"/api-reference/chat-analytics/get-chat-analytics-and-user-statistics"},{"title":"Get chat analytics for a specific component","deprecated":null,"version":null,"openapi":"/openapi-components.json get /api/v1/chat-analytics/component/{componentId}","href":"/api-reference/chat-analytics/get-chat-analytics-for-a-specific-component"},{"title":"Export chat analytics data as CSV","deprecated":null,"version":null,"openapi":"/openapi-components.json get /api/v1/chat-analytics/export","href":"/api-reference/chat-analytics/export-chat-analytics-data-as-csv"}]},{"group":"Assignment Grader","pages":[{"title":"Grade a new assignment","deprecated":null,"version":null,"openapi":"/openapi-components.json post /api/v1/assignment-grader/create","href":"/api-reference/assignment-grader/grade-a-new-assignment"},{"title":"List all graded assignments","deprecated":null,"version":null,"openapi":"/openapi-components.json get /api/v1/assignment-grader/get","href":"/api-reference/assignment-grader/list-all-graded-assignments"},{"title":"Get a graded assignment by ID","deprecated":null,"version":null,"openapi":"/openapi-components.json get /api/v1/assignment-grader/get/{id}","href":"/api-reference/assignment-grader/get-a-graded-assignment-by-id"},{"title":"Delete a graded assignment by ID","deprecated":null,"version":null,"openapi":"/openapi-components.json delete /api/v1/assignment-grader/delete/{id}","href":"/api-reference/assignment-grader/delete-a-graded-assignment-by-id"},{"title":"List all rubric templates","deprecated":null,"version":null,"openapi":"/openapi-components.json get /api/v1/assignment-grader/rubric-templates","href":"/api-reference/assignment-grader/list-all-rubric-templates"},{"title":"Create a new rubric template","deprecated":null,"version":null,"openapi":"/openapi-components.json post /api/v1/assignment-grader/rubric-templates","href":"/api-reference/assignment-grader/create-a-new-rubric-template"},{"title":"Get a rubric template by ID","deprecated":null,"version":null,"openapi":"/openapi-components.json get /api/v1/assignment-grader/rubric-templates/{id}","href":"/api-reference/assignment-grader/get-a-rubric-template-by-id"},{"title":"Delete a rubric template by ID","deprecated":null,"version":null,"openapi":"/openapi-components.json delete /api/v1/assignment-grader/rubric-templates/{id}","href":"/api-reference/assignment-grader/delete-a-rubric-template-by-id"},{"title":"Generate educator report for an assignment","deprecated":null,"version":null,"openapi":"/openapi-components.json get /api/v1/assignment-grader/educator-report/{assignmentId}","href":"/api-reference/assignment-grader/generate-educator-report-for-an-assignment"}]}]}]}]},"basePath":"","title":"Create a new component - StudyFetch","buildId":"dpl_9yaRmq8qi7yyMZn9oEWmKEdYMvGZ","deploymentId":"dpl_9yaRmq8qi7yyMZn9oEWmKEdYMvGZ","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-Bsljvftq.js","utils-BEZX0tmN.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-BrDD79Na.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-2c3Nf5XI.js","snippetPresets-CWWkg29k.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-SJmWKHmz.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-BYc8UL58.js","shallow-UTXCq4wY.js","getApiPlaygroundDisplay-D1ZcrmBl.js","CodeSnippet-CTS7L7R4.js","CodeSnippets-MsBYl-gd.js","Page-BxumJvVQ.js","getPastedJson-C_5Mq0uv.js","icon-D7sYgD4k.js","MethodPill-B7Q6uD_j.js","DuplicateIcon-DXGzB8u_.js","createIcon-UDYg_Gk8.js","DynamicMarkdown-BBrVIqs3.js","SectionHeading-BxanXFN4.js","axios-vUo_bRtp.js","Markdown-DAhL0GAo.js","clsx-BZ8NiN2w.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-CpdUkuDP.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-sMo3-CxC.js"]}