Create a sandbox

POST

sandboxes

instances

curl --request POST \
  --url https://api.baseten.co/v1/sandboxes/instances \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "image": "baseten/base-image:latest",
  "memory": 2048,
  "region": "us-was-1"
}
'

{
  "lifecycle": {
    "expiration_policies": [
      {
        "action": "DELETE",
        "type": "TTL_IDLE",
        "value": "24h"
      },
      {
        "action": "DELETE",
        "type": "TTL_MAX_AGE",
        "value": "7d"
      },
      {
        "action": "DELETE",
        "type": "DATE",
        "value": "2026-09-23T21:26:58Z"
      }
    ],
    "terminated_retention": "24h"
  },
  "network": {
    "proxy": {
      "allowed_domains": [
        "api.openai.com",
        "pypi.org",
        "files.pythonhosted.org",
        "registry.npmjs.org"
      ],
      "bypass": [
        "registry.npmjs.org"
      ],
      "forbidden_domains": [
        "facebook.com",
        "*.facebook.com"
      ],
      "routing": [
        {
          "destinations": [
            "api.openai.com"
          ],
          "headers": {
            "Authorization": "Bearer {{SECRET:openai-key}}"
          },
          "body": {
            "user": "baseten-api-review-0916"
          }
        }
      ]
    },
    "subnet": "default"
  },
  "region": "us-pdx-1",
  "envs": [
    {
      "name": "NODE_ENV",
      "secret": false,
      "value": "production"
    },
    {
      "name": "PORT",
      "secret": false,
      "value": "3000"
    }
  ],
  "image": "baseten/base-image:latest",
  "memory": 4096,
  "ports": [
    {
      "name": "http",
      "protocol": "HTTP",
      "target": 3000
    }
  ],
  "external_id": "api-review-20260916-001",
  "labels": {
    "env": "development",
    "project": "api-review",
    "team": "engineering"
  },
  "name": "baseten-api-review-0916",
  "url": "https://sbx-baseten-api-review-0916-esb1qo.us-pdx-1.b10.run",
  "status": "DEPLOYED",
  "created_at": "2026-09-16T21:26:58.545765901Z",
  "updated_at": "2026-09-16T21:31:13Z",
  "created_by": "sandbox-automation",
  "updated_by": "sandbox-automation",
  "last_used_at": "2026-09-16T21:31:13Z",
  "expires_in": 86400
}

{
  "code": "INVALID_REQUEST",
  "message": "One or more request parameters are invalid.",
  "details": {
    "request_id": "a3b7c4d2-91e6-4f08-9b5a-2c6d7e8f1043"
  }
}

{
  "code": "UNAUTHORIZED",
  "message": "Provide a valid authentication token in the Authorization header.",
  "details": {
    "header": "Authorization"
  }
}

{
  "code": "FORBIDDEN",
  "message": "This authentication token does not grant permission to perform this operation.",
  "details": {
    "request_id": "a3b7c4d2-91e6-4f08-9b5a-2c6d7e8f1043"
  }
}

{
  "code": "ALREADY_EXISTS",
  "message": "A sandbox with this name already exists.",
  "details": {
    "name": "baseten-api-review-0916"
  }
}

{
  "code": "RATE_LIMITED",
  "message": "Too many requests. Try again in 30 seconds.",
  "details": {
    "retry_after_seconds": 30
  }
}

{
  "code": "INTERNAL_ERROR",
  "message": "The request could not be completed. Try again later.",
  "details": {
    "request_id": "a3b7c4d2-91e6-4f08-9b5a-2c6d7e8f1043"
  }
}

Creation waits until the sandbox is ready and returns it with status DEPLOYED, so you can connect right away. An active sandbox reserves its name; you can reuse a name after the sandbox fails or terminates. Related guide: Manage sandboxes.

Authorizations

Authorization

string

header

required

Send Authorization: Bearer <api_key>. The legacy Authorization: Api-Key <api_key> scheme is also accepted.

Headers

X-Team-Id

string

Optional team ID. Must match the team_id query parameter when both are supplied. If neither selector is supplied, defaults to the caller's only accessible team. Callers with multiple accessible teams must select a team. Requests without access to any team are forbidden.

