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
    PythonlanggraphtypesCheckpointPayload
    Class●Since v1.1

    CheckpointPayload

    Payload for a checkpoint event.

    Copy
    CheckpointPayload()

    Bases

    TypedDictGeneric[StateT]

    Constructors

    constructor
    __init__
    NameType
    configRunnableConfig | None
    metadataCheckpointMetadata
    valuesStateT
    nextlist[str]
    parent_configRunnableConfig | None
    taskslist[CheckpointTask]

    Attributes

    attribute
    config: RunnableConfig | None

    Configuration for this checkpoint, including the thread_id and checkpoint_id.

    attribute
    metadata: CheckpointMetadata

    Metadata associated with this checkpoint (e.g. step number, source, writes).

    attribute
    values: StateT

    Current state values at the time of this checkpoint.

    attribute
    next: list[str]

    Names of the nodes scheduled to execute next.

    attribute
    parent_config: RunnableConfig | None

    Configuration of the parent checkpoint, or None if this is the first checkpoint.

    attribute
    tasks: list[CheckpointTask]

    List of tasks associated with this checkpoint.

    View source on GitHub