List assistants

GET /assistants

Returns a list of assistants.

Query parameters

  • limit integer

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

    Default value is 20.

  • order string

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

    Values are asc or desc. Default value is 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.

Responses

  • 200 application/json

    OK

    Hide response attributes Show response attributes object
    • object string Required
    • data array[object] Required

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

      Hide data attributes Show data attributes object
      • id string Required

        The identifier, which can be referenced in API endpoints.

      • object string Required

        The object type, which is always assistant.

        Value is assistant.

      • created_at integer Required

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

      • name string | null Required

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

        Maximum length is 256.

      • description string | null Required

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

        Maximum length is 512.

      • 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.

      • instructions string | null Required

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

        Maximum length is 256000.

      • tools array[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.

        Not more than 128 elements. Default value is [] (empty).

        One of:
        Code interpreter tool object FileSearch tool object Function tool object
      • 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.

        Hide tool_resources attributes Show tool_resources attributes object | null
        • code_interpreter object
          Hide code_interpreter attribute Show code_interpreter attribute object
          • file_ids array[string]

            A list of file IDs made available to the code_interpreter` tool. There can be a maximum of 20 files associated with the tool.

            Not more than 20 elements. Default value is [] (empty).

        • file_search object
          Hide file_search attribute Show file_search attribute object
          • vector_store_ids array[string]

            The ID of the vector store attached to this assistant. There can be a maximum of 1 vector store attached to the assistant.

            Not more than 1 element.

      • 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.

      • temperature number | null

        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.

        Minimum value is 0, maximum value is 2. Default value is 1.

      • top_p number | null

        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.

        Minimum value is 0, maximum value is 1. Default value is 1.

      • response_format string | null | object

        One of:
        string-1 string | null AssistantsApiResponseFormat object | null

        auto is the default value

        Values are none or auto.

    • first_id string Required
    • last_id string Required
    • has_more boolean Required
GET /assistants 
curl \
 -X GET https://api.openai.com/v1/assistants \
 -H "Authorization: Bearer $ACCESS_TOKEN"
Response examples (200) 
{
  "object": "list",
  "data": [
    {
      "id": "string",
      "object": "assistant",
      "created_at": 42,
      "name": "string",
      "description": "string",
      "model": "string",
      "instructions": "string",
      "tools": [
        {
          "type": "code_interpreter"
        }
      ],
      "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
}