List Models

GET/v1/modelsList Models

Returns a list of models available for use.

Parameters

page_sizenumberquery

Maximum number of models to include in a page Defaults to `20`, min value of `1`, max value of `1000`.

page_tokenstringquery

Page token provided in the `next_page_token` field of a previous response.

endpointstringquery

When provided, filters the list of models to only those that are compatible with the specified endpoint.

one of "chat", "embed", "classify", "summarize", "rerank", "rate", "generate"

default_onlybooleanquery

When provided, filters the list of models to only the default model to the endpoint. This parameter is only valid when `endpoint` is provided.

Responses

objectListModelsResponse

modelsarray of objectrequired

Show child attributes

Show array items

Contains information about the model and which API endpoints it can be used with.

context_lengthnumber

The maximum number of tokens that the model can process in a single request. Note that not all of these tokens are always available due to special tokens and preambles that Cohere has added by default.

default_endpointsarray of string

The API endpoints that the model is default to.

Show child attributes

endpointsarray of string

The API endpoints that the model is compatible with.

Show child attributes

featuresarray of string

The features that the model supports.

Show child attributes

finetunedboolean

Whether the model has been fine-tuned or not.

is_deprecatedboolean

Whether the model is deprecated or not.

namestring

Specify this name in the `model` parameter of API requests to use your chosen model.

sampling_defaultsobject

Default sampling parameters for this model when omitted from API requests.

Show child attributes

frequency_penaltynumber · float

kinteger · int32

max_tokens_per_docinteger · int32

pnumber · float

presence_penaltynumber · float

temperaturenumber · float

tokenizer_urlstring

Public URL to the tokenizer's configuration file.

next_page_tokenstring

A token to retrieve the next page of results. Provide in the page_token parameter of the next request.

Example response

{
  "models": [
    {
      "context_length": 0,
      "default_endpoints": [
        "chat"
      ],
      "endpoints": [
        "chat"
      ],
      "features": [
        "string"
      ],
      "finetuned": true,
      "is_deprecated": true,
      "name": "string",
      "sampling_defaults": {
        "frequency_penalty": 0,
        "k": 0,
        "max_tokens_per_doc": 0,
        "p": 0,
        "presence_penalty": 0,
        "temperature": 0
      },
      "tokenizer_url": "string"
    }
  ],
  "next_page_token": "string"
}

object

idstring

messagestring

Example response

{
  "id": "string",
  "message": "string"
}

object

idstring

messagestring

Example response

{
  "id": "string",
  "message": "string"
}

object

idstring

messagestring

Example response

{
  "id": "string",
  "message": "string"
}

object

idstring

messagestring

Example response

{
  "id": "string",
  "message": "string"
}

object

idstring

messagestring

Example response

{
  "id": "string",
  "message": "string"
}

object

idstring

messagestring

Example response

{
  "id": "string",
  "message": "string"
}

object

idstring

messagestring

Example response

{
  "id": "string",
  "message": "string"
}

object

idstring

messagestring

Example response

{
  "id": "string",
  "message": "string"
}

object

idstring

messagestring

Example response

{
  "id": "string",
  "message": "string"
}

object

idstring

messagestring

Example response

{
  "id": "string",
  "message": "string"
}

object

idstring

messagestring

Example response

{
  "id": "string",
  "message": "string"
}

object

idstring

messagestring

Example response

{
  "id": "string",
  "message": "string"
}

Examples

page_sizequery parameter

page_tokenquery parameter

endpointquery parameter

default_onlyquery parameter

curl -X GET 'https://api.cohere.com/v1/models?default_only=true&endpoint=chat&page_size=0&page_token=string'

const response = await fetch('https://api.cohere.com/v1/models?default_only=true&endpoint=chat&page_size=0&page_token=string', { method: 'GET' });
const data = await response.json();

const response = await fetch('https://api.cohere.com/v1/models?default_only=true&endpoint=chat&page_size=0&page_token=string', { method: 'GET' });
console.log(await response.json());

import requests

response = requests.request("GET", "https://api.cohere.com/v1/models?default_only=true&endpoint=chat&page_size=0&page_token=string")
print(response.json())

package main

import (
	"context"
	"net/http"
)

func main() {
	ctx := context.Background()
	req, err := http.NewRequestWithContext(ctx, "GET", "https://api.cohere.com/v1/models?default_only=true&endpoint=chat&page_size=0&page_token=string", nil)
	if err != nil {
		panic(err)
	}
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()
}

<?php
$request = curl_init("https://api.cohere.com/v1/models?default_only=true&endpoint=chat&page_size=0&page_token=string");
curl_setopt($request, CURLOPT_CUSTOMREQUEST, "GET");
$response = curl_exec($request);
curl_close($request);

var request = HttpRequest.newBuilder(URI.create("https://api.cohere.com/v1/models?default_only=true&endpoint=chat&page_size=0&page_token=string"))
    .method("GET", HttpRequest.BodyPublishers.noBody())
    .build();
var response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());

require 'net/http'

uri = URI("https://api.cohere.com/v1/models?default_only=true&endpoint=chat&page_size=0&page_token=string")
request = Net::HTTPGenericRequest.new("GET", false, true, uri)
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }

using var client = new HttpClient();
using var request = new HttpRequestMessage(HttpMethod.Get, "https://api.cohere.com/v1/models?default_only=true&endpoint=chat&page_size=0&page_token=string");
using var response = await client.SendAsync(request);

{
  "models": [
    {
      "context_length": 0,
      "default_endpoints": [
        "chat"
      ],
      "endpoints": [
        "chat"
      ],
      "features": [
        "string"
      ],
      "finetuned": true,
      "is_deprecated": true,
      "name": "string",
      "sampling_defaults": {
        "frequency_penalty": 0,
        "k": 0,
        "max_tokens_per_doc": 0,
        "p": 0,
        "presence_penalty": 0,
        "temperature": 0
      },
      "tokenizer_url": "string"
    }
  ],
  "next_page_token": "string"
}

{
  "id": "string",
  "message": "string"
}

{
  "id": "string",
  "message": "string"
}

{
  "id": "string",
  "message": "string"
}

{
  "id": "string",
  "message": "string"
}

{
  "id": "string",
  "message": "string"
}

{
  "id": "string",
  "message": "string"
}

{
  "id": "string",
  "message": "string"
}

{
  "id": "string",
  "message": "string"
}

{
  "id": "string",
  "message": "string"
}

{
  "id": "string",
  "message": "string"
}

{
  "id": "string",
  "message": "string"
}

{
  "id": "string",
  "message": "string"
}

Search documentation

/datasets

/connectors

/embed-jobs

/finetuning

/models

/audio/transcriptions

/batches

Operations

Parameters

Responses

/datasets

/connectors

/embed-jobs

/finetuning

/models

/audio/transcriptions

/batches

Operations