Error

A valid request URL is required to generate request examples

{
  "access_delegation": {
    "mode": "INHERIT",
    "permissions": [
      "<string>"
    ]
  },
  "cpu_millicores": 123,
  "created_at": "<string>",
  "created_by": "<string>",
  "dataplane_url": "<string>",
  "delete_after_stop_seconds": 123,
  "fs_capacity_bytes": 123,
  "id": "<string>",
  "idle_ttl_seconds": 123,
  "labels": {},
  "mem_bytes": 123,
  "mount_config": {
    "auth": {
      "aws": {
        "role_arn": "<string>",
        "subject_scope": "<string>"
      },
      "azure": {
        "tenant_id": "<string>",
        "client_id": "<string>",
        "subject_scope": "<string>"
      },
      "gcp": {
        "workload_identity_provider": "<string>",
        "service_account_email": "<string>",
        "subject_scope": "<string>"
      }
    },
    "mounts": [
      {
        "id": "<string>",
        "mount_path": "<string>",
        "s3": {
          "bucket": "<string>",
          "region": "<string>",
          "endpoint_url": "<string>",
          "path_style": true,
          "prefix": "<string>"
        },
        "type": "s3",
        "cache": {
          "max_size_bytes": 1,
          "writeback_seconds": 1
        },
        "encryption": {
          "kms_key": "<string>"
        },
        "read_only": true,
        "azure_blob": {
          "container": "<string>",
          "storage_account": "<string>",
          "prefix": "<string>"
        },
        "contexthub": {
          "repo": "<string>",
          "initial_pull_only": true
        },
        "gcs": {
          "bucket": "<string>",
          "prefix": "<string>"
        },
        "git": {
          "remote_url": "<string>",
          "ref": {
            "name": "<string>",
            "type": "branch"
          },
          "refresh_interval_seconds": 2
        }
      }
    ]
  },
  "name": "<string>",
  "persistent": true,
  "preserve_memory_on_stop": true,
  "proxy_config": {
    "access_control": {
      "allow_list": [
        "<string>"
      ],
      "deny_list": [
        "<string>"
      ]
    },
    "callbacks": [
      {
        "match_hosts": [
          "<string>"
        ],
        "ttl_seconds": 1830,
        "url": "<string>",
        "full_request": true,
        "request_headers": [
          {
            "name": "<string>",
            "type": "plaintext",
            "is_set": true,
            "value": "<string>"
          }
        ]
      }
    ],
    "description": "<string>",
    "no_proxy": [
      "<string>"
    ],
    "rules": [
      {
        "name": "<string>",
        "aws": {
          "role_arn": "<string>",
          "subject_scope": "<string>"
        },
        "azure": {
          "tenant_id": "<string>",
          "client_id": "<string>",
          "subject_scope": "<string>",
          "resources": [
            "https://storage.azure.com"
          ]
        },
        "description": "<string>",
        "enabled": true,
        "env_vars": {},
        "gcp": {
          "workload_identity_provider": "<string>",
          "service_account_email": "<string>",
          "subject_scope": "<string>",
          "scopes": [
            "<string>"
          ]
        },
        "headers": [
          {
            "name": "<string>",
            "type": "plaintext",
            "is_set": true,
            "value": "<string>"
          }
        ],
        "match_headers": [
          "<string>"
        ],
        "match_hosts": [
          "<string>"
        ],
        "match_paths": [
          "<string>"
        ],
        "relay_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "rewrite": {
          "port": 32768,
          "credentials": "strip",
          "host": "<string>",
          "sandbox": "<string>"
        },
        "type": "<string>"
      }
    ]
  },
  "run_config": {
    "env_vars": {},
    "user": "<string>",
    "work_dir": "<string>"
  },
  "size_class": "<string>",
  "snapshot_id": "<string>",
  "status": "<string>",
  "status_message": "<string>",
  "stopped_at": "<string>",
  "updated_at": "<string>",
  "updated_by": "<string>",
  "vcpus": 123,
  "volumes": [
    {
      "mount_path": "<string>",
      "read_only": true,
      "volume_id": "<string>",
      "volume_name": "<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>"
  }
}

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

Start a sandbox

Start a stopped or failed sandbox. This endpoint is not idempotent. The optional volumes field is beta and requires sandbox volumes to be enabled for your workspace. Omit it to keep attachments, or send an empty array to detach all volumes. Changing attachments requires a stopped or failed sandbox, runtime access to it (its creator or sandboxes:exec), and, for each newly attached volume, being its creator or holding sandboxes:exec. A start whose volumes differ from those the sandbox’s saved memory was captured with fails with 409 unless discard_memory is set, which cold-boots the sandbox without that memory.

POST

api

sandboxes

boxes

{name}

start

Error

A valid request URL is required to generate request examples

