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>",
"voiceConfigs": [
{}
],
"metadata": {}
}
'import requests
url = "https://api.getarbol.com/v1/agents/{agentId}"
payload = {
"name": "<string>",
"primaryLanguage": "<string>",
"systemPrompt": "<string>",
"greeting": "<string>",
"model": "<string>",
"voiceConfigs": [{}],
"metadata": {}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
primaryLanguage: '<string>',
systemPrompt: '<string>',
greeting: '<string>',
model: '<string>',
voiceConfigs: [{}],
metadata: {}
})
};
fetch('https://api.getarbol.com/v1/agents/{agentId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.getarbol.com/v1/agents/{agentId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'primaryLanguage' => '<string>',
'systemPrompt' => '<string>',
'greeting' => '<string>',
'model' => '<string>',
'voiceConfigs' => [
[
]
],
'metadata' => [
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.getarbol.com/v1/agents/{agentId}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"primaryLanguage\": \"<string>\",\n \"systemPrompt\": \"<string>\",\n \"greeting\": \"<string>\",\n \"model\": \"<string>\",\n \"voiceConfigs\": [\n {}\n ],\n \"metadata\": {}\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://api.getarbol.com/v1/agents/{agentId}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"primaryLanguage\": \"<string>\",\n \"systemPrompt\": \"<string>\",\n \"greeting\": \"<string>\",\n \"model\": \"<string>\",\n \"voiceConfigs\": [\n {}\n ],\n \"metadata\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.getarbol.com/v1/agents/{agentId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"primaryLanguage\": \"<string>\",\n \"systemPrompt\": \"<string>\",\n \"greeting\": \"<string>\",\n \"model\": \"<string>\",\n \"voiceConfigs\": [\n {}\n ],\n \"metadata\": {}\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"name": "<string>",
"primaryLanguage": "<string>",
"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
}
]
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
},
"requestId": "<string>"
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
},
"requestId": "<string>"
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
},
"requestId": "<string>"
}Agents
Update agent
Update an existing agent’s configuration, voice settings, or metadata.
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>",
"voiceConfigs": [
{}
],
"metadata": {}
}
'import requests
url = "https://api.getarbol.com/v1/agents/{agentId}"
payload = {
"name": "<string>",
"primaryLanguage": "<string>",
"systemPrompt": "<string>",
"greeting": "<string>",
"model": "<string>",
"voiceConfigs": [{}],
"metadata": {}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
primaryLanguage: '<string>',
systemPrompt: '<string>',
greeting: '<string>',
model: '<string>',
voiceConfigs: [{}],
metadata: {}
})
};
fetch('https://api.getarbol.com/v1/agents/{agentId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.getarbol.com/v1/agents/{agentId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'primaryLanguage' => '<string>',
'systemPrompt' => '<string>',
'greeting' => '<string>',
'model' => '<string>',
'voiceConfigs' => [
[
]
],
'metadata' => [
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.getarbol.com/v1/agents/{agentId}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"primaryLanguage\": \"<string>\",\n \"systemPrompt\": \"<string>\",\n \"greeting\": \"<string>\",\n \"model\": \"<string>\",\n \"voiceConfigs\": [\n {}\n ],\n \"metadata\": {}\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://api.getarbol.com/v1/agents/{agentId}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"primaryLanguage\": \"<string>\",\n \"systemPrompt\": \"<string>\",\n \"greeting\": \"<string>\",\n \"model\": \"<string>\",\n \"voiceConfigs\": [\n {}\n ],\n \"metadata\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.getarbol.com/v1/agents/{agentId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"primaryLanguage\": \"<string>\",\n \"systemPrompt\": \"<string>\",\n \"greeting\": \"<string>\",\n \"model\": \"<string>\",\n \"voiceConfigs\": [\n {}\n ],\n \"metadata\": {}\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"name": "<string>",
"primaryLanguage": "<string>",
"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
}
]
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
},
"requestId": "<string>"
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
},
"requestId": "<string>"
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
},
"requestId": "<string>"
}Authorizations
Use your API key from the Arbol dashboard. Go to Settings > API Keys to generate one.
Path Parameters
Agent ID (agt_ prefix)
Body
application/json
Response
Updated agent
⌘I