Sanity Library Reference Docs
    Preparing search index...

    Interface ProjectedDefinitionSummary

    One deployed workflow definition, latest version only — what workflows_list_definitions returns per name. Deploys are create-only (every deploy mints a new version), but the LLM only ever needs the head: it's the version startInstance picks by default.

    interface ProjectedDefinitionSummary {
        description?: string;
        name: string;
        startable: boolean;
        startKind: StartKind;
        title: string;
        version: number;
    }
    Index

    Properties

    description? name startable startKind title version

    Properties

    description?: string

    Author-supplied description, when the definition carries one.

    name: string

    Definition name — the value workflows_list_instances filters on.

    startable: boolean

    Whether new instances can be started directly. false for spawn-only child workflows — those only come to exist under a parent instance.

    startKind: StartKind

    Who initiates standalone runs: 'interactive' (a person, from a start surface) or 'autonomous' (a system reacting to a document). Classification only — the engine starts either kind for any caller.

    title: string

    Human-readable workflow title.

    version: number

    Latest deployed version.

    Settings

    Member Visibility

    On This Page

    Properties