---
title: "Test LLM Provider By Id"
method: POST
path: "/api/v1/actions/ai/llmProvider/{llmProviderId}/test"
tags: ["Smart Functions"]
---

# Test LLM Provider By Id

`POST /api/v1/actions/ai/llmProvider/{llmProviderId}/test`

## Request

- Base URL: `https://www.gooddata.ai`
- URL: `https://www.gooddata.ai/api/v1/actions/ai/llmProvider/{llmProviderId}/test`
- Auth: none declared

Tests an existing LLM provider connectivity by its ID.

## Path parameters

- `llmProviderId` string, required

## Request body

- TestLlmProviderByIdRequest
  - `models` LlmModel[]: Models overrides.
    - `family` 'OPENAI' | 'ANTHROPIC' | 'META' | 'MISTRAL' | 'AMAZON' | 'GOOGLE' | 'COHERE' | 'UNKNOWN', required
    - `id` string, required: Unique identifier of the model (e.g., gpt-5.3, claude-4.6).
  - `providerConfig` union: Provider configuration overrides.
    - AnthropicProviderConfig: Configuration for Anthropic provider.
      - `auth` AnthropicProviderAuth, required: Authentication configuration.
        - `apiKey` string, nullable: Anthropic API key.
        - `type` 'API_KEY', required: Authentication type.
      - `baseUrl` string: Custom base URL for the Anthropic API. Defaults to the official endpoint; override only for enterprise proxies or compatible gateways.
      - `type` 'ANTHROPIC', required: Provider type.
    - AwsBedrockProviderConfig: Configuration for AWS Bedrock provider.
      - `auth` BedrockProviderAuth, required: Authentication configuration.
        - `accessKeyId` string, nullable: AWS Access Key ID.
        - `secretAccessKey` string, nullable: AWS Secret Access Key.
        - `sessionToken` string, nullable: AWS Session Token (for temporary credentials).
        - `type` 'ACCESS_KEY', required: Authentication type.
      - `region` string, required: AWS region for Bedrock.
      - `type` 'AWS_BEDROCK', required: Provider type.
    - AzureFoundryProviderConfig: Configuration for Azure Foundry provider.
      - `auth` AzureFoundryProviderAuth, required: Authentication configuration.
        - `apiKey` string, nullable: Azure API key.
        - `type` 'API_KEY', required: Authentication type.
      - `endpoint` string, required: Azure OpenAI endpoint URL.
      - `type` 'AZURE_FOUNDRY', required: Provider type.
    - OpenAIProviderConfig: Configuration for OpenAI provider.
      - `auth` OpenAiProviderAuth, required: Authentication configuration.
        - `apiKey` string, nullable: OpenAI API key.
        - `type` 'API_KEY', required: Authentication type.
      - `baseUrl` string: Custom base URL for OpenAI API.
      - `organization` string, nullable: OpenAI organization ID.
      - `type` 'OPENAI', required: Provider type.

## Response `200`

OK

- TestLlmProviderResponse
  - `modelResults` ModelTestResult[], required: Per-model test results.
    - `message` string, required: Message about the model test result.
    - `modelId` string, required: The model ID that was tested.
    - `successful` boolean, required: Whether the model test was successful.
  - `providerMessage` string, required: Message about the provider connectivity test.
  - `providerReachable` boolean, required: Whether the LLM provider is reachable.

---

[API](https://skmtc.dev/gooddata/apis/gooddata-cn-oapi-all-api.md) - [All operations](https://skmtc.dev/gooddata/apis/gooddata-cn-oapi-all-api/llms.txt) - [OpenAPI document](https://skmtc.dev/gooddata/apis/gooddata-cn-oapi-all-api/revisions/c728ef303bfb?raw)