GET
/
v4
/
models
/
{model_id}
import SGPClient from 'sgp';

const client = new SGPClient({
  apiKey: process.env['SGP_API_KEY'], // This is the default and can be omitted
});

async function main() {
  const modelInstanceWithViews = await client.models.retrieve('model_id');

  console.log(modelInstanceWithViews.id);
}

main();
{
  "model_group": {
    "name": "<string>",
    "description": "<string>",
    "id": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "account_id": "<string>",
    "created_by_user_id": "<string>"
  },
  "deployments": [
    {
      "name": "<string>",
      "model_creation_parameters": {},
      "model_endpoint_id": "<string>",
      "model_instance_id": "<string>",
      "vendor_configuration": {
        "min_workers": 0,
        "max_workers": 1,
        "per_worker": 10,
        "vendor": "LAUNCH"
      },
      "deployment_metadata": {},
      "id": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "account_id": "<string>",
      "created_by_user_id": "<string>",
      "status": "<string>"
    }
  ],
  "name": "<string>",
  "display_name": "<string>",
  "model_vendor": "OPENAI",
  "model_type": "COMPLETION",
  "base_model_id": "<string>",
  "base_model_metadata": {
    "ui_model_section_type": "PARTNER",
    "model_developer": "<string>",
    "model_license_url": "<string>",
    "delivery_date": "<string>",
    "modelDetails": {
      "number_of_parameters": 123,
      "token_context_window": 123,
      "languages": 123,
      "alignments": 123
    }
  },
  "model_creation_parameters": {},
  "model_card": "<string>",
  "training_data_card": "<string>",
  "description": "<string>",
  "model_template_id": "<string>",
  "model_group_id": "<string>",
  "id": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "account_id": "<string>",
  "created_by_user_id": "<string>",
  "request_schema": {},
  "response_schema": {},
  "deployment_count": 123,
  "supports_multi_turn": true
}

Authorizations

x-api-key
string
header
required

Path Parameters

model_id
string
required

Query Parameters

view
enum<string>[]

Response

200
application/json

Successful Response

The response is of type object.