Minimum string length: 1

Query Parameters

team_id

string

Optional team ID. Must match X-Team-Id when both are supplied. If neither selector is supplied, defaults to the caller's only accessible team. Callers with multiple accessible teams must select a team. Requests without access to any team are forbidden.

Minimum string length: 1

Body

application/json

Configuration for a new sandbox. The client may provide a name; otherwise the server generates one. The name is immutable after creation.

create_if_not_exists

boolean

When true, return the existing live sandbox with this name or recreate it if it is failed, terminated, or being deleted. The server handles concurrent creation and deletion races with a bounded wait; persistent contention returns a conflict. Requires name. Existing configuration is preserved. Defaults to false when omitted.

name

string

Optional unique sandbox name. Generated by the server when omitted; immutable after creation.

Minimum string length: 1

Example:

"baseten-api-review-0916"

lifecycle

object

Lifecycle configuration controlling automatic sandbox deletion based on idle time, max age, or specific dates

Show child attributes

Example:

{
  "expiration_policies": [
    {
      "action": "DELETE",
      "type": "TTL_IDLE",
      "value": "24h"
    },
    {
      "action": "DELETE",
      "type": "TTL_MAX_AGE",
      "value": "7d"
    },
    {
      "action": "DELETE",
      "type": "DATE",
      "value": "2026-09-23T21:26:58Z"
    }
  ],
  "terminated_retention": "24h"
}

network

object

Network configuration for a sandbox including subnet, domain filtering, and proxy settings

Show child attributes

Example:

{
  "proxy": {
    "allowed_domains": [
      "api.openai.com",
      "pypi.org",
      "files.pythonhosted.org",
      "registry.npmjs.org"
    ],
    "bypass": ["registry.npmjs.org"],
    "forbidden_domains": ["facebook.com", "*.facebook.com"],
    "routing": [
      {
        "destinations": ["api.openai.com"],
        "headers": {
          "Authorization": "Bearer {{SECRET:openai-key}}"
        },
        "body": { "user": "baseten-api-review-0916" },
        "secrets": {
          "openai-key": "sk-proj-demo-not-a-valid-api-key"
        }
      }
    ]
  },
  "subnet": "default"
}

region

string

Region where the sandbox runs (for example us-pdx-1 or eu-lon-1). When omitted at creation, the closest region is selected.

Example:

"us-pdx-1"

envs

object[]

Environment variables injected into the sandbox.

Show child attributes

Example:

[
  {
    "name": "NODE_ENV",
    "secret": false,
    "value": "production"
  },
  {
    "name": "PORT",
    "secret": false,
    "value": "3000"
  }
]

image

string

default:baseten/base-image:latest

Image reference including its tag. Defaults to baseten/base-image:latest, the built-in sandbox execution API. This image is available directly without building, pushing, or listing images through GET /v1/sandboxes/images.

Example:

"baseten/base-image:latest"

memory

integer

default:4096

Memory allocation in megabytes. Also determines CPU allocation (CPU cores = memory in MB / 2048, e.g., 4096MB = 2 CPUs). Defaults to 4096.

Required range: x >= 1

Example:

4096

ports

object[]

Set of ports for a resource

Show child attributes

Example:

[
  {
    "name": "http",
    "protocol": "HTTP",
    "target": 3000
  }
]

external_id

string

Caller-owned identifier for external lookups. Max 64 chars, alphanumeric + dash.

Maximum string length: 64

Pattern: ^[A-Za-z0-9-]+$

Example:

"api-review-20260916-001"

labels

object

Key-value pairs for organizing and filtering resources. Labels can be used to categorize resources by environment, project, team, or any custom taxonomy.

Show child attributes

Example:

{
  "env": "development",
  "project": "api-review",
  "team": "engineering"
}

Response

Sandbox created.

Sandbox resource with configuration and server-managed fields at the root. No metadata, spec, or runtime wrapper.

name

string

required

read-only

Immutable sandbox name, provided by the client or generated by the server, used in sandbox_name path parameters.

Example:

"baseten-api-review-0916"

url

string<uri>

required

read-only

