List snapshots

Error

A valid request URL is required to generate request examples

{
  "items": [
    {
      "created_at": "<string>",
      "created_by": "<string>",
      "description": "<string>",
      "docker_image": "<string>",
      "fs_capacity_bytes": 123,
      "fs_used_bytes": 123,
      "id": "<string>",
      "image_digest": "<string>",
      "labels": {},
      "memory_snapshot_size_bytes": 123,
      "name": "<string>",
      "registry_id": "<string>",
      "source_sandbox_id": "<string>",
      "status": "<string>",
      "status_message": "<string>",
      "tags": [
        "<string>"
      ],
      "updated_at": "<string>"
    }
  ],
  "next_cursor": "<string>",
  "offset": 123,
  "snapshots": [
    {
      "created_at": "<string>",
      "created_by": "<string>",
      "description": "<string>",
      "docker_image": "<string>",
      "fs_capacity_bytes": 123,
      "fs_used_bytes": 123,
      "id": "<string>",
      "image_digest": "<string>",
      "labels": {},
      "memory_snapshot_size_bytes": 123,
      "name": "<string>",
      "registry_id": "<string>",
      "source_sandbox_id": "<string>",
      "status": "<string>",
      "status_message": "<string>",
      "tags": [
        "<string>"
      ],
      "updated_at": "<string>"
    }
  ]
}

{
  "detail": {
    "error": "<string>",
    "error_id": "<string>",
    "message": "<string>"
  }
}

{
  "detail": {
    "error": "<string>",
    "error_id": "<string>",
    "message": "<string>"
  }
}

{
  "detail": {
    "error": "<string>",
    "error_id": "<string>",
    "message": "<string>"
  }
}

{
  "detail": {
    "error": "<string>",
    "error_id": "<string>",
    "message": "<string>"
  }
}

GET

api

sandboxes

snapshots

Error

A valid request URL is required to generate request examples

{
  "items": [
    {
      "created_at": "<string>",
      "created_by": "<string>",
      "description": "<string>",
      "docker_image": "<string>",
      "fs_capacity_bytes": 123,
      "fs_used_bytes": 123,
      "id": "<string>",
      "image_digest": "<string>",
      "labels": {},
      "memory_snapshot_size_bytes": 123,
      "name": "<string>",
      "registry_id": "<string>",
      "source_sandbox_id": "<string>",
      "status": "<string>",
      "status_message": "<string>",
      "tags": [
        "<string>"
      ],
      "updated_at": "<string>"
    }
  ],
  "next_cursor": "<string>",
  "offset": 123,
  "snapshots": [
    {
      "created_at": "<string>",
      "created_by": "<string>",
      "description": "<string>",
      "docker_image": "<string>",
      "fs_capacity_bytes": 123,
      "fs_used_bytes": 123,
      "id": "<string>",
      "image_digest": "<string>",
      "labels": {},
      "memory_snapshot_size_bytes": 123,
      "name": "<string>",
      "registry_id": "<string>",
      "source_sandbox_id": "<string>",
      "status": "<string>",
      "status_message": "<string>",
      "tags": [
        "<string>"
      ],
      "updated_at": "<string>"
    }
  ]
}

{
  "detail": {
    "error": "<string>",
    "error_id": "<string>",
    "message": "<string>"
  }
}

{
  "detail": {
    "error": "<string>",
    "error_id": "<string>",
    "message": "<string>"
  }
}

{
  "detail": {
    "error": "<string>",
    "error_id": "<string>",
    "message": "<string>"
  }
}

{
  "detail": {
    "error": "<string>",
    "error_id": "<string>",
    "message": "<string>"
  }
}

Authorizations

X-API-Key

string

header

required

Query Parameters

page_size

integer

default:20

Number of results per page

cursor

string

Opaque pagination cursor from a prior response's next_cursor

limit

integer

default:50

Deprecated: use page_size. Maximum number of results

offset

integer

default:0

Deprecated: use cursor. Pagination offset

name_contains

string

Filter by name substring

status

string

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

created_by

string

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

label

string[]

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

sort_by

string

default:created_at

Sort column (name, status, created_at)

sort_order

string

default:desc

Sort direction (asc, desc)

sort_direction

string

default:desc

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

Response

items

object[]

This page of snapshots.

Show child attributes

next_cursor

string

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.

offset

integer

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

snapshots

object[]

Deprecated: use items. Duplicates items.

Show child attributes

SmithDB SDK migration

LangSmith REST API

Authorizations

Query Parameters

Response