Sign in

Test Provider Connection

Test connection to an LLM provider with given configuration.

This endpoint allows testing a provider configuration before saving it.

post/llm-providers/test-connection

Request body

integration_namestring required

User-friendly name for this integration

providerstring required

LLM provider name (openai, anthropic, custom)

api_keystring required

API key for the provider

model_namestring required

Default model name for this integration

base_urlstring nullable

Custom endpoint URL (required for 'custom' provider, null for cloud)

Response

Successful Response

messagestring required

Human-readable status message

integration_idstring nullable

Integration ID (present for create/update operations)

status'success' | 'error' nullable

Operation status (for connection tests)

providerstring nullable

Provider name (for connection tests)

models_availablestring[] nullable

Available models (for connection tests)

Changes

Changed in 1 of the 8 revisions of this API.16

  • 11d1e74d88c716See the full diff
    • ▲

      request property api_key list-of-types was narrowed by removing types null from media type application/json

      request-property-list-of-types-narrowed

    • ●

      removed the request property input_cost_per_token

      request-property-removed

    • ●

      removed the request property integration_id

      request-property-removed

    • ●

      removed the request property is_default

      request-property-removed

    • ●

      removed the request property model_deprecated

      request-property-removed

    • ●

      removed the request property output_cost_per_token

      request-property-removed

    • ●

      removed the request property supports_web_search

      request-property-removed

    This revision also has 4 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog