Skip to main content
PATCH
/
agents
/
{agentId}
Update agent
curl --request PATCH \
  --url https://api.getarbol.com/v1/agents/{agentId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "primaryLanguage": "<string>",
  "systemPrompt": "<string>",
  "greeting": "<string>",
  "model": "<string>",
  "status": "ACTIVE",
  "voiceConfigs": [
    {}
  ],
  "metadata": {}
}
'
{
  "id": "<string>",
  "name": "<string>",
  "primaryLanguage": "<string>",
  "status": "ACTIVE",
  "systemPrompt": "<string>",
  "greeting": "<string>",
  "model": "<string>",
  "metadata": {},
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "supportedLanguages": [
    "<string>"
  ],
  "voiceConfigs": [
    {
      "id": "<string>",
      "voiceId": "<string>",
      "language": "<string>",
      "label": "<string>",
      "settings": {},
      "isDefault": true
    }
  ]
}

Authorizations

Authorization
string
header
required

Use your API key from the Arbol dashboard. Go to Settings > API Keys to generate one.

Path Parameters

agentId
string
required

Agent ID (agt_ prefix)

Body

application/json
name
string
primaryLanguage
string
systemPrompt
string
greeting
string
model
string
status
enum<string>
Available options:
ACTIVE,
PAUSED,
INACTIVE
voiceConfigs
object[]
metadata
object

Response

Updated agent

id
string
name
string
primaryLanguage
string
status
enum<string>
Available options:
ACTIVE,
PAUSED,
INACTIVE
systemPrompt
string
greeting
string
model
string
metadata
object
createdAt
string<date-time>
updatedAt
string<date-time>
supportedLanguages
string[]
voiceConfigs
object[]