Skip to main content
Read launch run metadata

Authorizations

Authorization
string
header
required

BoxRouter API key; never an upstream provider key.

Path Parameters

run_id
string
required

Workspace-owned launch run ID returned by createLaunchRun.

Minimum string length: 1

Query Parameters

include
enum<string>

Omit for provider-free metadata; use command for bounded command observations.

Available options:
command

Response

Stored metadata, with bounded command observations only when requested.

Plain metadata-only run response. It contains neither command observations nor output fields; GET is a provider-free read unless include=command is explicitly selected.

id
string
required
Minimum string length: 1
agent_name
string | null
required

Manifest name of the resolved catalog agent or inline manifest stored with the run; null when the stored run has none. No other launch request or manifest data is returned.

Minimum string length: 1
copies
integer
required
Required range: x >= 1
desired_state
enum<string>
required
Available options:
running,
stopped
created_at
string<date-time>
required
items
object[]
required