List Assistants

Supported Providers

• OpenAI

Returns a list of assistants.

get

Authorizations

Portkey-KeyVirtual-KeyProvider-AuthProvider-NameConfigCustom-Host

Query parameters

limitintegerOptional

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

Default: 20

orderstring · enumOptional

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

Default: descPossible values:

afterstringOptional

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.

beforestringOptional

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.

Responses

200

OK

application/json

get

curlpythonjavascript

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"

200

OK

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