Skip to main content
POST
/
api
/
user
/
assistant
Create a new assistant
curl --request POST \
  --url http://localhost:3000/api/user/assistant \
  --header 'Content-Type: application/json' \
  --header 'x-access-token: <api-key>' \
  --data '
{
  "name": "New Assistant 1",
  "status": "active",
  "description": "New Assistant Description",
  "instructions": "New Assistant Instructions ",
  "user": "6430d02554cd4e00403e8b05",
  "institution": "6631915765bb0a94cfd6ca99",
  "argument_1": null,
  "argument_2": null,
  "argument_3": null,
  "argument_4": null,
  "argument_5": null,
  "picture_url": "https://learning.praxislxp.com/praxis/hugo_praxis-ai_com/wp-content/uploads/sites/60/2024/08/images.jpeg",
  "admin_only": true,
  "remember_history": 3,
  "editable_others": true,
  "institution_shared": true
}
'
{
  "success": true,
  "id": "687e761093c797174459c651",
  "message": "Assistant created!"
}

Authorizations

​
x-access-token
string
header
required

JWT token passed in x-access-token header

Body

application/json
​
name
string
required

Name of the assistant

Example:

"New Assistant 1"

​
status
enum<string>
required

Status of the assistant

Available options:
active,
inactive
Example:

"active"

​
description
string
required

Description of the assistant

Example:

"New Assistant Description"

​
instructions
string
required

Instructions for the assistant

Example:

"New Assistant Instructions "

​
user
string
required

User ID who owns this assistant

Example:

"6430d02554cd4e00403e8b05"

​
institution
string
required

Institution ID this assistant belongs to

Example:

"6631915765bb0a94cfd6ca99"

​
argument_1
string | null

Optional argument 1 for the assistant

Example:

null

​
argument_2
string | null

Optional argument 2 for the assistant

Example:

null

​
argument_3
string | null

Optional argument 3 for the assistant

Example:

null

​
argument_4
string | null

Optional argument 4 for the assistant

Example:

null

​
argument_5
string | null

Optional argument 5 for the assistant

Example:

null

​
picture_url
string

URL for the assistant's profile picture

Example:

"https://learning.praxislxp.com/praxis/hugo_praxis-ai_com/wp-content/uploads/sites/60/2024/08/images.jpeg"

​
admin_only
boolean

Whether the assistant is admin-only

Example:

true

​
remember_history
integer

Number of conversation history items to remember

Example:

3

​
editable_others
boolean

Whether the assistant can be edited by others

Example:

true

​
institution_shared
boolean

Whether the assistant is shared across the institution

Example:

true

Response

Assistant successfully created

​
success
boolean

Whether the operation was successful

Example:

true

​
id
string

ID of the created assistant

Example:

"687e761093c797174459c651"

​
message
string

Success message

Example:

"Assistant created!"