Search and retrieve user assistants

curl --request POST \
  --url http://localhost:3000/api/user/assistants \
  --header 'Content-Type: application/json' \
  --data '
{
  "type": "admin",
  "name": "cod"
}
'

{
  "success": true,
  "data": [
    {
      "_id": "688b024f7db6fe6e921399e3",
      "name": "Code Analyzer",
      "description": "The Code Analyzer systematically examines your code...",
      "status": "active",
      "liked_count": 1,
      "admin_only": false
    }
  ]
}

POST

api

user

assistants

Search and retrieve user assistants

curl --request POST \
  --url http://localhost:3000/api/user/assistants \
  --header 'Content-Type: application/json' \
  --data '
{
  "type": "admin",
  "name": "cod"
}
'

{
  "success": true,
  "data": [
    {
      "_id": "688b024f7db6fe6e921399e3",
      "name": "Code Analyzer",
      "description": "The Code Analyzer systematically examines your code...",
      "status": "active",
      "liked_count": 1,
      "admin_only": false
    }
  ]
}

Body

application/json

type

string

Type filter for assistants (e.g., "admin")

name

string

Name filter for searching assistants

Response

Successfully retrieved assistants list

success

boolean

Indicates if the request was successful

data

object[]

Array of assistant objects matching the search criteria

Show child attributes

data._id

string

Unique identifier for the assistant

data.name

string

Name of the assistant

data.description

string

Detailed description of the assistant's capabilities

data.instructions

string

Detailed instructions for the assistant's behavior

data.picture_url

string

URL to the assistant's picture

data.status

enum<string>

Current status of the assistant

Available options:

active,

inactive

data.liked_count

integer

Number of likes the assistant has received

data.admin_only

boolean

Whether the assistant is restricted to admin users only

data.created

string<date-time>

Creation timestamp of the assistant

data.institution_shared

boolean

Whether the assistant is shared across institutions

data.remember_history

integer

Number of conversation history items to remember

data.editable_others

boolean

Whether other users can edit this assistant

data.user

string

User ID who created the assistant

data.user_data

object

Show child attributes

data.user_data.email

string

data.user_data.fname

string

data.user_data.lname

string

data.user_data.accountType

string

data.argument_1

string | null

data.argument_2

string | null

data.argument_3

string | null

data.argument_4

string | null

data.argument_5

string | null

Additional argument field

Update an existing assistant Retrieve user conversation histories

⌘I

API Documentation

Runtime API

Administrator API

Search and retrieve user assistants

Body

Response