APapinizer
LlmProvider

Tests an LLM provider connection

Changed on

Tests an LLM provider connection Manager-side (in-process, does not persist the configuration). Unlike ApiOpsVectorDb's test-connection, the request body is OPTIONAL here: if omitted, the stored provider (resolved by name) is tested as-is; if supplied, blank apiKey/apiSecret/serviceAccountJson fields are backfilled from the stored provider — but only when the connection target (endpoint/authScheme/authHeaderName/providerType/deploymentType) is unchanged, otherwise the credential must be re-supplied.

post/apiops/projects/{projectName}/llm-providers/{providerName}/test-connection/

Request

Path parameters

projectNamestring required

Project name

providerNamestring required

LLM provider name

Request body

idstring
projectIdstring
namestring
descriptionstring
enabledboolean
projectNamestring
providerType'OPENAI' | 'ANTHROPIC' | 'AZURE_OPENAI' | 'BEDROCK' | 'VERTEX' | 'COHERE' | 'MISTRAL' | 'DEEPSEEK' | 'GROQ' | 'MOONSHOT' | 'ZHIPU' | 'QWEN_DASHSCOPE' | 'XAI' | 'GOOGLE_AI_STUDIO' | 'TOGETHER' | 'FIREWORKS' | 'CEREBRAS' | 'HUGGINGFACE' | 'OPENROUTER' | 'PERPLEXITY' | 'NVIDIA_NIM' | 'VLLM' | 'OLLAMA' | 'CUSTOM_OPENAI_COMPAT' | 'VOYAGE' | 'TYPESAFE' | 'TEI' | 'OTHER'
wireProtocol'OPENAI_COMPATIBLE' | 'ANTHROPIC' | 'GEMINI' | 'BEDROCK' | 'VLLM' | 'TYPESAFE' | 'TEI'
defaultChatCompletionPathstring
defaultEmbeddingPathstring
defaultAudioTranscriptionPathstring
defaultAudioSpeechPathstring
defaultImageGenerationPathstring
defaultResponsesPathstring
endpointstring
apiVersionstring
organizationIdstring
authScheme'BEARER' | 'API_KEY_HEADER' | 'BASIC' | 'AWS_SIGV4' | 'OAUTH2' | 'NONE' | 'CUSTOM'
authHeaderNamestring
credentialSource'GATEWAY' | 'CLIENT'
apiKeyLocation'HEADER' | 'QUERY'
apiKeyPrefixstring
allowClientOverrideboolean
apiKeystring
apiSecretstring
onlyListedModelsboolean
coldStartRetryEnabledboolean
lastHealthCheckAtstring date-time
healthStatus'UNKNOWN' | 'HEALTHY' | 'DOWN'
lastLatencyMsinteger
deploymentType'CLOUD' | 'ON_PREM' | 'OTHER'
regionstring
serviceAccountJsonstring
builtInboolean
builtInKeystring
resolvedEndpointstring
effectiveApiKeyPrefixstring
resolvedDefaultEmbeddingPathstring
resolvedDefaultAudioSpeechPathstring
resolvedDefaultResponsesPathstring
resolvedApiVersionstring
resolvedOrganizationIdstring
clientProvidedCredentialboolean
resolvedAuthHeaderNamestring
resolvedDefaultChatCompletionPathstring
resolvedDefaultAudioTranscriptionPathstring
resolvedDefaultImageGenerationPathstring
apiKeyInQueryboolean
resolvedRegionstring

Response

successful operation!

status'SUCCESS' | 'FAILURE'
resultMessagestring
resultListstring[]
resultCountinteger
unresolvedReferencesstring[]

Changes

  • e083046b24cdRevision changes
    • warning

      removed the request property

    • warning

      removed the request property

    • warning

      removed the request property

  • d1a546deccf0Revision changes
    • breaking

      request property was restricted to a list of enum values

    • breaking

      request property was restricted to a list of enum values

    • breaking

      request property was restricted to a list of enum values

    • breaking

      request property was restricted to a list of enum values

    • breaking

      request property // was restricted to a list of enum values

    • breaking

      the request property type changed from object to string

    • breaking

      the request property type changed from object to string

    • breaking

      the request property type changed from object to string

    • breaking

      the request property format changed from no format to int64

    • breaking

      the request property type changed from object to string

    • breaking

      the // request property format changed from no format to int32

    • breaking

      the // request property format changed from no format to int32

    This list may be incomplete.