Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
curl --request PATCH \
--url https://app.omnivibe.com.br/platform/api/v1/agent_bots/{id} \
--header 'Content-Type: application/json' \
--header 'api_access_token: <api-key>' \
--data '
{
"name": "My Agent Bot",
"description": "This is a sample agent bot",
"outgoing_url": "https://example.com/webhook",
"account_id": 1,
"avatar": "<string>",
"avatar_url": "https://example.com/avatar.png"
}
'import requests
url = "https://app.omnivibe.com.br/platform/api/v1/agent_bots/{id}"
payload = {
"name": "My Agent Bot",
"description": "This is a sample agent bot",
"outgoing_url": "https://example.com/webhook",
"account_id": 1,
"avatar": "<string>",
"avatar_url": "https://example.com/avatar.png"
}
headers = {
"api_access_token": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {api_access_token: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: 'My Agent Bot',
description: 'This is a sample agent bot',
outgoing_url: 'https://example.com/webhook',
account_id: 1,
avatar: '<string>',
avatar_url: 'https://example.com/avatar.png'
})
};
fetch('https://app.omnivibe.com.br/platform/api/v1/agent_bots/{id}', 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://app.omnivibe.com.br/platform/api/v1/agent_bots/{id}",
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' => 'My Agent Bot',
'description' => 'This is a sample agent bot',
'outgoing_url' => 'https://example.com/webhook',
'account_id' => 1,
'avatar' => '<string>',
'avatar_url' => 'https://example.com/avatar.png'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"api_access_token: <api-key>"
],
]);
$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://app.omnivibe.com.br/platform/api/v1/agent_bots/{id}"
payload := strings.NewReader("{\n \"name\": \"My Agent Bot\",\n \"description\": \"This is a sample agent bot\",\n \"outgoing_url\": \"https://example.com/webhook\",\n \"account_id\": 1,\n \"avatar\": \"<string>\",\n \"avatar_url\": \"https://example.com/avatar.png\"\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("api_access_token", "<api-key>")
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://app.omnivibe.com.br/platform/api/v1/agent_bots/{id}")
.header("api_access_token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"My Agent Bot\",\n \"description\": \"This is a sample agent bot\",\n \"outgoing_url\": \"https://example.com/webhook\",\n \"account_id\": 1,\n \"avatar\": \"<string>\",\n \"avatar_url\": \"https://example.com/avatar.png\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.omnivibe.com.br/platform/api/v1/agent_bots/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["api_access_token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"My Agent Bot\",\n \"description\": \"This is a sample agent bot\",\n \"outgoing_url\": \"https://example.com/webhook\",\n \"account_id\": 1,\n \"avatar\": \"<string>\",\n \"avatar_url\": \"https://example.com/avatar.png\"\n}"
response = http.request(request)
puts response.read_body{
"id": 123,
"name": "<string>",
"description": "<string>",
"thumbnail": "<string>",
"outgoing_url": "<string>",
"bot_type": "<string>",
"bot_config": {},
"account_id": 123,
"access_token": "<string>",
"system_bot": true
}{
"description": "<string>",
"errors": [
{
"field": "<string>",
"message": "<string>",
"code": "<string>"
}
]
}Update an agent bot’s attributes
curl --request PATCH \
--url https://app.omnivibe.com.br/platform/api/v1/agent_bots/{id} \
--header 'Content-Type: application/json' \
--header 'api_access_token: <api-key>' \
--data '
{
"name": "My Agent Bot",
"description": "This is a sample agent bot",
"outgoing_url": "https://example.com/webhook",
"account_id": 1,
"avatar": "<string>",
"avatar_url": "https://example.com/avatar.png"
}
'import requests
url = "https://app.omnivibe.com.br/platform/api/v1/agent_bots/{id}"
payload = {
"name": "My Agent Bot",
"description": "This is a sample agent bot",
"outgoing_url": "https://example.com/webhook",
"account_id": 1,
"avatar": "<string>",
"avatar_url": "https://example.com/avatar.png"
}
headers = {
"api_access_token": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {api_access_token: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: 'My Agent Bot',
description: 'This is a sample agent bot',
outgoing_url: 'https://example.com/webhook',
account_id: 1,
avatar: '<string>',
avatar_url: 'https://example.com/avatar.png'
})
};
fetch('https://app.omnivibe.com.br/platform/api/v1/agent_bots/{id}', 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://app.omnivibe.com.br/platform/api/v1/agent_bots/{id}",
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' => 'My Agent Bot',
'description' => 'This is a sample agent bot',
'outgoing_url' => 'https://example.com/webhook',
'account_id' => 1,
'avatar' => '<string>',
'avatar_url' => 'https://example.com/avatar.png'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"api_access_token: <api-key>"
],
]);
$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://app.omnivibe.com.br/platform/api/v1/agent_bots/{id}"
payload := strings.NewReader("{\n \"name\": \"My Agent Bot\",\n \"description\": \"This is a sample agent bot\",\n \"outgoing_url\": \"https://example.com/webhook\",\n \"account_id\": 1,\n \"avatar\": \"<string>\",\n \"avatar_url\": \"https://example.com/avatar.png\"\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("api_access_token", "<api-key>")
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://app.omnivibe.com.br/platform/api/v1/agent_bots/{id}")
.header("api_access_token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"My Agent Bot\",\n \"description\": \"This is a sample agent bot\",\n \"outgoing_url\": \"https://example.com/webhook\",\n \"account_id\": 1,\n \"avatar\": \"<string>\",\n \"avatar_url\": \"https://example.com/avatar.png\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.omnivibe.com.br/platform/api/v1/agent_bots/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["api_access_token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"My Agent Bot\",\n \"description\": \"This is a sample agent bot\",\n \"outgoing_url\": \"https://example.com/webhook\",\n \"account_id\": 1,\n \"avatar\": \"<string>\",\n \"avatar_url\": \"https://example.com/avatar.png\"\n}"
response = http.request(request)
puts response.read_body{
"id": 123,
"name": "<string>",
"description": "<string>",
"thumbnail": "<string>",
"outgoing_url": "<string>",
"bot_type": "<string>",
"bot_config": {},
"account_id": 123,
"access_token": "<string>",
"system_bot": true
}{
"description": "<string>",
"errors": [
{
"field": "<string>",
"message": "<string>",
"code": "<string>"
}
]
}This token can be obtained by the system admin after creating a platformApp. This token should be used to provision agent bots, accounts, users and their roles.
The ID of the agentbot to be updated
The name of the agent bot
"My Agent Bot"
The description of the agent bot
"This is a sample agent bot"
The webhook URL for the bot
"https://example.com/webhook"
The account ID to associate the agent bot with
1
Send the form data with the avatar image binary or use the avatar_url
The url to a jpeg, png file for the agent bot avatar
"https://example.com/avatar.png"
Success
ID of the agent bot
The name of the agent bot
The description about the agent bot
The thumbnail of the agent bot
The webhook URL for the bot
The type of the bot
The configuration of the bot
Account ID if it's an account specific bot
The access token for the bot
Whether the bot is a system bot
Was this page helpful?