Skip to main content
Get launch status and phase progress

Authorizations

Authorization
string
header
required

BoxRouter API key; never an upstream provider key.

Path Parameters

operation_id
string
required

Workspace-owned launch operation returned by create.

Minimum string length: 1

Response

Current launch operation status.

Durable, workspace-owned launch work. Poll while queued or running. A succeeded operation contains its final Launch in result; a failed operation contains the original structured error, with the HTTP status recorded in failure_status. Secret values are never stored or returned.

id
string
required
Minimum string length: 1
agent
string
required
Minimum string length: 1
repo
string | null
required

Canonical resolved code repository, or null when the launch has no code checkout.

Minimum string length: 1
sha
string | null
required

Immutable commit selected for the code checkout, or null when no code is requested.

Pattern: ^[0-9a-f]{40}$
status
enum<string>
required
Available options:
queued,
running,
succeeded,
failed
current_phase
enum<string> | null
required
Available options:
preparing_image,
create,
code,
setup,
files,
background,
previews,
null
phases
object[]
required
result
object | null
required

Result of one launch. id and sandbox_id are the same BoxRouter-owned sandbox ID. The stored result of a launch. A matching idempotent retry returns this result unchanged.

error
object | null
required

Structured error retained by asynchronous execution. It has no request_id when the failure occurs after the launch request has returned 202; clients can correlate the failure by the operation id instead.

failure_status
integer | null
required
Required range: 400 <= x <= 599
created_at
string<date-time>
required
updated_at
string<date-time>
required
sandbox_id
string
Minimum string length: 1