Listar ferramentas de uso durante a chamada
curl --request GET \
--url https://api.example.com/user/tools \
--header 'Accept: <accept>' \
--header 'Authorization: <authorization>' \
--header 'Content-Type: <content-type>'import requests
url = "https://api.example.com/user/tools"
headers = {
"Authorization": "<authorization>",
"Content-Type": "<content-type>",
"Accept": "<accept>"
}
response = requests.get(url, headers=headers)
print(response.text)const options = {
method: 'GET',
headers: {
Authorization: '<authorization>',
'Content-Type': '<content-type>',
Accept: '<accept>'
}
};
fetch('https://api.example.com/user/tools', 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.example.com/user/tools",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Accept: <accept>",
"Authorization: <authorization>",
"Content-Type: <content-type>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/user/tools"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "<authorization>")
req.Header.Add("Content-Type", "<content-type>")
req.Header.Add("Accept", "<accept>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.example.com/user/tools")
.header("Authorization", "<authorization>")
.header("Content-Type", "<content-type>")
.header("Accept", "<accept>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/user/tools")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = '<authorization>'
request["Content-Type"] = '<content-type>'
request["Accept"] = '<accept>'
response = http.request(request)
puts response.read_body[
{
"id": 1,
"name": "get_weather",
"description": "Use esta ferramenta para obter o clima atual de uma cidade específica. Utilize quando o cliente perguntar sobre condições climáticas.",
"endpoint": "https://api.openweathermap.org/data/2.5/weather",
"method": "GET",
"timeout": 10,
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer sk_..."
}
],
"schema": [
{
"name": "city",
"type": "string",
"description": "Nome da cidade para consulta do clima"
},
{
"name": "temperature",
"type": "number",
"description": "Valor da temperatura atual"
},
{
"name": "is_raining",
"type": "boolean",
"description": "Indica se está chovendo no momento"
}
],
"created_at": "2025-10-10T12:00:00.000000Z",
"updated_at": "2025-10-10T12:00:00.000000Z"
},
{
"id": 2,
"name": "send_notification",
"description": "Use esta ferramenta para enviar uma notificação ao cliente. Utilize quando o cliente solicitar atualizações.",
"endpoint": "https://api.suaempresa.com/notifications/send",
"method": "POST",
"timeout": 15,
"headers": [
{
"name": "Content-Type",
"value": "application/json"
}
],
"schema": [
{
"name": "message",
"type": "string",
"description": "Mensagem da notificação a ser enviada"
},
{
"name": "priority_level",
"type": "number",
"description": "Nível de prioridade de 1 a 5"
},
{
"name": "send_sms",
"type": "boolean",
"description": "Indica se também deve enviar notificação por SMS"
}
],
"created_at": "2025-10-09T14:30:00.000000Z",
"updated_at": "2025-10-10T09:15:00.000000Z"
}
]
Mid Call Tools
Listar ferramentas de uso durante a chamada
Lista todas as ferramentas de uso durante a chamada disponíveis na conta OmniTech, com paginação e detalhes de configuração de cada integração.
GET
/
user
/
tools
Listar ferramentas de uso durante a chamada
curl --request GET \
--url https://api.example.com/user/tools \
--header 'Accept: <accept>' \
--header 'Authorization: <authorization>' \
--header 'Content-Type: <content-type>'import requests
url = "https://api.example.com/user/tools"
headers = {
"Authorization": "<authorization>",
"Content-Type": "<content-type>",
"Accept": "<accept>"
}
response = requests.get(url, headers=headers)
print(response.text)const options = {
method: 'GET',
headers: {
Authorization: '<authorization>',
'Content-Type': '<content-type>',
Accept: '<accept>'
}
};
fetch('https://api.example.com/user/tools', 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.example.com/user/tools",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Accept: <accept>",
"Authorization: <authorization>",
"Content-Type: <content-type>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/user/tools"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "<authorization>")
req.Header.Add("Content-Type", "<content-type>")
req.Header.Add("Accept", "<accept>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.example.com/user/tools")
.header("Authorization", "<authorization>")
.header("Content-Type", "<content-type>")
.header("Accept", "<accept>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/user/tools")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = '<authorization>'
request["Content-Type"] = '<content-type>'
request["Accept"] = '<accept>'
response = http.request(request)
puts response.read_body[
{
"id": 1,
"name": "get_weather",
"description": "Use esta ferramenta para obter o clima atual de uma cidade específica. Utilize quando o cliente perguntar sobre condições climáticas.",
"endpoint": "https://api.openweathermap.org/data/2.5/weather",
"method": "GET",
"timeout": 10,
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer sk_..."
}
],
"schema": [
{
"name": "city",
"type": "string",
"description": "Nome da cidade para consulta do clima"
},
{
"name": "temperature",
"type": "number",
"description": "Valor da temperatura atual"
},
{
"name": "is_raining",
"type": "boolean",
"description": "Indica se está chovendo no momento"
}
],
"created_at": "2025-10-10T12:00:00.000000Z",
"updated_at": "2025-10-10T12:00:00.000000Z"
},
{
"id": 2,
"name": "send_notification",
"description": "Use esta ferramenta para enviar uma notificação ao cliente. Utilize quando o cliente solicitar atualizações.",
"endpoint": "https://api.suaempresa.com/notifications/send",
"method": "POST",
"timeout": 15,
"headers": [
{
"name": "Content-Type",
"value": "application/json"
}
],
"schema": [
{
"name": "message",
"type": "string",
"description": "Mensagem da notificação a ser enviada"
},
{
"name": "priority_level",
"type": "number",
"description": "Nível de prioridade de 1 a 5"
},
{
"name": "send_sms",
"type": "boolean",
"description": "Indica se também deve enviar notificação por SMS"
}
],
"created_at": "2025-10-09T14:30:00.000000Z",
"updated_at": "2025-10-10T09:15:00.000000Z"
}
]
Este endpoint permite recuperar todas as ferramentas de uso durante a chamada. As ferramentas de mid call permitem que seus assistentes de IA interajam com APIs externas durante uma ligação.
Atribuindo Ferramentas aos Assistentes
Para utilizar estas ferramentas com assistentes, consulte:
Criar Assistente – Utilize o parâmetro tool_ids para anexar ferramentas
Atualizar Assistente – Gerencie as atribuições de ferramentas utilizando o parâmetro tool_ids
Headers
Token Bearer para autenticação
Deve ser
application/jsonDeve ser
application/jsonCampos da Resposta
Array de ferramentas de uso durante a chamada
Show propriedades
Show propriedades
Identificador único da ferramenta
Nome da ferramenta (minúsculas com underscore)
Explicação detalhada de quando e como a IA deve utilizar esta ferramenta
URL do endpoint da API que será chamado
Método HTTP (GET, POST, PUT, PATCH, DELETE)
Timeout da requisição em segundos (1-30)
Timestamp ISO 8601 de criação da ferramenta
Timestamp ISO 8601 da última atualização da ferramenta
[
{
"id": 1,
"name": "get_weather",
"description": "Use esta ferramenta para obter o clima atual de uma cidade específica. Utilize quando o cliente perguntar sobre condições climáticas.",
"endpoint": "https://api.openweathermap.org/data/2.5/weather",
"method": "GET",
"timeout": 10,
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer sk_..."
}
],
"schema": [
{
"name": "city",
"type": "string",
"description": "Nome da cidade para consulta do clima"
},
{
"name": "temperature",
"type": "number",
"description": "Valor da temperatura atual"
},
{
"name": "is_raining",
"type": "boolean",
"description": "Indica se está chovendo no momento"
}
],
"created_at": "2025-10-10T12:00:00.000000Z",
"updated_at": "2025-10-10T12:00:00.000000Z"
},
{
"id": 2,
"name": "send_notification",
"description": "Use esta ferramenta para enviar uma notificação ao cliente. Utilize quando o cliente solicitar atualizações.",
"endpoint": "https://api.suaempresa.com/notifications/send",
"method": "POST",
"timeout": 15,
"headers": [
{
"name": "Content-Type",
"value": "application/json"
}
],
"schema": [
{
"name": "message",
"type": "string",
"description": "Mensagem da notificação a ser enviada"
},
{
"name": "priority_level",
"type": "number",
"description": "Nível de prioridade de 1 a 5"
},
{
"name": "send_sms",
"type": "boolean",
"description": "Indica se também deve enviar notificação por SMS"
}
],
"created_at": "2025-10-09T14:30:00.000000Z",
"updated_at": "2025-10-10T09:15:00.000000Z"
}
]
⌘I