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
Pythonlangsmith_openapi_clientresourcessandboxessnapshotsAsyncSnapshotsResourcelist
Method●Since v0.9

list

Copy
list(
  self,
  *,
  created_by: str | Omit = omit,
  limit
View source on GitHub
:
int
|
Omit
=
omit
,
name_contains
:
str
|
Omit
=
omit
,
offset
:
int
|
Omit
=
omit
,
sort_by
:
str
|
Omit
=
omit
,
sort_direction
:
str
|
Omit
=
omit
,
status
:
str
|
Omit
=
omit
,
extra_headers
:
Headers
|
None
=
None
,
extra_query
:
Query
|
None
=
None
,
extra_body
:
Body
|
None
=
None
,
timeout
:
float
|
httpx
.
Timeout
|
None
|
NotGiven
=
not_given
)
->
SnapshotListResponse

Parameters

NameTypeDescription
created_bystr | Omit
Default:omit

Filter by creator identity. Only 'me' is supported.

limitint | Omit
Default:omit

Maximum number of results

name_containsstr | Omit
Default:omit
offsetint | Omit
Default:omit
sort_bystr | Omit
Default:omit
sort_directionstr | Omit
Default:omit
statusstr | Omit
Default:omit
extra_headersHeaders | None
Default:None
extra_queryQuery | None
Default:None
extra_bodyBody | None
Default:None
timeoutfloat | httpx.Timeout | None | NotGiven
Default:not_given

List sandbox snapshots for the authenticated tenant, with optional filtering, sorting, and pagination.

Filter by name substring

Pagination offset

Sort column (name, status, created_at)

Sort direction (asc, desc)

Filter by status (building, ready, failed, deleting)

Send extra headers

Add additional query parameters to the request

Add additional JSON properties to the request

Override the client-level default timeout for this request, in seconds