createNote
Generate a Markdown note from educational content.
Generates a Markdown note from educational content. There is no React component for notes.
Usage
import { createNote } from "edu-sdk";
const note = await createNote({
model: "google/gemini-3.6-flash",
content,
difficulty: "medium",
length: "medium"
});Options
| Option | Type | Required | Default |
|---|---|---|---|
model | string | LanguageModel | Yes | — |
content | string | FileContent | Yes | — |
difficulty | "easy" | "medium" | "hard" | No | "medium" |
length | "short" | "medium" | "long" | No | "medium" |
content may be a string or FileContent (PDF / text / markdown bytes).
Returns
Promise<Artifact<string>>
{
id: string;
title: string;
description?: string;
metadata: {
createdAt: string;
model: string;
difficulty: "easy" | "medium" | "hard";
};
content: string; // Markdown body
}content is Markdown: headings for sections, bold for important terms. title and optional description live on the envelope.
Example
import { createNote } from "edu-sdk";
const note = await createNote({
model: "google/gemini-3.6-flash",
content: lectureTranscript,
difficulty: "hard",
length: "long"
});
console.log(note.title, note.content);