Assistants

List assistants

Changed on

Returns a list of assistants.

get/assistants

Request

  • Base URL
    https://api.openai.com/v1
  • URL
    https://api.openai.com/v1/assistants
  • Auth
    HTTP bearer

Query parameters

limitinteger

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

order'asc' | 'desc'

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

afterstring

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.

beforestring

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, starting with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list.

Response

OK

objectstring required
first_idstring required
last_idstring required
has_moreboolean required

Example response

{
  "object": "list",
  "data": [
    {
      "temperature": 1,
      "top_p": 1
    }
  ],
  "first_id": "asst_abc123",
  "last_id": "asst_abc456"
}

Changes

    • info

      added the optional property // to the response with the status

    • breaking

      response property data/items/description list-of-types was widened by adding types null to media type application/json of response 200

    • breaking

      response property data/items/instructions list-of-types was widened by adding types null to media type application/json of response 200

    • breaking

      response property data/items/metadata list-of-types was widened by adding types null to media type application/json of response 200

    • breaking

      response property data/items/name list-of-types was widened by adding types null to media type application/json of response 200

    • breaking

      response property data/items/temperature list-of-types was widened by adding types null to media type application/json of response 200

    • breaking

      response property data/items/tools/items/oneOf[subschema #3: Function tool]/function/strict list-of-types was widened by adding types null to media type application/json of response 200

    • breaking

      response property data/items/top_p list-of-types was widened by adding types null to media type application/json of response 200

    • breaking

      the // response property's maxLength was unset from 512 for the response status

    • breaking

      the // response property's maxLength was unset from 256000 for the response status

    • breaking

      the // response property's maxLength was unset from 256 for the response status

    • breaking

      the // response's property type changed from object to no type for status

    • warning

      removed the optional property /// from the response with the status

    • warning

      removed the optional property /// from the response with the status

    • info

      endpoint deprecated

    • info

      added the non-success response with the status

    • info

      added subschema #2 to the // response property anyOf list for the response status

    • info

      added subschema #1 subschema #2 to the // response property anyOf list for the response status

    • info

      the response's property default value false was removed for the status

    • info

      the response's property default value 1 was removed for the status

    • info

      the response's property default value 1 was removed for the status

    • info

      response property data/items/ deprecated

    • info

      removed subschema #1 from the // response property oneOf list for the response status