Get a supported model

GET

supported-models

{id}

Together AI SDK (Python)

from together import Together

client = Together()

model = client.models.retrieve_supported("arch_abc123")
print(model.name, model.deployment_profiles)

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.together.ai/v2/supported-models/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$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.together.ai/v2/supported-models/{id}"

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

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.together.ai/v2/supported-models/{id}")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

{
  "id": "<string>",
  "name": "<string>",
  "displayName": "<string>",
  "inputModalities": [
    "MODALITY_TEXT"
  ],
  "outputModalities": [
    "MODALITY_TEXT"
  ],
  "products": [
    "PRODUCT_SERVERLESS"
  ],
  "capabilities": [
    "CAPABILITY_CHAT"
  ],
  "publisher": "<string>",
  "status": "SUPPORTED_MODEL_STATUS_RECOMMENDED",
  "displayType": "<string>",
  "baseModelId": "<string>",
  "baseModel": "<string>",
  "deploymentProfiles": [
    {
      "profileId": "<string>",
      "certifiedConfigRevisionId": "<string>",
      "certifiedModelRevisionId": "<string>",
      "gpuType": "<string>",
      "gpuCount": 123,
      "quantization": "<string>",
      "performanceBenchmarks": {
        "decodingSpeedTps": 123,
        "timeToFirstTokenMs": 123,
        "maxContextLength": "<string>"
      },
      "config": "<string>",
      "model": "<string>",
      "parallelism": "<string>",
      "modelName": "<string>",
      "adapterMode": "ADAPTER_MODE_FIXED"
    }
  ],
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "description": "<string>",
  "features": [
    "FEATURE_TOOL_CALLING"
  ],
  "architecture": "<string>",
  "contextLength": "<string>",
  "tags": [
    "<string>"
  ],
  "inputFormat": "<string>",
  "outputFormat": "<string>",
  "serverlessEndpoint": "<string>",
  "pricing": {
    "input": 123,
    "output": 123,
    "cachedInput": 123
  },
  "familyId": "<string>"
}

{
  "error": {
    "message": "<string>",
    "type": "<string>",
    "param": null,
    "code": null
  }
}

Authorizations

Authorization

string

header

default:default

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

string

required

Supported model identifier.

Response

Curated catalog entry for a platform-supported model.

string

required

Unique ID of the deployable Together-hosted base model.

name

string

required

Catalog-controlled HF model ID used for inference.

displayName

string

required

Catalog-controlled human-readable model name.

inputModalities

enum<string>[]

required

Input modalities supported by the model.

Available options:

MODALITY_TEXT,

MODALITY_IMAGE,

MODALITY_AUDIO,

MODALITY_VIDEO

outputModalities

enum<string>[]

required

Output modalities produced by the model.

Available options:

MODALITY_TEXT,

MODALITY_IMAGE,

MODALITY_AUDIO,

MODALITY_VIDEO

products

enum<string>[]

required

Product surfaces where the model is offered.

Available options:

PRODUCT_SERVERLESS,

PRODUCT_DEDICATED,

PRODUCT_FINE_TUNING,

PRODUCT_RESERVED

capabilities

enum<string>[]

required

High-level tasks the model supports.

Available options:

CAPABILITY_CHAT,

CAPABILITY_EMBEDDING,

CAPABILITY_RERANKING,

CAPABILITY_IMAGE_GENERATION,

CAPABILITY_VIDEO_GENERATION

publisher

string

required

Organization or publisher associated with the model.

status

enum<string>

required

Catalog recommendation status for the model.

Available options:

SUPPORTED_MODEL_STATUS_RECOMMENDED,

SUPPORTED_MODEL_STATUS_SUPPORTED,

SUPPORTED_MODEL_STATUS_DEPRECATED,

SUPPORTED_MODEL_STATUS_HIDDEN

displayType

string

required

UI-facing model type badge, such as chat, language, code, image, embedding, rerank, moderation, audio, video, or transcribe.

baseModelId

string

required

Bare model ID for the architecture's base model; empty when no base model is linked.

baseModel

string

required

Resource name for the base model as projects/{projectId}/models/{modelId}; empty when unresolved.

deploymentProfiles

object[]

required

Certified deployment profiles available for the model.

Show child attributes

createdAt

string<date-time>

required

Timestamp when the catalog entry was created.

updatedAt

string<date-time>

required

Timestamp when the catalog entry was last updated.

description

string

Human-readable model description.

features

enum<string>[]

Advanced features exposed by the model.

Available options:

FEATURE_TOOL_CALLING,

FEATURE_STRUCTURED_OUTPUT,

FEATURE_REASONING

architecture

string

Model architecture from the underlying weights metadata.

contextLength

string

Maximum context length from the underlying weights metadata.

tags

string[]

Searchable catalog tags for the model.

inputFormat

string

Preferred input format for the model.

outputFormat

string

Preferred output format for the model.

serverlessEndpoint

string

Serverless endpoint name for inference, if available.

pricing

object

Serverless pricing in USD per one million tokens, if available.

Show child attributes

familyId

string

Model family identifier for related catalog entries.

⌘I

Together AI SDK (Python)

from together import Together

client = Together()

model = client.models.retrieve_supported("arch_abc123")
print(model.name, model.deployment_profiles)

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.together.ai/v2/supported-models/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$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.together.ai/v2/supported-models/{id}"

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

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.together.ai/v2/supported-models/{id}")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

{
  "id": "<string>",
  "name": "<string>",
  "displayName": "<string>",
  "inputModalities": [
    "MODALITY_TEXT"
  ],
  "outputModalities": [
    "MODALITY_TEXT"
  ],
  "products": [
    "PRODUCT_SERVERLESS"
  ],
  "capabilities": [
    "CAPABILITY_CHAT"
  ],
  "publisher": "<string>",
  "status": "SUPPORTED_MODEL_STATUS_RECOMMENDED",
  "displayType": "<string>",
  "baseModelId": "<string>",
  "baseModel": "<string>",
  "deploymentProfiles": [
    {
      "profileId": "<string>",
      "certifiedConfigRevisionId": "<string>",
      "certifiedModelRevisionId": "<string>",
      "gpuType": "<string>",
      "gpuCount": 123,
      "quantization": "<string>",
      "performanceBenchmarks": {
        "decodingSpeedTps": 123,
        "timeToFirstTokenMs": 123,
        "maxContextLength": "<string>"
      },
      "config": "<string>",
      "model": "<string>",
      "parallelism": "<string>",
      "modelName": "<string>",
      "adapterMode": "ADAPTER_MODE_FIXED"
    }
  ],
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "description": "<string>",
  "features": [
    "FEATURE_TOOL_CALLING"
  ],
  "architecture": "<string>",
  "contextLength": "<string>",
  "tags": [
    "<string>"
  ],
  "inputFormat": "<string>",
  "outputFormat": "<string>",
  "serverlessEndpoint": "<string>",
  "pricing": {
    "input": 123,
    "output": 123,
    "cachedInput": 123
  },
  "familyId": "<string>"
}

{
  "error": {
    "message": "<string>",
    "type": "<string>",
    "param": null,
    "code": null
  }
}

TOGETHER APIS

SDK LIBRARIES

ERROR CODES

Authorizations

Path Parameters

Response