List assistants | Swagger Petstore

4 parameters

limitintegeroptional

Maximum number of assistants to return per page. Must be between 1 and 100. Defaults to 20 when omitted.

Default:20

orderstringoptional

Sort order by creation date: `asc` for ascending or `desc` for descending. Defaults to `desc` when omitted.

Allowed:ascdescDefault:desc

afterstringoptional

Pagination cursor. Pass an assistant ID to retrieve results after that point in the list.

beforestringoptional

Pagination cursor. Pass an assistant ID to retrieve results before that point in the list.

2 status codes

200Returns a paginated list of assistant objects with their configurations, including id, name, model, instructions, and tools.

objectstringrequired

dataarray<Assistant>required

first_idstringrequired

last_idstringrequired

has_morebooleanrequired

429Returned when the request rate limit is exceeded.

errorobjectrequired

Error handling

limit must be between 1 and 100; values outside this range are rejected. order must be either asc or desc. A 429 is returned when the request rate limit is exceeded.

import { Client } from "acme-sdk";

const client = new Client({
  baseUrl: "https://api.acme.com",
});

const result = await client.assistants.list({ limit: 20, order: "example", after: "example", before: "example" });

{
  "object": "list",
  "data": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "object": "assistant",
      "created_at": 1,
      "name": "Jane Doe",
      "description": "A clear and helpful description.",
      "model": "example_value",
      "instructions": "example_value",
      "tools": [],
      "tool_resources": {
        "code_interpreter": {
          "file_ids": []
        },
        "file_search": {
          "vector_store_ids": [
            null
          ]
        }
      },
      "temperature": 1,
      "top_p": 1,
      "response_format": "auto"
    }
  ],
  "first_id": "asst_abc123",
  "last_id": "asst_abc456",
  "has_more": false
}

Request

Response

Errors