Ejecutar una acción de la tool para el agente indicado
curl --request POST \
--url https://api-prod.studio.getsupervisor.ai/v1/tools/{toolId}/execute \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"agentId": "22222222-2222-4222-8222-222222222222",
"action": "scheduleCall",
"args": {
"proposed_datetime_iso": "2025-07-02T15:00:00-06:00",
"notes": "Confirmar demo",
"metadata": {
"leadId": "lead-987"
}
}
}
'import requests
url = "https://api-prod.studio.getsupervisor.ai/v1/tools/{toolId}/execute"
payload = {
"agentId": "22222222-2222-4222-8222-222222222222",
"action": "scheduleCall",
"args": {
"proposed_datetime_iso": "2025-07-02T15:00:00-06:00",
"notes": "Confirmar demo",
"metadata": { "leadId": "lead-987" }
}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
agentId: '22222222-2222-4222-8222-222222222222',
action: 'scheduleCall',
args: {
proposed_datetime_iso: '2025-07-02T15:00:00-06:00',
notes: 'Confirmar demo',
metadata: {leadId: 'lead-987'}
}
})
};
fetch('https://api-prod.studio.getsupervisor.ai/v1/tools/{toolId}/execute', 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-prod.studio.getsupervisor.ai/v1/tools/{toolId}/execute",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'agentId' => '22222222-2222-4222-8222-222222222222',
'action' => 'scheduleCall',
'args' => [
'proposed_datetime_iso' => '2025-07-02T15:00:00-06:00',
'notes' => 'Confirmar demo',
'metadata' => [
'leadId' => 'lead-987'
]
]
]),
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-prod.studio.getsupervisor.ai/v1/tools/{toolId}/execute"
payload := strings.NewReader("{\n \"agentId\": \"22222222-2222-4222-8222-222222222222\",\n \"action\": \"scheduleCall\",\n \"args\": {\n \"proposed_datetime_iso\": \"2025-07-02T15:00:00-06:00\",\n \"notes\": \"Confirmar demo\",\n \"metadata\": {\n \"leadId\": \"lead-987\"\n }\n }\n}")
req, _ := http.NewRequest("POST", 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.post("https://api-prod.studio.getsupervisor.ai/v1/tools/{toolId}/execute")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"agentId\": \"22222222-2222-4222-8222-222222222222\",\n \"action\": \"scheduleCall\",\n \"args\": {\n \"proposed_datetime_iso\": \"2025-07-02T15:00:00-06:00\",\n \"notes\": \"Confirmar demo\",\n \"metadata\": {\n \"leadId\": \"lead-987\"\n }\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-prod.studio.getsupervisor.ai/v1/tools/{toolId}/execute")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"agentId\": \"22222222-2222-4222-8222-222222222222\",\n \"action\": \"scheduleCall\",\n \"args\": {\n \"proposed_datetime_iso\": \"2025-07-02T15:00:00-06:00\",\n \"notes\": \"Confirmar demo\",\n \"metadata\": {\n \"leadId\": \"lead-987\"\n }\n }\n}"
response = http.request(request)
puts response.read_body{
"status": "ok",
"result": {
"status": "scheduled",
"scheduledFor": "2025-07-02T21:00:00Z",
"referenceId": "arn:aws:states:us-east-1:123456789012:execution:schedule-call:demo-001"
},
"metadata": {
"proposedAt": "2025-07-02T21:00:00Z",
"scheduledStart": "2025-07-02T21:00:00Z",
"scheduledEnd": "2025-07-02T21:30:00Z",
"scheduledStartLocal": "2025-07-02T16:00:00-05:00",
"scheduledEndLocal": "2025-07-02T16:30:00-05:00",
"timezone": "America/Mexico_City",
"windowSource": "standard_hours",
"windowDayOfWeek": "wednesday"
},
"toolId": "b4fec2ee-5b69-4f13-8502-0ba34d1a6c98",
"toolAgentConnectionId": "cb917332-1d51-4791-af92-35a714c916a4",
"providerRef": "retell-agent-001"
}Tools
Ejecutar una acción de la tool para el agente indicado
POST
/
v1
/
tools
/
{toolId}
/
execute
Ejecutar una acción de la tool para el agente indicado
curl --request POST \
--url https://api-prod.studio.getsupervisor.ai/v1/tools/{toolId}/execute \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"agentId": "22222222-2222-4222-8222-222222222222",
"action": "scheduleCall",
"args": {
"proposed_datetime_iso": "2025-07-02T15:00:00-06:00",
"notes": "Confirmar demo",
"metadata": {
"leadId": "lead-987"
}
}
}
'import requests
url = "https://api-prod.studio.getsupervisor.ai/v1/tools/{toolId}/execute"
payload = {
"agentId": "22222222-2222-4222-8222-222222222222",
"action": "scheduleCall",
"args": {
"proposed_datetime_iso": "2025-07-02T15:00:00-06:00",
"notes": "Confirmar demo",
"metadata": { "leadId": "lead-987" }
}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
agentId: '22222222-2222-4222-8222-222222222222',
action: 'scheduleCall',
args: {
proposed_datetime_iso: '2025-07-02T15:00:00-06:00',
notes: 'Confirmar demo',
metadata: {leadId: 'lead-987'}
}
})
};
fetch('https://api-prod.studio.getsupervisor.ai/v1/tools/{toolId}/execute', 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-prod.studio.getsupervisor.ai/v1/tools/{toolId}/execute",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'agentId' => '22222222-2222-4222-8222-222222222222',
'action' => 'scheduleCall',
'args' => [
'proposed_datetime_iso' => '2025-07-02T15:00:00-06:00',
'notes' => 'Confirmar demo',
'metadata' => [
'leadId' => 'lead-987'
]
]
]),
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-prod.studio.getsupervisor.ai/v1/tools/{toolId}/execute"
payload := strings.NewReader("{\n \"agentId\": \"22222222-2222-4222-8222-222222222222\",\n \"action\": \"scheduleCall\",\n \"args\": {\n \"proposed_datetime_iso\": \"2025-07-02T15:00:00-06:00\",\n \"notes\": \"Confirmar demo\",\n \"metadata\": {\n \"leadId\": \"lead-987\"\n }\n }\n}")
req, _ := http.NewRequest("POST", 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.post("https://api-prod.studio.getsupervisor.ai/v1/tools/{toolId}/execute")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"agentId\": \"22222222-2222-4222-8222-222222222222\",\n \"action\": \"scheduleCall\",\n \"args\": {\n \"proposed_datetime_iso\": \"2025-07-02T15:00:00-06:00\",\n \"notes\": \"Confirmar demo\",\n \"metadata\": {\n \"leadId\": \"lead-987\"\n }\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-prod.studio.getsupervisor.ai/v1/tools/{toolId}/execute")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"agentId\": \"22222222-2222-4222-8222-222222222222\",\n \"action\": \"scheduleCall\",\n \"args\": {\n \"proposed_datetime_iso\": \"2025-07-02T15:00:00-06:00\",\n \"notes\": \"Confirmar demo\",\n \"metadata\": {\n \"leadId\": \"lead-987\"\n }\n }\n}"
response = http.request(request)
puts response.read_body{
"status": "ok",
"result": {
"status": "scheduled",
"scheduledFor": "2025-07-02T21:00:00Z",
"referenceId": "arn:aws:states:us-east-1:123456789012:execution:schedule-call:demo-001"
},
"metadata": {
"proposedAt": "2025-07-02T21:00:00Z",
"scheduledStart": "2025-07-02T21:00:00Z",
"scheduledEnd": "2025-07-02T21:30:00Z",
"scheduledStartLocal": "2025-07-02T16:00:00-05:00",
"scheduledEndLocal": "2025-07-02T16:30:00-05:00",
"timezone": "America/Mexico_City",
"windowSource": "standard_hours",
"windowDayOfWeek": "wednesday"
},
"toolId": "b4fec2ee-5b69-4f13-8502-0ba34d1a6c98",
"toolAgentConnectionId": "cb917332-1d51-4791-af92-35a714c916a4",
"providerRef": "retell-agent-001"
}Authorizations
BearerAuthApiKeyAuth
Headers
Clave única por operación para asegurar idempotencia en requests mutativos. Es opcional —sin ella la petición se ejecuta igual, pero un reintento crea una ejecución nueva—. Si se envía, debe medir entre 16 y 128 caracteres; fuera de ese rango la petición responde 400.
Required string length:
16 - 128Path Parameters
Body
application/json
Response
Ejecución completada de forma síncrona
