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.

Path Parameters

id
string
required

ID of the agent.

Body

application/json
name
string

Name of the agent.

languages
enum<string>[]

Languages that the agent can speak.

Available options:
english,
spanish
voice_id
string

ID of the voice.

Response

200 - application/json
id
string
required

ID of the agent.

organization_id
string | null

ID of the organization.

name
string
required

Name of the agent.

languages
enum<string>[]
required

Languages that the agent can speak.

Available options:
english,
spanish
voice_id
string
required

ID of the voice.

created_at
string
required

Creation date of the agent.

Was this page helpful?

Returns a single agentReturn the logs for a call