Skip to main content

List all models available from the specified LLM provider in NetApp Console local deployment

POST /providerModels

Returns a list of all models available from the specified Large Language Model (LLM) provider. This endpoint queries the provider's API directly using the provided credentials to discover available models.

The request body requires provider credentials to authenticate with the provider's API. Use the provider-specific configuration object (openai, anthropic, and so on) based on the provider type.

The response contains basic model information including name, provider, and model type.

Request Body

Provider credentials required to fetch models from the LLM provider's API.

Name Type Required Description

anthropic

provider_credentials_anthropic_config

False

Anthropic Claude provider-specific configuration

commonOpenAI

provider_credentials_commonOpenAI_config

False

Generic OpenAI-compatible API configuration (for custom/self-hosted LLM proxies). Duplicate models with equivalent dot/dash notation are merged; the first occurrence is returned. commonOpenAI is an alias for the OpenAI provider with a custom baseUrl. Both map to the same AgentGateway backend type.

openai

provider_credentials_openai_config

False

OpenAI provider-specific configuration

sslVerify

boolean

False

Whether to verify SSL/TLS certificates when connecting to the provider's API endpoint. Set to false only for development or self-signed certificate environments.
Example request 
{
  "anthropic": {
    "anthropicVersion": "2023-06-01",
    "apiKey": "sk-ant-your-anthropic-key",
    "baseUrl": "https://api.anthropic.com"
  },
  "sslVerify": true
}

Response

Status: 200, Successfully retrieved the list of models from the provider.
Name Type Required Description

count

integer

False

Number of items in the current response.

items

array[providerModel_1.0_get_response_body]

True

Array of provider model resources.

type

string

True

Media type of the resource collection. Defined values are:

  • "application/vnd.netapp.bxp.providerModels"

version

string

True

Version of the resource. Defined values are:

  • "1.0"
Example response 
{
  "count": 10,
  "items": [
    {
      "modelType": "chat",
      "name": "gpt-4o",
      "provider": "openai",
      "supported": true,
      "type": "application/vnd.netapp.bxp.providerModel",
      "version": "1.0"
    }
  ],
  "type": "application/vnd.netapp.bxp.providerModels",
  "version": "1.0"
}

Response

Status: 401, Unauthorized - authentication required or invalid provider credentials.
Name Type Required Description

correlationId

string

False

Internal UUID representing the request or trace ID related.

detail

string

False

Details about the problem.

invalidParams

array[invalidParams]

False

List of invalid parameters.

status

string

True

HTTP error code related to the problem.

title

string

True

Title description of the problem.

type

string

True

Content-type of the object.

Response

Status: 403, Forbidden - insufficient permissions.
Name Type Required Description

correlationId

string

False

Internal UUID representing the request or trace ID related.

detail

string

False

Details about the problem.

invalidParams

array[invalidParams]

False

List of invalid parameters.

status

string

True

HTTP error code related to the problem.

title

string

True

Title description of the problem.

type

string

True

Content-type of the object.

Response

Status: 500, Internal server error.
Name Type Required Description

correlationId

string

False

Internal UUID representing the request or trace ID related.

detail

string

False

Details about the problem.

invalidParams

array[invalidParams]

False

List of invalid parameters.

status

string

True

HTTP error code related to the problem.

title

string

True

Title description of the problem.

type

string

True

Content-type of the object.

Response

Status: 502, Bad gateway - failed to connect to the provider's api.
Name Type Required Description

correlationId

string

False

Internal UUID representing the request or trace ID related.

detail

string

False

Details about the problem.

invalidParams

array[invalidParams]

False

List of invalid parameters.

status

string

True

HTTP error code related to the problem.

title

string

True

Title description of the problem.

type

string

True

Content-type of the object.

Error

Status: 400, Bad request - invalid request body.
Name Type Required Description

correlationId

string

False

Internal UUID representing the request or trace ID related.

detail

string

False

Details about the problem.

invalidParams

array[invalidParams]

False

List of invalid parameters.

status

string

True

HTTP error code related to the problem.

title

string

True

Title description of the problem.

type

string

True

Content-type of the object.

Definitions

See Definitions

provider_credentials_anthropic_config

Anthropic Claude provider-specific configuration

Name Type Required Description

anthropicVersion

string

False

Anthropic API version header. If not specified, defaults to 2023-06-01.

apiKey

string

True

Anthropic API key

baseUrl

string

False

Base URL for Anthropic API (optional)

extraHeaders

Additional headers to include in requests

Hash mapping strings to string

extraParams

Additional parameters to include in requests

Hash mapping strings to string

provider_credentials_commonOpenAI_config

Generic OpenAI-compatible API configuration (for custom/self-hosted LLM proxies). Duplicate models with equivalent dot/dash notation are merged; the first occurrence is returned. commonOpenAI is an alias for the OpenAI provider with a custom baseUrl. Both map to the same AgentGateway backend type.

Name Type Required Description

apiKey

string

False

API key for the OpenAI-compatible service

baseUrl

string

True

Base URL for the OpenAI-compatible API

extraHeaders

extraHeaders

False

Additional headers to include in requests

extraParams

extraParams

False

Additional parameters to include in requests

provider_credentials_openai_config

OpenAI provider-specific configuration

Name Type Required Description

apiKey

string

True

OpenAI API key

baseUrl

string

False

Base URL for OpenAI API (optional, defaults to https://api.openai.com)

organizationId

string

False

OpenAI organization ID (optional)

providerModel_1.0_get_response_body

Name Type Required Description

modelType

string

False

Type or category of the model. Defined values are:

  • "chat" - Chat completion models

  • "completion" - Text completion models

  • "embedding" - Embedding models

  • "image" - Image generation models

  • "audio" - Audio transcription/generation models

  • "multimodal" - Models supporting multiple input/output types

name

string

True

Name or identifier of the model as returned by the provider's API.

provider

string

True

Name of the LLM provider. Defined values are:

  • "openai" - OpenAI API

  • "anthropic" - Anthropic Claude API

  • "commonOpenAI" - Generic OpenAI-compatible API

supported

string

False

JSON string that indicates if the model is supported by the Agentic Platform. Defined values are:

  • true

  • false

type

string

True

Media type of the resource. Defined values are:

  • "application/vnd.netapp.bxp.providerModel"

version

string

True

Version of the resource. Defined values are:

  • "1.0"

invalidParams

Name Type Required Description

name

string

True

Name of the invalid parameter.

reason

string

True

Reason why the parameter is invalid.