Skip to main content

Interface: RuntimeAgencyLaunchOptions

Defined in: packages/agentos/src/api/runtime/agencyLaunch/types.ts:131

AgentOSConfig.agencies: whether the full runtime registers launch_agency, and every launch's bounds. launch: true registers the tool, which requires LAUNCH_CAPABILITY, so only a persona granted it lists and calls it. A seat is a GMI of the runtime's GMIManager: a registered persona a launch names by personaId (in place of agentKey), or a persona made for a temporary seat from the calling GMI's (its route, completion options, capabilities and hard limits, with the seat's instructions as its prompt). Every seat runs through a view of the runtime's tools that lists and runs its allowlist alone, as the parent turn's user and organization, with no cognitive memory, no retrieval and no learner.

Extends​

Properties​

budgetShare?​

optional budgetShare: number

Defined in: packages/agentos/src/api/runtime/agencyLaunch/types.ts:95

The share of what the launching turn's budget has left that one launch may spend: above 0, at most 1, default 0.5.

Inherited from​

AgencyLaunchOptions.budgetShare


coordinator?​

optional coordinator: object

Defined in: packages/agentos/src/api/runtime/agencyLaunch/types.ts:157

The route of a launched team's manager and synthesizers (they call generateText). Default: the provider and model of the persona of the GMI that launched the team, else the GMIs' defaults (gmiManagerConfig.defaultGMIBaseConfigDefaults); when neither names a provider, the one the runtime's provider manager serves that model from, as for the GMI itself. A route that names neither apiKey nor baseUrl takes the key of the entry in modelProviderManagerConfig.providers the runtime serves its provider from (the last enabled one whose provider started), and sends it where the runtime's provider sends it: to that entry's base URL, else to the provider's own endpoint, never to a base URL a global default or an environment variable names. An entry with a base URL and no key gives its base URL alone to an Ollama route only. What the route takes nothing for, generateText resolves for the provider, key and base URL together, as for any call that names neither. A route that names either keeps what it names and takes nothing of the entry.

apiKey?​

optional apiKey: string

baseUrl?​

optional baseUrl: string

model​

model: string

provider​

provider: string


defaultDeadlineMs?​

optional defaultDeadlineMs: number

Defined in: packages/agentos/src/api/runtime/agencyLaunch/types.ts:105

The deadline of a launch that names none, in ms: default 120,000 (at most maxDeadlineMs).

Inherited from​

AgencyLaunchOptions.defaultDeadlineMs


hitl?​

optional hitl: HitlConfig

Defined in: packages/agentos/src/api/runtime/agencyLaunch/types.ts:119

The approval policy of the team a root launch builds, asked after the gate the launching turn carries. A nested launch passes that team's gate on, so beforeTool covers the seats of every team below it, each tool call asked once. beforeAgent and beforeReturn are asked in the root team alone: no nested team's seat or answer waits for them.

Inherited from​

AgencyLaunchOptions.hitl


launch?​

optional launch: boolean

Defined in: packages/agentos/src/api/runtime/agencyLaunch/types.ts:144

Registers launch_agency among the runtime's config tools, for the personas granted agency:launch: a config tool of the host's own by that name then fails initialization. Default false. A seat whose call fails rejects with its error's name and code alone, so a provider's or a handler's message reaches no model of the team and not the result; the error itself goes to the runtime's logger (the one AgentOS.create takes, else its own), at warn, under launch_agency seat <role>, as do the launch's other failures (a failed run under launch_agency run). A logger that throws fails no launch. The output guardrails that judge the launching turn's tool calls (config.evaluateToolCalls) judge each call of every seat, a nested team's included, before it runs, beside the sources the launching turn retrieved, and a call they block is refused as the launching turn's would be. The usage the runtime's spend meter (spendMeter) records for the launching turn is that turn's own model calls: a team's calls are its seats' GMIs' and its coordinator's, which the launch's result reports (usage, coordinatorUsage).


maxConcurrent?​

optional maxConcurrent: number

Defined in: packages/agentos/src/api/runtime/agencyLaunch/types.ts:93

Launches in flight at once per scope (a session at the root, a team below it): an integer from 1 to 4, default 1.

Inherited from​

AgencyLaunchOptions.maxConcurrent


maxDeadlineMs?​

optional maxDeadlineMs: number

Defined in: packages/agentos/src/api/runtime/agencyLaunch/types.ts:107

The longest deadline a launch may name, in ms: from 1,000 to 3,600,000, default 600,000.

Inherited from​

AgencyLaunchOptions.maxDeadlineMs


maxDepth?​

optional maxDepth: number

Defined in: packages/agentos/src/api/runtime/agencyLaunch/types.ts:89

The deepest team level a launch tree reaches: an integer from 1 to 4, default 2.

Inherited from​

AgencyLaunchOptions.maxDepth


maxLaunchCostUSD?​

optional maxLaunchCostUSD: number

Defined in: packages/agentos/src/api/runtime/agencyLaunch/types.ts:103

Their dollar ceiling, counted where a price row or a provider-reported cost exists; a number above 0. Default: none.

Inherited from​

AgencyLaunchOptions.maxLaunchCostUSD


maxLaunchTokens?​

optional maxLaunchTokens: number

Defined in: packages/agentos/src/api/runtime/agencyLaunch/types.ts:101

The token ceiling of all the root launches of one parent turn, their nested launches included: at least 2,000, default 200,000. gmi() warns at construction when it cannot cover one call of the agent's route (2,000 for the prompt and the call's output estimate), since every launch is then refused budget_unavailable.

Inherited from​

AgencyLaunchOptions.maxLaunchTokens


maxSeats?​

optional maxSeats: number

Defined in: packages/agentos/src/api/runtime/agencyLaunch/types.ts:91

The most seats one launch names: an integer from 1 to 12, default 5.

Inherited from​

AgencyLaunchOptions.maxSeats