Skip to content

Sandbox / CreateSnapshotOpts

Interface: CreateSnapshotOpts

Options for creating a snapshot.

Extends

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

ts
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


name?

optional name?: string

Optional name for the snapshot template. If a snapshot template with this name already exists, a new build will be assigned to the existing template instead of creating a new one.


requestTimeoutMs?

optional requestTimeoutMs?: number

Timeout for requests to the API in milliseconds.

Default

ts
60_000 // 60 seconds

Inherited from

SandboxForkOpts.requestTimeoutMs


signal?

optional signal?: AbortSignal

An optional AbortSignal that can be used to cancel the in-flight request. When the signal is aborted, the underlying fetch is aborted and the returned promise rejects with an AbortError.

Inherited from

SandboxForkOpts.signal