Base URL of this sandbox's execution API, always present on successful creation. The URL is assigned before deployment completes; inspect status for readiness. Use this exact returned URL; do not reconstruct its hostname. Authenticate requests with your authentication token using Authorization: Bearer . Do not send the Baseten API key directly. No additional routing headers are required. Fetch GET {url}/swagger/doc.json with that header for the API reference served by this sandbox. For example, POST {url}/process with Content-Type: application/json and {"command":"echo hello","waitForCompletion":true} executes a command and waits for its result. Execution API fields use camelCase, independently of this API's snake_case fields.

Example:

"https://sbx-baseten-api-review-0916-esb1qo.us-pdx-1.b10.run"

status

enum<string>

required

Sandbox deployment status.

Available options:

DEPLOYING,

DEPLOYED,

FAILED,

DEACTIVATING,

DEACTIVATED,

DELETING,

TERMINATED,

ARCHIVING,

ARCHIVED,

UNARCHIVING,

BUILDING,

UPLOADING

Example:

"DEPLOYED"

created_at

string<date-time>

required

read-only

Time the sandbox was created.

Example:

"2026-09-16T21:26:58.545765901Z"

lifecycle

object

Lifecycle configuration controlling automatic sandbox deletion based on idle time, max age, or specific dates

Show child attributes

Example:

{
  "expiration_policies": [
    {
      "action": "DELETE",
      "type": "TTL_IDLE",
      "value": "24h"
    },
    {
      "action": "DELETE",
      "type": "TTL_MAX_AGE",
      "value": "7d"
    },
    {
      "action": "DELETE",
      "type": "DATE",
      "value": "2026-09-23T21:26:58Z"
    }
  ],
  "terminated_retention": "24h"
}

network

object

Network configuration for a sandbox including subnet, domain filtering, and proxy settings

Show child attributes

Example:

{
  "proxy": {
    "allowed_domains": [
      "api.openai.com",
      "pypi.org",
      "files.pythonhosted.org",
      "registry.npmjs.org"
    ],
    "bypass": ["registry.npmjs.org"],
    "forbidden_domains": ["facebook.com", "*.facebook.com"],
    "routing": [
      {
        "destinations": ["api.openai.com"],
        "headers": {
          "Authorization": "Bearer {{SECRET:openai-key}}"
        },
        "body": { "user": "baseten-api-review-0916" },
        "secrets": {
          "openai-key": "sk-proj-demo-not-a-valid-api-key"
        }
      }
    ]
  },
  "subnet": "default"
}

region

string

Region where the sandbox runs (for example us-pdx-1 or eu-lon-1). When omitted at creation, the closest region is selected.

Example:

"us-pdx-1"

envs

object[]

Environment variables injected into the sandbox.

Show child attributes

Example:

[
  {
    "name": "NODE_ENV",
    "secret": false,
    "value": "production"
  },
  {
    "name": "PORT",
    "secret": false,
    "value": "3000"
  }
]

image

string

Image reference including its tag. Built-in image references are returned in the canonical baseten/ namespace. Use baseten/base-image:latest to get started with the built-in sandbox execution API. This image is available directly without building, pushing, or listing images through GET /v1/sandboxes/images.

Example:

"baseten/base-image:latest"

memory

integer

Memory allocation in megabytes. Also determines CPU allocation (CPU cores = memory in MB / 2048, e.g., 4096MB = 2 CPUs).

Required range: x >= 1

Example:

4096

ports

object[]

Set of ports for a resource

Show child attributes

Example:

[
  {
    "name": "http",
    "protocol": "HTTP",
    "target": 3000
  }
]

external_id

string

Caller-owned identifier for external lookups. Max 64 chars, alphanumeric + dash.

Maximum string length: 64

Pattern: ^[A-Za-z0-9-]+$

Example:

"api-review-20260916-001"

labels

object

Key-value pairs for organizing and filtering resources. Labels can be used to categorize resources by environment, project, team, or any custom taxonomy.

Show child attributes

Example:

{
  "env": "development",
  "project": "api-review",
  "team": "engineering"
}

updated_at

string<date-time>

read-only

Time the sandbox was last updated.

Example:

"2026-09-16T21:31:13Z"

created_by

string

read-only

User or service account that created the sandbox.

