POST
/
assistants
curl --request POST \
  --url https://app.happyrobot.ai/api/v1/assistants \
  --header 'Content-Type: application/json' \
  --header 'authorization: <authorization>' \
  --data '{
  "name": "Kate",
  "initial_message": "${organization.name}, how can I help?",
  "prompt": "Be a nice routing assistant.",
  "voice_id": "TNkpw4ysqcziIByMoDyz"
}'
{
  "id": "<string>",
  "organization_id": "<string>",
  "name": "Kate",
  "initial_message": "${organization.name}, how can I help?",
  "prompt": "Be a nice routing assistant.",
  "voice_id": "TNkpw4ysqcziIByMoDyz"
}

Headers

authorization
string
required

Your API key for authentication. Use Bearer format.

Body

application/json
name
string

Name of the assistant.

initial_message
string | null
required

Initial message that the assistant will say.

prompt
string | null
required

System prompt for the assistant.

voice_id
string
required

ID of the voice that the assistant will use.

  • TNkpw4ysqcziIByMoDyz: Kathryn (en-US)
  • IM1B29C0GhXeTVm8n1xY: Derrick (en-US)

Response

200 - application/json
id
string
required

ID of the assistant.

organization_id
string
required

ID of the organization that owns the assistant.

name
string

Name of the assistant.

initial_message
string | null
required

Initial message that the assistant will say.

prompt
string | null
required

System prompt for the assistant.

voice_id
string
required

ID of the voice that the assistant will use.

  • TNkpw4ysqcziIByMoDyz: Kathryn (en-US)
  • IM1B29C0GhXeTVm8n1xY: Derrick (en-US)

Was this page helpful?

Delete a note from a callUpdate Assistant