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-sdkschemaCheckpointTaskPayload
    Class●Since v0.3

    CheckpointTaskPayload

    Copy
    CheckpointTaskPayload()

    Bases

    TypedDict

    Constructors

    Attributes

    View source on GitHub
    constructor
    __init__
    NameType
    idstr
    namestr
    errorNotRequired[str]
    resultNotRequired[Any]
    interruptsNotRequired[list[dict[str, Any]]]
    statedict[str, Any] | None
    attribute
    id: str

    Unique identifier for this task.

    attribute
    name: str

    Name of the node being executed.

    attribute
    error: NotRequired[str]

    Error message, present only if the task failed.

    attribute
    result: NotRequired[Any]

    Result of the task, present only if the task completed successfully.

    attribute
    interrupts: NotRequired[list[dict[str, Any]]]

    List of interrupts, present when the task has been interrupted or completed.

    attribute
    state: dict[str, Any] | None

    Snapshot of the subgraph state. None if not a subgraph.

    A task entry within a CheckpointPayload.

    The keys present depend on the task's state:

    • Error: id, name, error, state
    • Has result: id, name, result, interrupts, state
    • Pending: id, name, interrupts, state