Skip to main content

Interface: KeyProbeOptions

Defined in: packages/agentos/src/core/providers/keyProbe.ts:25

What one probe sends, beyond the key.

Properties​

baseURL?​

optional baseURL: string

Defined in: packages/agentos/src/core/providers/keyProbe.ts:32

The API base the request goes to, as the provider's baseURL takes it. Default: the provider's configured base, else its own endpoint.


kind?​

optional kind: KeyFailureKind

Defined in: packages/agentos/src/core/providers/keyProbe.ts:30

The kind of the key's last failure. billing sends the smallest billable request, since a models list can answer 200 with no credit left; any other kind, or none, sends the lightest authenticated read.


model?​

optional model: string

Defined in: packages/agentos/src/core/providers/keyProbe.ts:34

The model the billable request goes to. Default: the provider's default model, else the probe's fallback model.


signal?​

optional signal: AbortSignal

Defined in: packages/agentos/src/core/providers/keyProbe.ts:38

Ends the probe when it fires.


timeoutMs?​

optional timeoutMs: number

Defined in: packages/agentos/src/core/providers/keyProbe.ts:36

How long the probe waits for its answer, in milliseconds, at most 2,147,483,647 (a longer wait is cut to it). Default: 10 seconds.