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-sdk_syncrunsSyncRunsClientjoin
    Method●Since v0.3

    join

    Copy
    join(
      self,
      thread_id: str,
      run_id: str,
      *,
      headers: Mapping[str
    View source on GitHub
    ,
    str
    ]
    |
    None
    =
    None
    ,
    params
    :
    QueryParamTypes
    |
    None
    =
    None
    )
    ->
    dict

    Parameters

    NameTypeDescription
    thread_id*str

    The thread ID to join.

    run_id*str

    The run ID to join.

    headersMapping[str, str] | None
    Default:None
    paramsQueryParamTypes | None
    Default:None

    Block until a run is done. Returns the final state of the thread.

    client = get_sync_client(url="http://localhost:2024")
    client.runs.join(
        thread_id="thread_id_to_join",
        run_id="run_id_to_join"
    )

    Optional custom headers to include with the request.

    Optional query parameters to include with the request.