List project models

GET

projects

{projectId}

models

Together AI SDK (Python)

from together import Together

client = Together()
identity = client.whoami()
if identity.type != "project_api_key":
    raise RuntimeError("TOGETHER_API_KEY must be a project API key")
project_id = identity.project.id

for model in client.models.list(project_id=project_id):
    print(model.id, model.name)

import Together from "together-ai";

const client = new Together();
const identity = await client.whoami();
if (identity.type !== "project_api_key") {
  throw new Error("TOGETHER_API_KEY must be a project API key");
}
const projectId = identity.project.id;

for await (const model of client.models.list({ projectId })) {
  console.log(model.id, model.name);
}

import Together from "together-ai";

const client = new Together();
const identity = await client.whoami();
if (identity.type !== "project_api_key") {
  throw new Error("TOGETHER_API_KEY must be a project API key");
}
const projectId = identity.project.id;

for await (const model of client.models.list({ projectId })) {
  console.log(model.id, model.name);
}

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.together.ai/v2/projects/{projectId}/models",
  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/projects/{projectId}/models"

	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/projects/{projectId}/models")

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

{
  "data": [
    {
      "id": "<string>",
      "projectId": "<string>",
      "organizationId": "<string>",
      "name": "<string>",
      "weights": {
        "type": "WEIGHTS_TYPE_DEFAULT",
        "speculatorMechanism": "SPECULATOR_MECHANISM_DRAFT",
        "draftSpeculatorType": "DRAFT_SPECULATOR_TYPE_EAGLE",
        "architecture": "<string>",
        "contextLength": "<string>",
        "parameters": {
          "total": "<string>",
          "byDtype": [
            {
              "dtype": "<string>",
              "count": "<string>"
            }
          ]
        }
      },
      "visibility": "VISIBILITY_PRIVATE",
      "description": "<string>",
      "baseModelId": "<string>",
      "baseModel": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "object": "list",
  "next_cursor": "<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

projectId

string

required

Project identifier.

Query Parameters

visibility

enum<string>

Model visibility. Private means it is scoped to the project. Internal means it is scoped to the organization.

Available options:

VISIBILITY_PRIVATE,

VISIBILITY_INTERNAL

organizationId

string

Organization whose shared models should be included. Defaults to the authenticated project's organization.

limit

integer

Maximum number of models to return.

after

string

Cursor from a previous model list response.

orderBy

string

Sort field for the results. Supports created_at, optionally followed by asc or desc. Defaults to ascending.

Response

Custom model resources and pagination metadata.

data

object[]

required

The list of models.

Show child attributes

object

any

required

Object type. Always list.

next_cursor

string

Cursor for the next page. Null if there are no more results.

⌘I

Together AI SDK (Python)

from together import Together

client = Together()
identity = client.whoami()
if identity.type != "project_api_key":
    raise RuntimeError("TOGETHER_API_KEY must be a project API key")
project_id = identity.project.id

for model in client.models.list(project_id=project_id):
    print(model.id, model.name)

import Together from "together-ai";

const client = new Together();
const identity = await client.whoami();
if (identity.type !== "project_api_key") {
  throw new Error("TOGETHER_API_KEY must be a project API key");
}
const projectId = identity.project.id;

for await (const model of client.models.list({ projectId })) {
  console.log(model.id, model.name);
}

import Together from "together-ai";

const client = new Together();
const identity = await client.whoami();
if (identity.type !== "project_api_key") {
  throw new Error("TOGETHER_API_KEY must be a project API key");
}
const projectId = identity.project.id;

for await (const model of client.models.list({ projectId })) {
  console.log(model.id, model.name);
}

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.together.ai/v2/projects/{projectId}/models",
  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/projects/{projectId}/models"

	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/projects/{projectId}/models")

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

{
  "data": [
    {
      "id": "<string>",
      "projectId": "<string>",
      "organizationId": "<string>",
      "name": "<string>",
      "weights": {
        "type": "WEIGHTS_TYPE_DEFAULT",
        "speculatorMechanism": "SPECULATOR_MECHANISM_DRAFT",
        "draftSpeculatorType": "DRAFT_SPECULATOR_TYPE_EAGLE",
        "architecture": "<string>",
        "contextLength": "<string>",
        "parameters": {
          "total": "<string>",
          "byDtype": [
            {
              "dtype": "<string>",
              "count": "<string>"
            }
          ]
        }
      },
      "visibility": "VISIBILITY_PRIVATE",
      "description": "<string>",
      "baseModelId": "<string>",
      "baseModel": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "object": "list",
  "next_cursor": "<string>"
}

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

TOGETHER APIS

SDK LIBRARIES

ERROR CODES

Authorizations

Path Parameters

Query Parameters

Response