agentskit.js

RouterCandidate

Auto-generated API reference for RouterCandidate.

Interface: RouterCandidate

Defined in: adapters/src/router.ts:12

#Properties

#adapter

adapter: AdapterFactory

Defined in: adapters/src/router.ts:14


#capabilities?

optional capabilities?: AdapterCapabilities

Defined in: adapters/src/router.ts:29

Capability override. Defaults to adapter.capabilities. Used to reject candidates missing required features (e.g. tools, multiModal).


#cost?

optional cost?: number

Defined in: adapters/src/router.ts:21

Relative cost hint (lower wins for policy='cheapest'). Only relative values matter β€” use $/1M tokens or any consistent unit.


#gCO2PerKtok?

optional gCO2PerKtok?: number

Defined in: adapters/src/router.ts:38

Estimated grid CO2 intensity (gCO2eq per 1k tokens) for this adapter+region. Lower wins for policy='greenest'. Use applyCarbonTable() to populate from DEFAULT_CARBON_TABLE or a custom table.


#id

id: string

Defined in: adapters/src/router.ts:13


#latencyMs?

optional latencyMs?: number

Defined in: adapters/src/router.ts:23

Typical latency in ms. Lower wins for policy='fastest'.


#region?

optional region?: DataRegion

Defined in: adapters/src/router.ts:16

Data residency region for this adapter endpoint.


#tags?

optional tags?: string[]

Defined in: adapters/src/router.ts:31

Free-form tags used by classifier routing (e.g. 'fast', 'coding').

Explore nearby

✎ Edit this page on GitHubΒ·Found a problem? Open an issue β†’Β·How to contribute β†’

On this page

Ask the docs
Ask anything about AgentsKit. Answers come from the docs corpus and cite their sources.