PATCH
/
agents
/
{id}
curl --request PATCH \
  --url https://app.happyrobot.ai/api/v1/agents/{id} \
  --header 'Content-Type: application/json' \
  --header 'authorization: <authorization>' \
  --data '{
  "name": "<string>",
  "languages": [
    "english"
  ],
  "voice_id": "<string>"
}'
{
  "id": "<string>",
  "organization_id": "<string>",
  "name": "<string>",
  "languages": [
    "english"
  ],
  "voice_id": "<string>",
  "created_at": "2024-01-01T01:01:01Z"
}

Headers

​
authorization
string
required

Your API key for authentication. Use Bearer format.

Example:

"Bearer API_KEY"

Path Parameters

​
id
string
required

ID of the agent.

Required string length: 24

Body

application/json
Body
​
name
string

Name of the agent.

​
languages
enum<string>[]

Languages that the agent can speak.

Available options:
english,
spanish,
portuguese,
french,
german,
polish,
romanian,
italian,
chinese,
hindi,
japanese,
swedish
​
voice_id
string

ID of the voice.

Response

200
application/json
200
​
id
string
required

ID of the agent.

​
name
string
required

Name of the agent.

​
languages
enum<string>[]
required

Languages that the agent can speak.

Available options:
english,
spanish,
portuguese,
french,
german,
polish,
romanian,
italian,
chinese,
hindi,
japanese,
swedish
​
voice_id
string
required

ID of the voice.

​
created_at
string
required

Creation date of the agent.

Example:

"2024-01-01T01:01:01Z"

​
organization_id
string | null

ID of the organization.

Was this page helpful?

Create a new agentDelete an agent