Sandbox / SandboxListOpts

Interface: SandboxListOpts

Extends

• Omit<SandboxApiOpts, "signal">

Properties

apiHeaders?

optional apiHeaders?: Record<string, string>

Additional headers to send with AgentBox API requests.

Inherited from

SandboxForkOpts.apiHeaders

---

apiKey?

optional apiKey?: string

AgentBox API key to use for authentication.

Default

AGENTBOX_API_KEY // environment variable

Inherited from

SandboxForkOpts.apiKey

---

domain?

optional domain?: string

Domain to use for the API.

Default

AGENTBOX_DOMAIN // environment variable or agentbox-runtime.ru

Inherited from

SandboxForkOpts.domain

---

limit?

optional limit?: number

Number of sandboxes to return per page.

Default

100

---

nextToken?

optional nextToken?: string

Token to the next page.

---

query?

optional query?: object

Filter the list of sandboxes, e.g. by metadata metadata:{"key": "value"}, if there are multiple filters they are combined with AND.

metadata?

optional metadata?: Record<string, string>

state?

optional state?: SandboxState[]

Filter the list of sandboxes by state.

Default

['running', 'paused']

---

requestTimeoutMs?

optional requestTimeoutMs?: number

Timeout for requests to the API in milliseconds.

Default

60_000 // 60 seconds

Inherited from

SandboxForkOpts.requestTimeoutMs