Sign in
providers

Test Provider Connection

Changed on

Test provider credentials without storing them (for the add/edit form).

Resolves the implementation from provider_type (honoring the *-compatible aliases) or the instance name, then lists the provider's models with the supplied credentials. Nothing is persisted and the key is never echoed.

post/api/v1/provider-credentials/test

Request

  • The document declares no server URL.
  • Auth: one of:
    • API key in header Otari-Key
    • API key in header x-api-key

Request body

api_basestring nullable
api_keystring nullable
client_argsobject nullable
instancestring nullable

Provider/instance name; the impl when no provider_type.

provider_typestring nullable

Response

Successful Response

discovery_unsupportedboolean

True when the test failed only because this backend serves no model-listing endpoint, so the credentials could not be verified this way but may still work for requests.

errorstring nullable
model_countinteger required
okboolean required

Changes

  • fbee488d4d9fRevision changes
    • info

      added the optional property to the response with the status

  • e27406481fffRevision changes
    • info

      api operation id test_provider_connection_api_v1_provider_credentials_test_post removed and replaced with providers-test_provider_connection