List assistants | Sample

4 parameters

limitintegeroptional

Maximum number of assistants to return, from 1 to 100. Defaults to 20 when omitted.

Default:20

orderstringoptional

Sort order by creation time: `asc` or `desc`. Defaults to `desc` when omitted.

Allowed:ascdescDefault:desc

afterstringoptional

Pagination cursor identifying the assistant after which to return results.

beforestringoptional

Pagination cursor identifying the assistant before which to return results.

2 status codes

200Returns a list object containing assistant data, the first and last assistant identifiers, and a boolean indicating whether more results are available.

objectstringrequired

dataarray<Assistant>required

first_idstringrequired

last_idstringrequired

has_morebooleanrequired

429Returned when the request was rejected because the rate limit was exceeded.

errorobjectrequired

Error handling

A 429 is returned when the request exceeds the rate limit. limit must be between 1 and 100, and order must be asc or desc when supplied.

import { Client } from "acme-sdk";

const client = new Client({
  baseUrl: "https://api.acme.com",
  auth: { bearer: process.env.API_TOKEN },
  retry: {
    maxAttempts: 3,
    retryOn: [
      408,
      425,
      429,
      500,
      502,
      503,
      504,
    ],
    backoffMs: 500,
    maxBackoffMs: 8000,
  },
  timeoutMs: 30000,
});

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": "Example Name",
      "description": "Example 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