Trilium Backend API
    Preparing search index...

    Interface NoteParams

    interface NoteParams {
        attributes?: Omit<AttributeRow, "noteId" | "attributeId">[];
        branchId?: string;
        content: string | Buffer<ArrayBufferLike>;
        dateCreated?: string;
        ignoreForbiddenParents?: boolean;
        isExpanded?: boolean;
        isProtected?: boolean;
        mime?: string;
        noteId?: string;
        notePosition?: number;
        parentNoteId: string;
        prefix?: string;
        target?: "into";
        templateNoteId?: string;
        title: string;
        type:
            | "image"
            | "file"
            | "search"
            | "noteMap"
            | "launcher"
            | "doc"
            | "contentWidget"
            | "text"
            | "relationMap"
            | "render"
            | "canvas"
            | "mermaid"
            | "book"
            | "webView"
            | "code"
            | "mindMap"
            | "aiChat";
        utcDateCreated?: string;
    }
    Index

    Properties

    attributes? branchId? content dateCreated? ignoreForbiddenParents? isExpanded? isProtected? mime? noteId? notePosition? parentNoteId prefix? target? templateNoteId? title type utcDateCreated?

    Properties

    attributes?: Omit<AttributeRow, "noteId" | "attributeId">[]

    Attributes to be set on the note. These are set atomically on note creation, so entity changes are not sent for attributes defined here.

    branchId?: string

    content

    content: string | Buffer<ArrayBufferLike>
    dateCreated?: string
    ignoreForbiddenParents?: boolean
    isExpanded?: boolean

    default is false

    isProtected?: boolean

    default is false

    mime?: string

    default value is derived from default mimes for type

    noteId?: string

    optionally can force specific noteId

    notePosition?: number

    default is the last existing notePosition in a parent + 10

    parentNoteId: string
    prefix?: string

    default is empty string

    target?: "into"
    templateNoteId?: string
    title: string
    type:
        | "image"
        | "file"
        | "search"
        | "noteMap"
        | "launcher"
        | "doc"
        | "contentWidget"
        | "text"
        | "relationMap"
        | "render"
        | "canvas"
        | "mermaid"
        | "book"
        | "webView"
        | "code"
        | "mindMap"
        | "aiChat"

    text, code, file, image, search, book, relationMap, canvas, webView

    utcDateCreated?: string

    Settings

    Member Visibility

    On This Page

    Properties