LangChain Reference home pageLangChain ReferenceLangChain Reference
  • GitHub
  • Main Docs
Deep Agents
LangChain
LangGraph
Integrations
LangSmith
  • Overview
  • LangGraph Checkpoint
    Checkpoint Postgres
    Store Postgres
    Checkpoint SQLite
    LangGraph Prebuilt
    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

    LangGraph Checkpoint
    Checkpoint Postgres
    Store Postgres
    Checkpoint SQLite
    LangGraph Prebuilt
    LangGraph CLI
    LangGraph SDK
    LangGraph Supervisor
    LangGraph Swarm
    Language
    Theme
    Pythonlanggraph-sdkschemaCheckpointPayload
    Classā—Since v0.3

    CheckpointPayload

    Payload for a checkpoint event.

    Copy
    CheckpointPayload()

    Bases

    TypedDict

    Constructors

    Attributes

    View source on GitHub
    constructor
    __init__
    NameType
    configdict[str, Any] | None
    metadatadict[str, Any]
    valuesdict[str, Any]
    nextlist[str]
    parent_configdict[str, Any] | None
    taskslist[CheckpointTaskPayload]
    attribute
    config: dict[str, Any] | None

    Configuration for this checkpoint, including the thread_id and checkpoint_id.

    attribute
    metadata: dict[str, Any]

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

    attribute
    values: dict[str, Any]

    Current state values at the time of this checkpoint.

    attribute
    next: list[str]

    Names of the nodes scheduled to execute next.

    attribute
    parent_config: dict[str, Any] | None

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

    attribute
    tasks: list[CheckpointTaskPayload]

    List of tasks associated with this checkpoint.