Describe a model

curl --request GET \
  --url https://api.pinecone.io/models/{model_name} \
  --header 'Api-Key: <api-key>' \
  --header 'X-Pinecone-Api-Version: <x-pinecone-api-version>'

import requests

url = "https://api.pinecone.io/models/{model_name}"

headers = {
    "Api-Key": "<api-key>",
    "X-Pinecone-Api-Version": "<x-pinecone-api-version>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: "GET", headers: {"Api-Key": "<api-key>", "X-Pinecone-Api-Version": "<x-pinecone-api-version>"}};

fetch("https://api.pinecone.io/models/{model_name}", options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.pinecone.io/models/{model_name}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Api-Key: <api-key>",
    "X-Pinecone-Api-Version: <x-pinecone-api-version>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.pinecone.io/models/{model_name}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Api-Key", "<api-key>")
	req.Header.Add("X-Pinecone-Api-Version", "<x-pinecone-api-version>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.pinecone.io/models/{model_name}")
  .header("Api-Key", "<api-key>")
  .header("X-Pinecone-Api-Version", "<x-pinecone-api-version>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.pinecone.io/models/{model_name}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Api-Key"] = '<api-key>'
request["X-Pinecone-Api-Version"] = '<x-pinecone-api-version>'

response = http.request(request)
puts response.read_body

{
  "default_dimension": 256,
  "max_batch_size": 96,
  "max_sequence_length": 512,
  "modality": "text",
  "model": "example-embedding-model",
  "provider_name": "Embedding Model Provider",
  "short_description": "An example embedding model.",
  "supported_dimensions": [
    256,
    512
  ],
  "supported_metrics": [
    "cosine",
    "euclidean"
  ],
  "supported_parameters": [
    {
      "allowed_values": [
        "value1",
        "value2"
      ],
      "parameter": "example_required_param",
      "required": true,
      "type": "one_of",
      "value_type": "string"
    },
    {
      "allowed_values": [
        "value1",
        "value2"
      ],
      "default": "value1",
      "parameter": "example_param_with_default",
      "required": false,
      "type": "one_of",
      "value_type": "string"
    },
    {
      "default": 5,
      "max": 10,
      "min": 0,
      "parameter": "example_numeric_range",
      "required": false,
      "type": "numeric_range",
      "value_type": "integer"
    }
  ],
  "type": "embed",
  "vector_type": "dense"
}

{
  "error": {
    "code": "UNAUTHENTICATED",
    "message": "Invalid API key."
  },
  "status": 401
}

{
  "error": {
    "code": "NOT_FOUND",
    "message": "Model example-model not found."
  },
  "status": 404
}

{
  "error": {
    "code": "UNKNOWN",
    "message": "Internal server error"
  },
  "status": 500
}