Skip to main content

Interface: ProbeProviderKeyOptions

Defined in: packages/agentos/src/api/probeProviderKey.ts:46

Options for probeProviderKey.

Properties​

apiKey​

apiKey: string

Defined in: packages/agentos/src/api/probeProviderKey.ts:50

One API key, sent as given once trimmed. A comma-separated list is refused: probe each key on its own.


baseUrl?​

optional baseUrl: string

Defined in: packages/agentos/src/api/probeProviderKey.ts:64

The provider's API base, as its baseURL takes it (https://api.anthropic.com, https://api.openai.com/v1, https://generativelanguage.googleapis.com/v1beta, https://openrouter.ai/api/v1, https://router.requesty.ai/v1 are the defaults). An empty or whitespace-only string is unset.


model?​

optional model: string

Defined in: packages/agentos/src/api/probeProviderKey.ts:58

The model the billable request goes to. Default: Anthropic claude-haiku-4-5-20251001, Gemini gemini-2.5-flash, OpenAI the first GPT chat model GET /models lists, else its first o-series model with a price (never a Responses-only one), OpenRouter and Requesty the cheapest chat model their catalog lists with a price above zero. A model the key may not use answers 403 or 404, which reads as unknown, so name one the account can call.


provider​

provider: "openai" | "openrouter" | "anthropic" | "gemini" | "requesty"

Defined in: packages/agentos/src/api/probeProviderKey.ts:48

The provider the key belongs to: anthropic, openai, gemini, openrouter or requesty.


signal?​

optional signal: AbortSignal

Defined in: packages/agentos/src/api/probeProviderKey.ts:68

Ends the probe when it fires; the probe then reports unknown.


timeoutMs?​

optional timeoutMs: number

Defined in: packages/agentos/src/api/probeProviderKey.ts:66

How long the probe waits for its answers, in milliseconds, a positive finite number. Default: 10 seconds.