Skip to main content
POST
Create an assistant

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Headers

X-Tenant
number
required

Tenant identifier. Send the Tenant ID in the X-Tenant header to scope API requests to a specific tenant.

Body

application/json
name
string
required

Assistant's name.

Maximum string length: 255
email
string<email>
required

Assistant's email address.

Maximum string length: 255
password
string
required

Assistant's password.

Minimum string length: 8
password_confirmation
string
required

Assistant's password confirmation. Must match the password field.

Minimum string length: 8
phone
string | null

Assistant's phone number.

Maximum string length: 20
language
string[] | null

Assistant's language preferences.

avatar_url
string | null

Assistant's avatar URL.

Maximum string length: 1000
is_active
boolean | null

Assistant's active status.

Response

The response is of type object.