Skip to main content

Retrieve an LLM model in NetApp Console local deployment

GET /supportedModels/{supported_model_id}

Returns detailed information about a specific Large Language Model (LLM) model, identified by its unique ID.

Parameters

Name Type In Required Description

supported_model_id

string

path

True

Unique identifier of the model or the model name. Defined values are:

  • Conforms to the UUIDv4 Schema

  • example: 666a3f38-d4fa-5b62-a391-a69029758d32 or Claude 3 Opus

Response

Status: 200, Successfully retrieved the model.
Name Type Required Description

contextWindow

integer

False

Maximum context window size, in tokens.

description

string

False

Human-readable description of the model. Defined values are:

  • Minimum length: 1

  • Maximum length: 1024

id

string

True

Globally unique identifier of the model. Defined values are:

  • Conforms to the UUIDv4 Schema

isEnabled

boolean

False

Indicates whether this model is currently enabled for use.

maxOutputTokens

integer

False

Maximum number of output tokens the model can generate.

metadata

type_bxp_metadata

False

Metadata associated with the resource.

modelType

string

False

The 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 of the LLM model. Defined values are:

  • Minimum length: 1

  • Maximum length: 254

provider

string

False

The LLM provider that offers this model. Defined values are:

  • "openai" - OpenAI API

  • "anthropic" - Anthropic Claude API

  • "commonOpenAI" - Generic OpenAI-compatible API

type

string

True

Media type of the resource. Defined values are:

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

version

string

True

Version of the resource. Defined values are:

  • "1.0"
Example response 
{
  "contextWindow": 128000,
  "description": "OpenAI GPT-4o multimodal model with vision and audio capabilities",
  "id": "666a3f38-d4fa-5b62-a391-a69029758d32",
  "isEnabled": true,
  "maxOutputTokens": 16384,
  "metadata": {
    "createdBy": "666a3f38-d4fa-5b62-a391-a69029758d32",
    "creationTimestamp": "2022-10-06T20:58:16.305662Z",
    "labels": [
      {
        "name": "string",
        "value": "string"
      }
    ],
    "modificationTimestamp": "2022-10-06T20:58:16.305662Z",
    "modifiedBy": "666a3f38-d4fa-5b62-a391-a69029758d32"
  },
  "modelType": "chat",
  "name": "gpt-4o",
  "provider": "openai",
  "type": "application/vnd.netapp.bxp.supportedModel",
  "version": "1.0"
}

Response

Status: 401, Unauthorized - authentication required.
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: 404, Not found - model does not exist.
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.

Error

Status: 400, Bad request - invalid model id format.
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

type_bxp_label

Name/value pair.

Name Type Required Description

name

string

True

Name of the label.

value

string

True

Value of the label.

type_bxp_metadata

Metadata associated with the resource.

Name Type Required Description

createdBy

string

False

UUID of the user who created the resource.

creationTimestamp

string

False

Resource creation date.

labels

array[type_bxp_label]

False

Array of name/value pairs representing additional information for the resource.

modificationTimestamp

string

False

Resource modification date.

modifiedBy

string

False

UUID of the user who modified the resource.

invalidParams

Name Type Required Description

name

string

True

Name of the invalid parameter.

reason

string

True

Reason why the parameter is invalid.