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
OK
object
string
required
Example:

"list"

data
object[]
required

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

first_id
string
required
Example:

"asst_abc123"

last_id
string
required
Example:

"asst_abc456"

has_more
boolean
required
Example:

false