Skip to main content

Interface: RegisteredAgent

Defined in: packages/orchestration/src/types.ts:158

Extends​

Properties​

additionalTools?​

optional additionalTools?: Tools

Defined in: packages/orchestration/src/types.ts:109

Tools lent to this agent for the duration of every run the orchestrator dispatches to it, passed through as ProcessOptions.additionalTools.

The agent is registered as-is: it keeps its own model, system prompt, tools and sandbox, and its own tools win a name clash.

Inherited from​

AgentRegistration.additionalTools


budgetPerTicket?​

optional budgetPerTicket?: number

Defined in: packages/orchestration/src/types.ts:111

USD.

Inherited from​

AgentRegistration.budgetPerTicket


budgetTotal?​

optional budgetTotal?: number

Defined in: packages/orchestration/src/types.ts:113

USD, over the agent's lifetime.

Inherited from​

AgentRegistration.budgetTotal


capabilities​

capabilities: string[]

Defined in: packages/orchestration/src/types.ts:84

Used for auto-assignment.

Inherited from​

AgentRegistration.capabilities


currentRuns​

currentRuns: number

Defined in: packages/orchestration/src/types.ts:160


durable?​

optional durable?: object

Defined in: packages/orchestration/src/types.ts:129

Run this agent's tickets durably, at a durable local place on this journal (startLocalRun). A ticket's run is keyed to the ticket, the agent, version and the input, and a Baleybot there checkpoints every step, so a ticket queued again after a crash, or after a yield (yieldAfterMs: the ticket goes back to queued and the next run continues), picks up at its last completed step instead of starting over. An edited description or a resume after a question is another input, and starts a new run.

journal​

journal: ExecutionJournal

policy?​

optional policy?: RunPolicy

The run policy each of this agent's runs opens with. Unset, a run gets DEFAULT_RUN_POLICY. The bot's loop reads stepIdleTimeoutMs (the model stream's stall limit), toolTimeoutMs (each ordinary tool's limit) and budget.steps; core holds budget.wallMs across the run's drives. The policy is not part of the run's identity, so changing it continues an in-flight run under the new limits. The run manager decides when a ticket runs again (a requeue, reconcile's maxRecoveries), so maxAttempts, backoff and maxInfrastructureRedrives do not apply.

version?​

optional version?: string

Bump when the agent changes, so in-flight tickets start over. Core refuses to continue a run under a changed definition, so a change without a bump fails them (incompatible-definition). Default '1'.

yieldAfterMs?​

optional yieldAfterMs?: number

Stop each run at the first step boundary after this long, progress saved (ProcessOptions.yieldAfterMs); the ticket is queued again and the next dispatch continues it. Set it under your function's time limit. Needs a Baleybot that checkpoints (the default at this place).

Inherited from​

AgentRegistration.durable


id​

id: string

Defined in: packages/orchestration/src/types.ts:159


maxConcurrent?​

optional maxConcurrent?: number

Defined in: packages/orchestration/src/types.ts:119

Maximum concurrent runs. Enforced when a run starts (dispatch, spawn and the scheduler alike) through the orchestrator's slot store, so it holds across instances when that store is shared.

Inherited from​

AgentRegistration.maxConcurrent


name​

name: string

Defined in: packages/orchestration/src/types.ts:81

Unique within the registry.

Inherited from​

AgentRegistration.name


processable?​

optional processable?: Processable<unknown, unknown>

Defined in: packages/orchestration/src/types.ts:86

Provide exactly one of processable or processableFactory.

Inherited from​

AgentRegistration.processable


processableFactory?​

optional processableFactory?: (ticket) => Processable<unknown, unknown> | Promise<Processable<unknown, unknown>>

Defined in: packages/orchestration/src/types.ts:93

Builds a fresh Processable for each run, from the ticket as that run claimed it: ticket.activeRunId is the run's id, which is what createTicketWorkerTools({ runId }) fences a worker's writes to. Provide exactly one of processable or processableFactory.

Parameters​

ticket​

Ticket

Returns​

Processable<unknown, unknown> | Promise<Processable<unknown, unknown>>

Inherited from​

AgentRegistration.processableFactory


role​

role: string

Defined in: packages/orchestration/src/types.ts:82

Inherited from​

AgentRegistration.role


status​

status: "available" | "busy" | "over_budget" | "disabled"

Defined in: packages/orchestration/src/types.ts:162


ticketTools?​

optional ticketTools?: boolean

Defined in: packages/orchestration/src/types.ts:101

Lend the agent its own ticket's tools for every run: ask_human, update_ticket and propose_ticket (createTicketWorkerTools), bound to the run's ticket and fenced to the run. They ride in ProcessOptions.additionalTools, so a tool the agent was built with, or one in additionalTools, wins a name clash.

Inherited from​

AgentRegistration.ticketTools


totalSpent​

totalSpent: number

Defined in: packages/orchestration/src/types.ts:161