Skip to main content

Interface: ProbeProviderKeyResult

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

What probeProviderKey found.

Properties​

detail​

detail: string

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

One line for a person: the state, the HTTP status and the vendor's message (key rejected (HTTP 401): invalid x-api-key), or why there was no answer. The key never appears in it; the vendor's text has it replaced with [key], and a failed connection's error has the key and the base URL's credentials replaced with [redacted].


fingerprint​

fingerprint: string

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

The key's fingerprint (keyFingerprint): which key this was, without the key.


httpStatus?​

optional httpStatus: number

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

The HTTP status of the answer that decided the state; absent when no answer came.


model?​

optional model: string

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

The model the billable request went to; absent when no billable request was sent.


provider​

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

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

The provider probed.


retryAfterMs?​

optional retryAfterMs: number

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

The Retry-After the answer sent, in milliseconds (bounded to one hour).


state​

state: ProviderKeyState

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

What the answer says of the key.