List Assistant

GET

assistants

curl "https://api.portkey.ai/v1/assistants?order=desc&limit=20" \
          -H "Content-Type: application/json" \
          -H "x-portkey-api-key: $PORTKEY_API_KEY" \
          -H "x-portkey-virtual-key: $PORTKEY_PROVIDER_VIRTUAL_KEY" \
          -H "OpenAI-Beta: assistants=v2"

{
  "object": "list",
  "data": [
    {
      "id": "<string>",
      "object": "assistant",
      "created_at": 123,
      "name": "<string>",
      "description": "<string>",
      "model": "<string>",
      "instructions": "<string>",
      "tools": [],
      "tool_resources": {
        "code_interpreter": {
          "file_ids": []
        },
        "file_search": {
          "vector_store_ids": [
            "<string>"
          ]
        }
      },
      "metadata": {},
      "temperature": 1,
      "top_p": 1,
      "response_format": "none"
    }
  ],
  "first_id": "asst_abc123",
  "last_id": "asst_abc456",
  "has_more": false
}

Authorizations

x-portkey-api-key

string

header

required

x-portkey-virtual-key

string

header

required

Query Parameters

limit

integer

default:20

A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.

order

enum<string>

default:desc

Sort order by the created_at timestamp of the objects. asc for ascending order and desc for descending order.

Available options:

asc,

desc

after

string

A cursor for use in pagination. after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list.

before

string

A cursor for use in pagination. before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list.

Response

200 - application/json

object

string

required

Example:

"list"

data

object[]

required

Represents an assistant that can call the model and use tools.

data.id

string

required

The identifier, which can be referenced in API endpoints.

data.object

enum<string>

required

The object type, which is always assistant.

Available options:

assistant

data.created_at

integer

required

The Unix timestamp (in seconds) for when the assistant was created.

data.name

string | null

required

The name of the assistant. The maximum length is 256 characters.

Maximum length: 256

data.description

string | null

required

The description of the assistant. The maximum length is 512 characters.

Maximum length: 512

data.model

string

required

ID of the model to use. You can use the List models API to see all of your available models, or see our Model overview for descriptions of them.

data.instructions

string | null

required

The system instructions that the assistant uses. The maximum length is 256,000 characters.

Maximum length: 256000

data.tools

object[]

required

A list of tool enabled on the assistant. There can be a maximum of 128 tools per assistant. Tools can be of types code_interpreter, file_search, or function.

data.metadata

object | null

required

Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format. Keys can be a maximum of 64 characters long and values can be a maxium of 512 characters long.

data.tool_resources

object | null

A set of resources that are used by the assistant's tools. The resources are specific to the type of tool. For example, the code_interpreter tool requires a list of file IDs, while the file_search tool requires a list of vector store IDs.

data.temperature

number | null

default:1

What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic.

Required range: 0 <= x <= 2

Example:

1

data.top_p

number | null

default:1

An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass. So 0.1 means only the tokens comprising the top 10% probability mass are considered.

We generally recommend altering this or temperature but not both.

Required range: 0 <= x <= 1

Example:

1

data.response_format

Specifies the format that the model must output. Compatible with GPT-4o, GPT-4 Turbo, and all GPT-3.5 Turbo models since gpt-3.5-turbo-1106.

Setting to { "type": "json_object" } enables JSON mode, which guarantees the message the model generates is valid JSON.

Important: when using JSON mode, you must also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly "stuck" request. Also note that the message content may be partially cut off if finish_reason="length", which indicates the generation exceeded max_tokens or the conversation exceeded the max context length.

Available options:

none,

auto

first_id

string

required

Example:

"asst_abc123"

last_id

string

required

Example:

"asst_abc456"

has_more

boolean

required

Example:

false

Was this page helpful?

Suggest edits Raise issue

Create Assistant Retrieve Assistant

curl "https://api.portkey.ai/v1/assistants?order=desc&limit=20" \
          -H "Content-Type: application/json" \
          -H "x-portkey-api-key: $PORTKEY_API_KEY" \
          -H "x-portkey-virtual-key: $PORTKEY_PROVIDER_VIRTUAL_KEY" \
          -H "OpenAI-Beta: assistants=v2"

{
  "object": "list",
  "data": [
    {
      "id": "<string>",
      "object": "assistant",
      "created_at": 123,
      "name": "<string>",
      "description": "<string>",
      "model": "<string>",
      "instructions": "<string>",
      "tools": [],
      "tool_resources": {
        "code_interpreter": {
          "file_ids": []
        },
        "file_search": {
          "vector_store_ids": [
            "<string>"
          ]
        }
      },
      "metadata": {},
      "temperature": 1,
      "top_p": 1,
      "response_format": "none"
    }
  ],
  "first_id": "asst_abc123",
  "last_id": "asst_abc456",
  "has_more": false
}

API Reference

Chat Completions

Portkey Prompts

Embeddings

Images

Audio

Realtime

Other APIs

Completions

Moderations

Fine-tuning

Batch

Files

Assistants

Authorizations

Query Parameters

Response