{
  "access_delegation": {
    "mode": "INHERIT",
    "permissions": [
      "<string>"
    ]
  },
  "cpu_millicores": 123,
  "created_at": "<string>",
  "created_by": "<string>",
  "dataplane_url": "<string>",
  "delete_after_stop_seconds": 123,
  "fs_capacity_bytes": 123,
  "id": "<string>",
  "idle_ttl_seconds": 123,
  "labels": {},
  "mem_bytes": 123,
  "mount_config": {
    "auth": {
      "aws": {
        "role_arn": "<string>",
        "subject_scope": "<string>"
      },
      "azure": {
        "tenant_id": "<string>",
        "client_id": "<string>",
        "subject_scope": "<string>"
      },
      "gcp": {
        "workload_identity_provider": "<string>",
        "service_account_email": "<string>",
        "subject_scope": "<string>"
      }
    },
    "mounts": [
      {
        "id": "<string>",
        "mount_path": "<string>",
        "s3": {
          "bucket": "<string>",
          "region": "<string>",
          "endpoint_url": "<string>",
          "path_style": true,
          "prefix": "<string>"
        },
        "type": "s3",
        "cache": {
          "max_size_bytes": 1,
          "writeback_seconds": 1
        },
        "encryption": {
          "kms_key": "<string>"
        },
        "read_only": true,
        "azure_blob": {
          "container": "<string>",
          "storage_account": "<string>",
          "prefix": "<string>"
        },
        "contexthub": {
          "repo": "<string>",
          "initial_pull_only": true
        },
        "gcs": {
          "bucket": "<string>",
          "prefix": "<string>"
        },
        "git": {
          "remote_url": "<string>",
          "ref": {
            "name": "<string>",
            "type": "branch"
          },
          "refresh_interval_seconds": 2
        }
      }
    ]
  },
  "name": "<string>",
  "persistent": true,
  "preserve_memory_on_stop": true,
  "proxy_config": {
    "access_control": {
      "allow_list": [
        "<string>"
      ],
      "deny_list": [
        "<string>"
      ]
    },
    "callbacks": [
      {
        "match_hosts": [
          "<string>"
        ],
        "ttl_seconds": 1830,
        "url": "<string>",
        "full_request": true,
        "request_headers": [
          {
            "name": "<string>",
            "type": "plaintext",
            "is_set": true,
            "value": "<string>"
          }
        ]
      }
    ],
    "description": "<string>",
    "no_proxy": [
      "<string>"
    ],
    "rules": [
      {
        "name": "<string>",
        "aws": {
          "role_arn": "<string>",
          "subject_scope": "<string>"
        },
        "azure": {
          "tenant_id": "<string>",
          "client_id": "<string>",
          "subject_scope": "<string>",
          "resources": [
            "https://storage.azure.com"
          ]
        },
        "description": "<string>",
        "enabled": true,
        "env_vars": {},
        "gcp": {
          "workload_identity_provider": "<string>",
          "service_account_email": "<string>",
          "subject_scope": "<string>",
          "scopes": [
            "<string>"
          ]
        },
        "headers": [
          {
            "name": "<string>",
            "type": "plaintext",
            "is_set": true,
            "value": "<string>"
          }
        ],
        "match_headers": [
          "<string>"
        ],
        "match_hosts": [
          "<string>"
        ],
        "match_paths": [
          "<string>"
        ],
        "relay_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "rewrite": {
          "port": 32768,
          "credentials": "strip",
          "host": "<string>",
          "sandbox": "<string>"
        },
        "type": "<string>"
      }
    ]
  },
  "run_config": {
    "env_vars": {},
    "user": "<string>",
    "work_dir": "<string>"
  },
  "size_class": "<string>",
  "snapshot_id": "<string>",
  "status": "<string>",
  "status_message": "<string>",
  "stopped_at": "<string>",
  "updated_at": "<string>",
  "updated_by": "<string>",
  "vcpus": 123,
  "volumes": [
    {
      "mount_path": "<string>",
      "read_only": true,
      "volume_id": "<string>",
      "volume_name": "<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>"
  }
}

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

Authorizations

X-API-Key

string

header

required

Path Parameters

name

string

required

Sandbox display name

Body

application/json

discard_memory

boolean

DiscardMemory cold-boots the sandbox, discarding any memory saved when it stopped.

volumes

object[]

Volumes, when present, replaces the attached volumes. A start whose volumes differ from those the sandbox's saved memory was captured with fails unless discard_memory is set.

Maximum array length: 4

Show child attributes

Response

Accepted

access_delegation

object

AccessDelegation is the LangSmith access this sandbox was granted, absent when it has none. It is reported exactly as it was requested at create.

Show child attributes

cpu_millicores

integer

created_at

string

created_by

string

dataplane_url

string

delete_after_stop_seconds

integer

fs_capacity_bytes

integer

string

idle_ttl_seconds

integer

labels

object

Show child attributes

mem_bytes

integer

mount_config

object

Show child attributes

name

string

persistent

boolean

Persistent reports whether the sandbox keeps its filesystem across stops. When false, its writes are discarded whenever it stops and it is not charged for storage.

preserve_memory_on_stop

boolean

proxy_config

object

Show child attributes

run_config

object

RunConfig is what the sandbox's commands run with: the user, working directory and base env beneath env_vars.

Show child attributes

size_class

string

snapshot_id

string

status

string

status_message

string

stopped_at

string

updated_at

string

updated_by

string

vcpus

integer

volumes

object[]

Volumes (beta) are the volumes attached to the sandbox, in slot order. Absent when the workspace does not have sandbox volumes enabled.

Show child attributes

SmithDB SDK migration

LangSmith REST API

Start a sandbox

Authorizations

Path Parameters

Body

Response