Example:

"sandbox-automation"

updated_by

string

read-only

User or service account that last updated the sandbox.

Example:

"sandbox-automation"

last_used_at

string<date-time>

read-only

Time the sandbox was last used.

Example:

"2026-09-16T21:31:13Z"

expires_in

integer

read-only

Seconds remaining before automatic deletion, when expiration is configured.

Required range: x >= 0

Example:

86400

⌘I

curl --request POST \
  --url https://api.baseten.co/v1/sandboxes/instances \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "image": "baseten/base-image:latest",
  "memory": 2048,
  "region": "us-was-1"
}
'

{
  "lifecycle": {
    "expiration_policies": [
      {
        "action": "DELETE",
        "type": "TTL_IDLE",
        "value": "24h"
      },
      {
        "action": "DELETE",
        "type": "TTL_MAX_AGE",
        "value": "7d"
      },
      {
        "action": "DELETE",
        "type": "DATE",
        "value": "2026-09-23T21:26:58Z"
      }
    ],
    "terminated_retention": "24h"
  },
  "network": {
    "proxy": {
      "allowed_domains": [
        "api.openai.com",
        "pypi.org",
        "files.pythonhosted.org",
        "registry.npmjs.org"
      ],
      "bypass": [
        "registry.npmjs.org"
      ],
      "forbidden_domains": [
        "facebook.com",
        "*.facebook.com"
      ],
      "routing": [
        {
          "destinations": [
            "api.openai.com"
          ],
          "headers": {
            "Authorization": "Bearer {{SECRET:openai-key}}"
          },
          "body": {
            "user": "baseten-api-review-0916"
          }
        }
      ]
    },
    "subnet": "default"
  },
  "region": "us-pdx-1",
  "envs": [
    {
      "name": "NODE_ENV",
      "secret": false,
      "value": "production"
    },
    {
      "name": "PORT",
      "secret": false,
      "value": "3000"
    }
  ],
  "image": "baseten/base-image:latest",
  "memory": 4096,
  "ports": [
    {
      "name": "http",
      "protocol": "HTTP",
      "target": 3000
    }
  ],
  "external_id": "api-review-20260916-001",
  "labels": {
    "env": "development",
    "project": "api-review",
    "team": "engineering"
  },
  "name": "baseten-api-review-0916",
  "url": "https://sbx-baseten-api-review-0916-esb1qo.us-pdx-1.b10.run",
  "status": "DEPLOYED",
  "created_at": "2026-09-16T21:26:58.545765901Z",
  "updated_at": "2026-09-16T21:31:13Z",
  "created_by": "sandbox-automation",
  "updated_by": "sandbox-automation",
  "last_used_at": "2026-09-16T21:31:13Z",
  "expires_in": 86400
}

{
  "code": "INVALID_REQUEST",
  "message": "One or more request parameters are invalid.",
  "details": {
    "request_id": "a3b7c4d2-91e6-4f08-9b5a-2c6d7e8f1043"
  }
}

{
  "code": "UNAUTHORIZED",
  "message": "Provide a valid authentication token in the Authorization header.",
  "details": {
    "header": "Authorization"
  }
}

{
  "code": "FORBIDDEN",
  "message": "This authentication token does not grant permission to perform this operation.",
  "details": {
    "request_id": "a3b7c4d2-91e6-4f08-9b5a-2c6d7e8f1043"
  }
}

{
  "code": "ALREADY_EXISTS",
  "message": "A sandbox with this name already exists.",
  "details": {
    "name": "baseten-api-review-0916"
  }
}

{
  "code": "RATE_LIMITED",
  "message": "Too many requests. Try again in 30 seconds.",
  "details": {
    "retry_after_seconds": 30
  }
}

{
  "code": "INTERNAL_ERROR",
  "message": "The request could not be completed. Try again later.",
  "details": {
    "request_id": "a3b7c4d2-91e6-4f08-9b5a-2c6d7e8f1043"
  }
}

Reference

Inference API

Management API

Loops API

Training API

Frontier Gateway API

CLI reference

SDKs and clients

Configuration

Metrics

Integrations

Create a sandbox

Authorizations

Headers

Query Parameters

Body

Response