List assistants

GET 
/ai/assistants

Retrieve a list of all AI Assistants configured by the user.

Responses

200: Successful Response

application/json

• Schema
• Example (from schema)

Schema

data

object[]

required

Array [

id Id (string)required

name Name (string)required

created_at date-timerequired

description Description (string)

model Model (string)required

instructions Instructions (string)required

tools

object[]

Array [

tool_id Tool Id (string)required

type Type (string)required

Possible values: [retrieval, function]

name Name (string)

description Description (string)

function

object

name Name (string)required

description Description (string)

parameters

object

type Type (string)required

properties

object

required

property name*

ParameterProperties

type Type (string)required

description Description (string)

enum string[]

required string[]required

retrieval

object

bucket_ids string[]required

]

]

{
  "data": [
    {
      "id": "string",
      "name": "string",
      "created_at": "2024-05-17T12:29:49.860Z",
      "description": "string",
      "model": "string",
      "instructions": "string",
      "tools": [
        {
          "tool_id": "string",
          "type": "retrieval",
          "name": "string",
          "description": "string",
          "function": {
            "name": "string",
            "description": "string",
            "parameters": {
              "type": "string",
              "properties": {},
              "required": [
                "string"
              ]
            }
          },
          "retrieval": {
            "bucket_ids": [
              "string"
            ]
          }
        }
      ]
    }
  ]
}

422: Validation Error

application/json

• Schema
• Example (from schema)

Schema

detail

object[]

Array [

loc

object[]

required

Array [

anyOf

• MOD1
• MOD2

string

integer

]

msg Message (string)required

type Error Type (string)required

]

{
  "detail": [
    {
      "loc": [
        "string",
        0
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Loading...