LangChain Reference home pageLangChain ReferenceLangChain Reference
  • GitHub
  • Main Docs
Deep Agents
LangChain
LangGraph
Integrations
LangSmith
  • Overview
    • Overview
    • Graphs
    • Functional API
    • Pregel
    • Checkpointing
    • Storage
    • Caching
    • Types
    • Runtime
    • Config
    • Errors
    • Constants
    • Channels
    • Agents
    LangGraph CLI
    LangGraph SDK
    LangGraph Supervisor
    LangGraph Swarm
    ⌘I

    LangChain Assistant

    Ask a question to get started

    Enter to send•Shift+Enter new line

    Menu

    OverviewGraphsFunctional APIPregelCheckpointingStorageCachingTypesRuntimeConfigErrorsConstantsChannelsAgents
    LangGraph CLI
    LangGraph SDK
    LangGraph Supervisor
    LangGraph Swarm
    Language
    Theme
    PythonlanggraphcallbacksGraphInterruptEvent
    Class●Since v1.1

    GraphInterruptEvent

    Graph lifecycle event emitted when execution pauses for interrupts.

    Copy
    GraphInterruptEvent(
      self,
      run_id: UUID | None,
      status: GraphLifecycleStatus,
      checkpoint_id: str,
      checkpoint_ns: tuple[str, ...],
      interrupts: tuple[Interrupt, ...]
    )

    Constructors

    constructor
    __init__
    NameType
    run_idUUID | None
    statusGraphLifecycleStatus
    checkpoint_idstr
    checkpoint_nstuple[str, ...]
    interruptstuple[Interrupt, ...]

    Attributes

    attribute
    run_id: UUID | None

    Run id for the current graph execution, if available.

    attribute
    status: GraphLifecycleStatus

    Loop status when the interrupt was captured.

    attribute
    checkpoint_id: str

    Checkpoint id associated with the interrupted execution.

    attribute
    checkpoint_ns: tuple[str, ...]

    Checkpoint namespace path for the current graph or subgraph.

    attribute
    interrupts: tuple[Interrupt, ...]

    Interrupt payloads that caused the graph to pause.

    View source on GitHub