LangChain Reference home pageLangChain ReferenceLangChain Reference
  • GitHub
  • Main Docs
Deep Agents
LangChain
LangGraph
Integrations
LangSmith
  • Overview
  • Client
  • AsyncClient
  • Run Helpers
  • Run Trees
  • Evaluation
  • Schemas
  • Utilities
  • Wrappers
  • Anonymizer
  • Testing
  • Expect API
  • Middleware
  • Pytest Plugin
  • Deployment SDK
⌘I

LangChain Assistant

Ask a question to get started

Enter to send•Shift+Enter new line

Menu

OverviewClientAsyncClientRun HelpersRun TreesEvaluationSchemasUtilitiesWrappersAnonymizerTestingExpect APIMiddlewarePytest PluginDeployment SDK
Language
Theme
PythonlangsmithclientClientread_run
Method●Since v0.2Deprecated

read_run

Copy
read_run(
  self,
  run_id: ID_TYPE,
  load_child_runs: bool = False,
  *,
  project_id: Optional
View source on GitHub
[
ID_TYPE
]
=
None
,
start_time
:
Optional
[
datetime
.
datetime
]
=
None
)
->
ls_schemas
.
Run

Parameters

NameTypeDescription
run_id*Union[UUID, str]

The ID of the run to read.

load_child_runsbool, default=False
Default:False

Whether to load nested child runs. Deprecated: this will be removed in a future release, and raises on SmithDB-only backends (no ClickHouse query support), where child runs are never loaded.

project_idOptional[Union[UUID, str]]
Default:None
start_timeOptional[datetime]
Default:None

Read a run from the LangSmith API.

.. admonition:: Deprecated

Use :meth:`langsmith.Client.runs.retrieve` instead.
See https://docs.langchain.com/langsmith/smithdb-sdk-migration#runs-retrieve for the migration guide.
Will be removed after Jan 31, 2027.

The ID of the project (session) that owns the run. Required on SmithDB-only backends (no ClickHouse query support).

The run's start time. Required on SmithDB-only backends (no ClickHouse query support).