list

list(
  self,
  *,
  created_by: str | Omit = omit,

View source on GitHub

Parameters

Name	Type	Description
`created_by`	`str \| Omit`	Default:`omit` Filter by creator identity. Only 'me' is supported.
`cursor`	`str \| Omit`	Default:`omit` Opaque pagination cursor from a prior response's next_cursor
`label`	`SequenceNotStr[str] \| Omit`	Default:`omit`
`limit`	`int \| Omit`	Default:`omit`
`name_contains`	`str \| Omit`	Default:`omit`
`offset`	`int \| Omit`	Default:`omit`
`page_size`	`int \| Omit`	Default:`omit`
`sort_by`	`str \| Omit`	Default:`omit`
`sort_direction`	`str \| Omit`	Default:`omit`
`sort_order`	`str \| Omit`	Default:`omit`
`status`	`str \| Omit`	Default:`omit`
`extra_headers`	`Headers \| None`	Default:`None`
`extra_query`	`Query \| None`	Default:`None`
`extra_body`	`Body \| None`	Default:`None`
`timeout`	`float \| httpx.Timeout \| None \| NotGiven`	Default:`not_given`

List sandboxes for the authenticated tenant, with optional filtering, sorting, and pagination. Page with page_size and cursor: replay the response's next_cursor until it comes back null, which is the only signal that no pages remain. Cursors are opaque and only valid on this endpoint; do not parse or construct one.

Filter by label. Repeatable; all must match. Use 'key' to match on key presence or 'key=value' for equality.

Deprecated: use page_size. Maximum number of results

Filter by name substring

Deprecated: use cursor. Pagination offset

Number of results per page

Sort column (name, status, created_at, stopped_at, idle_ttl_seconds, delete_after_stop_seconds)

Deprecated: use sort_order. Sort direction (asc, desc)

Sort direction (asc, desc)

Filter by status (provisioning, ready, failed, stopped, deleting)

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

LangChain Assistant

Menu

list

Parameters