nexus-agents - v2.80.0
    Preparing search index...

    Interface Checkpoint

    A snapshot of graph execution state at a given step boundary. Contains all information needed to resume execution.

    interface Checkpoint {
        id: string;
        executionId: string;
        schemaVersion: number;
        stepNumber: number;
        state: Readonly<GraphState>;
        pendingNodeIds: readonly string[];
        completedResults: readonly NodeResult[];
        createdAt: string;
        metadata?: Record<string, unknown>;
        interrupt?: CheckpointInterrupt;
    }
    Index

    Properties

    id executionId schemaVersion stepNumber state pendingNodeIds completedResults createdAt metadata? interrupt?

    Properties

    id: string

    Unique checkpoint ID.

    executionId: string

    Execution ID this checkpoint belongs to.

    schemaVersion: number

    Schema version for deserialization.

    stepNumber: number

    Step number when this checkpoint was taken.

    state: Readonly<GraphState>

    Full graph state at this point.

    pendingNodeIds: readonly string[]

    IDs of nodes ready to run next.

    completedResults: readonly NodeResult[]

    Results of all completed nodes so far.

    createdAt: string

    ISO timestamp when checkpoint was created.

    metadata?: Record<string, unknown>

    Optional metadata for debugging.

    interrupt?: CheckpointInterrupt

    If present, the checkpoint was created because a node returned an Interrupt. The resume API uses this to know which node to re-run and which interrupt id to match resume values against. (#1895)

    Settings

    Member Visibility

    On This Page

    Properties