sandboxes

List sandboxes

Changed on

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.

get/api/v2/sandboxes/boxes

Request

  • Base URL
    https://api.smith.langchain.com
  • URL
    https://api.smith.langchain.com/api/v2/sandboxes/boxes
  • Auth
    • API key in header X-API-Key
    • or API key in header X-Tenant-Id
    • or HTTP bearer
    • or X-Service-Key (a scheme the document does not define)

Query parameters

page_sizeinteger

Number of results per page

cursorstring

Opaque pagination cursor from a prior response's next_cursor

limitinteger

Deprecated: use page_size. Maximum number of results

offsetinteger

Deprecated: use cursor. Pagination offset

name_containsstring

Filter by name substring

statusstring

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

tag_value_idstring[]

Filter by workspace resource tag value IDs; all must match

created_bystring

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

labelstring[]

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

sort_bystring

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

sort_orderstring

Sort direction (asc, desc)

sort_directionstring

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

Response

OK

next_cursorstring

Cursor for the next page, or null on the last page. A non-null value is the only signal that more pages exist. Treat it as opaque.

offsetinteger

Deprecated: use next_cursor. Offset to request for the next page, or 0 when no pages remain.

Changes

  • dfe647d1748eRevision changes
    • info

      added the optional property // to the response with the status

    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property // to the response with the status

  • 1a8ee9358d81Revision changes
    • info

      endpoint added