Sign in

v3

latestOpenAPI 3.1.0Proprietary2026-08-07266348629.6 KB
Agents

Validate Llm Connection

Validate an LLM provider API key and model availability.

Two callable shapes:

  • Inline - raw apiKey + optional baseUrl supplied directly. Used when the user is pasting a fresh key in the form.
  • Saved connection - savedConnectionId references a stored llmConnection; BE loads the decrypted apiKey + baseUrl + provider server-side so the browser never holds the plaintext.

Calls the provider's free list-models endpoint to check key validity and model existence. The "apiKey required unless ollama or saved" rule is enforced by the request model's @model_validator. Per-tenant rate limit: 30 req/min/bucket -> 429 with Retry-After.

post/agents/validate-llm

Request body

provider'anthropic' | 'openai' | 'openai-responses' | 'ollama' | 'azure' | 'azure-openai' | 'bedrock' | 'qwen' | 'openai-compatible' required

Unified LLM provider enum.

A single AgentLlmConnection row carries one provider and a set of capabilities (chat / embedding). PROVIDER_CAPABILITIES below pins which capabilities each provider can serve — picked by the FE Connections drawer and re-validated server-side on every write.

modelstring
apiKeystring

Raw key - never stored

baseUrlstring nullable
savedConnectionIdstring nullable

If set, BE resolves provider/apiKey/baseUrl from the tenant's saved llmConnection by id and ignores the inline apiKey / baseUrl.

Response

Successful Response

object required