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-sdkclient
    Module●Since v0.1

    client

    The LangGraph client implementations connect to the LangGraph API.

    This module provides both asynchronous (get_client(url="http://localhost:2024") or LangGraphClient) and synchronous (get_sync_client(url="http://localhost:2024") or SyncLanggraphClient) clients to interacting with the LangGraph API's core resources such as Assistants, Threads, Runs, and Cron jobs, as well as its persistent document Store.

    Functions

    function
    get_client

    Create and configure a LangGraphClient.

    The client provides programmatic access to LangSmith Deployment. It supports both remote servers and local in-process connections (when running inside a LangGraph server).

    function
    configure_loopback_transports
    function
    get_sync_client

    Get a synchronous LangGraphClient instance.

    Classes

    class
    AssistantsClient

    Client for managing assistants in LangGraph.

    This class provides methods to interact with assistants, which are versioned configurations of your graph.

    Example
    client = get_client(url="http://localhost:2024")
    assistant = await client.assistants.get("assistant_id_123")
    class
    LangGraphClient

    Top-level client for LangGraph API.

    class
    CronClient

    Client for managing recurrent runs (cron jobs) in LangGraph.

    A run is a single invocation of an assistant with optional input, config, and context. This client allows scheduling recurring runs to occur automatically.

    Example Usage
    client = get_client(url="http://localhost:2024"))
    cron_job = await client.crons.create_for_thread(
        thread_id="thread_123",
        assistant_id="asst_456",
        schedule="0 9 * * *",
        input={"message": "Daily update"}
    )
    Feature Availability

    The crons client functionality is not supported on all licenses. Please check the relevant license documentation for the most up-to-date details on feature availability.

    class
    HttpClient

    Handle async requests to the LangGraph API.

    Adds additional error messaging & content handling above the provided httpx client.

    class
    RunsClient

    Client for managing runs in LangGraph.

    A run is a single assistant invocation with optional input, config, context, and metadata. This client manages runs, which can be stateful (on threads) or stateless.

    Example
    client = get_client(url="http://localhost:2024")
    run = await client.runs.create(assistant_id="asst_123", thread_id="thread_456", input={"query": "Hello"})
    class
    StoreClient

    Client for interacting with the graph's shared storage.

    The Store provides a key-value storage system for persisting data across graph executions, allowing for stateful operations and data sharing across threads.

    Example
    client = get_client(url="http://localhost:2024")
    await client.store.put_item(["users", "user123"], "mem-123451342", {"name": "Alice", "score": 100})
    class
    ThreadsClient

    Client for managing threads in LangGraph.

    A thread maintains the state of a graph across multiple interactions/invocations (aka runs). It accumulates and persists the graph's state, allowing for continuity between separate invocations of the graph.

    Example
    client = get_client(url="http://localhost:2024"))
    new_thread = await client.threads.create(metadata={"user_id": "123"})
    class
    SyncAssistantsClient

    Client for managing assistants in LangGraph synchronously.

    This class provides methods to interact with assistants, which are versioned configurations of your graph.

    Example
    client = get_sync_client(url="http://localhost:2024")
    assistant = client.assistants.get("assistant_id_123")
    class
    SyncLangGraphClient

    Synchronous client for interacting with the LangGraph API.

    This class provides synchronous access to LangGraph API endpoints for managing assistants, threads, runs, cron jobs, and data storage.

    Example
    client = get_sync_client(url="http://localhost:2024")
    assistant = client.assistants.get("asst_123")
    class
    SyncCronClient

    Synchronous client for managing cron jobs in LangGraph.

    This class provides methods to create and manage scheduled tasks (cron jobs) for automated graph executions.

    Example
    client = get_sync_client(url="http://localhost:8123")
    cron_job = client.crons.create_for_thread(thread_id="thread_123", assistant_id="asst_456", schedule="0 * * * *")
    Feature Availability

    The crons client functionality is not supported on all licenses. Please check the relevant license documentation for the most up-to-date details on feature availability.

    class
    SyncHttpClient

    Handle synchronous requests to the LangGraph API.

    Provides error messaging and content handling enhancements above the underlying httpx client, mirroring the interface of HttpClient but for sync usage.

    class
    SyncRunsClient

    Synchronous client for managing runs in LangGraph.

    This class provides methods to create, retrieve, and manage runs, which represent individual executions of graphs.

    Example
    client = get_sync_client(url="http://localhost:2024")
    run = client.runs.create(thread_id="thread_123", assistant_id="asst_456")
    class
    SyncStoreClient

    A client for synchronous operations on a key-value store.

    Provides methods to interact with a remote key-value store, allowing storage and retrieval of items within namespaced hierarchies.

    Example
    client = get_sync_client(url="http://localhost:2024"))
    client.store.put_item(["users", "profiles"], "user123", {"name": "Alice", "age": 30})
    class
    SyncThreadsClient

    Synchronous client for managing threads in LangGraph.

    This class provides methods to create, retrieve, and manage threads, which represent conversations or stateful interactions.

    Example
    client = get_sync_client(url="http://localhost:2024")
    thread = client.threads.create(metadata={"user_id": "123"})
    View source on GitHub