Skip to main content
POST
/
api
/
v1
/
assistant
/
create
Create Pa
curl --request POST \
  --url https://api.example.com/api/v1/assistant/create \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "persona_preset": "organizer",
  "personality": {},
  "avatar": "default"
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "hired_agent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "persona_preset": "<string>",
  "active_skills": [
    "<string>"
  ],
  "personality": {},
  "avatar": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
name
string
required
Maximum string length: 255
​
persona_preset
string
default:organizer
Pattern: ^(organizer|shopper|family|social)$
​
personality
Personality · object
​
avatar
string
default:default
Maximum string length: 50

Response

Successful Response

​
id
string<uuid>
required
​
user_id
string<uuid>
required
​
hired_agent_id
string<uuid>
required
​
name
string
required
​
persona_preset
string
required
​
active_skills
string[]
required
​
personality
Personality · object
required
​
avatar
string
required
​
created_at
string<date-time>
required
​
updated_at
string<date-time>
required