Skip to main content
Get a launch agent manifest

Authorizations

Authorization
string
header
required

BoxRouter API key; never an upstream provider key.

Path Parameters

name
string
required

Launch agent name.

Required string length: 1 - 63
Pattern: ^[a-z][a-z0-9-]{0,62}$

Response

Agent metadata and its launch manifest.

name
string
required
Required string length: 1 - 63
Pattern: ^[a-z][a-z0-9-]{0,62}$
display_name
string
required

The agent's human-facing name.

Required string length: 1 - 128
description
string | null
required
manifest
object
required

A reusable agent environment and command. A field this schema does not list is refused with 400 before the launch is accepted. interactive defaults to true. When false, launch starts the command unattended after preparation.