Crear una conexión entre un agente y la tool indicada

curl --request POST \
  --url https://api-prod.studio.getsupervisor.ai/v1/tools/{toolId}/connections \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --header 'x-workspace-id: <x-workspace-id>' \
  --data '
{
  "agentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "connectionKey": "<string>",
  "metadata": {},
  "descriptionUsage": "Usa esta conexión cuando el usuario pregunte por campañas existentes.",
  "usageExample": "<string>"
}
'

import requests

url = "https://api-prod.studio.getsupervisor.ai/v1/tools/{toolId}/connections"

payload = {
    "agentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "connectionKey": "<string>",
    "metadata": {},
    "descriptionUsage": "Usa esta conexión cuando el usuario pregunte por campañas existentes.",
    "usageExample": "<string>"
}
headers = {
    "x-workspace-id": "<x-workspace-id>",
    "Idempotency-Key": "<idempotency-key>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'x-workspace-id': '<x-workspace-id>',
    'Idempotency-Key': '<idempotency-key>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    agentId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    connectionKey: '<string>',
    metadata: {},
    descriptionUsage: 'Usa esta conexión cuando el usuario pregunte por campañas existentes.',
    usageExample: '<string>'
  })
};

fetch('https://api-prod.studio.getsupervisor.ai/v1/tools/{toolId}/connections', 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}/connections",
  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' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'connectionKey' => '<string>',
    'metadata' => [
        
    ],
    'descriptionUsage' => 'Usa esta conexión cuando el usuario pregunte por campañas existentes.',
    'usageExample' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "Idempotency-Key: <idempotency-key>",
    "x-workspace-id: <x-workspace-id>"
  ],
]);

$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}/connections"

	payload := strings.NewReader("{\n  \"agentId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"connectionKey\": \"<string>\",\n  \"metadata\": {},\n  \"descriptionUsage\": \"Usa esta conexión cuando el usuario pregunte por campañas existentes.\",\n  \"usageExample\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-workspace-id", "<x-workspace-id>")
	req.Header.Add("Idempotency-Key", "<idempotency-key>")
	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}/connections")
  .header("x-workspace-id", "<x-workspace-id>")
  .header("Idempotency-Key", "<idempotency-key>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"agentId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"connectionKey\": \"<string>\",\n  \"metadata\": {},\n  \"descriptionUsage\": \"Usa esta conexión cuando el usuario pregunte por campañas existentes.\",\n  \"usageExample\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api-prod.studio.getsupervisor.ai/v1/tools/{toolId}/connections")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-workspace-id"] = '<x-workspace-id>'
request["Idempotency-Key"] = '<idempotency-key>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"agentId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"connectionKey\": \"<string>\",\n  \"metadata\": {},\n  \"descriptionUsage\": \"Usa esta conexión cuando el usuario pregunte por campañas existentes.\",\n  \"usageExample\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "status": "connected",
  "toolId": "<string>",
  "workspaceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "agentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "toolAgentConnectionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "providerRef": "<string>",
  "authorizationUrl": "<string>",
  "message": "<string>",
  "metadata": {},
  "descriptionUsage": "<string>",
  "usageExample": "<string>"
}

{
  "code": "<string>",
  "message": "<string>",
  "details": {
    "subcode": "<string>",
    "workspaceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  }
}

{
  "code": "<string>",
  "message": "<string>",
  "details": {
    "subcode": "<string>",
    "workspaceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  }
}

{
  "code": "<string>",
  "message": "<string>",
  "details": {
    "subcode": "<string>",
    "workspaceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  }
}

POST

tools

{toolId}

connections

Crear una conexión entre un agente y la tool indicada

curl --request POST \
  --url https://api-prod.studio.getsupervisor.ai/v1/tools/{toolId}/connections \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --header 'x-workspace-id: <x-workspace-id>' \
  --data '
{
  "agentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "connectionKey": "<string>",
  "metadata": {},
  "descriptionUsage": "Usa esta conexión cuando el usuario pregunte por campañas existentes.",
  "usageExample": "<string>"
}
'

import requests

url = "https://api-prod.studio.getsupervisor.ai/v1/tools/{toolId}/connections"

payload = {
    "agentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "connectionKey": "<string>",
    "metadata": {},
    "descriptionUsage": "Usa esta conexión cuando el usuario pregunte por campañas existentes.",
    "usageExample": "<string>"
}
headers = {
    "x-workspace-id": "<x-workspace-id>",
    "Idempotency-Key": "<idempotency-key>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'x-workspace-id': '<x-workspace-id>',
    'Idempotency-Key': '<idempotency-key>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    agentId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    connectionKey: '<string>',
    metadata: {},
    descriptionUsage: 'Usa esta conexión cuando el usuario pregunte por campañas existentes.',
    usageExample: '<string>'
  })
};

fetch('https://api-prod.studio.getsupervisor.ai/v1/tools/{toolId}/connections', 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}/connections",
  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' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'connectionKey' => '<string>',
    'metadata' => [
        
    ],
    'descriptionUsage' => 'Usa esta conexión cuando el usuario pregunte por campañas existentes.',
    'usageExample' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "Idempotency-Key: <idempotency-key>",
    "x-workspace-id: <x-workspace-id>"
  ],
]);

$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}/connections"

	payload := strings.NewReader("{\n  \"agentId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"connectionKey\": \"<string>\",\n  \"metadata\": {},\n  \"descriptionUsage\": \"Usa esta conexión cuando el usuario pregunte por campañas existentes.\",\n  \"usageExample\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-workspace-id", "<x-workspace-id>")
	req.Header.Add("Idempotency-Key", "<idempotency-key>")
	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}/connections")
  .header("x-workspace-id", "<x-workspace-id>")
  .header("Idempotency-Key", "<idempotency-key>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"agentId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"connectionKey\": \"<string>\",\n  \"metadata\": {},\n  \"descriptionUsage\": \"Usa esta conexión cuando el usuario pregunte por campañas existentes.\",\n  \"usageExample\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api-prod.studio.getsupervisor.ai/v1/tools/{toolId}/connections")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-workspace-id"] = '<x-workspace-id>'
request["Idempotency-Key"] = '<idempotency-key>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"agentId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"connectionKey\": \"<string>\",\n  \"metadata\": {},\n  \"descriptionUsage\": \"Usa esta conexión cuando el usuario pregunte por campañas existentes.\",\n  \"usageExample\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "status": "connected",
  "toolId": "<string>",
  "workspaceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "agentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "toolAgentConnectionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "providerRef": "<string>",
  "authorizationUrl": "<string>",
  "message": "<string>",
  "metadata": {},
  "descriptionUsage": "<string>",
  "usageExample": "<string>"
}

{
  "code": "<string>",
  "message": "<string>",
  "details": {
    "subcode": "<string>",
    "workspaceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  }
}

{
  "code": "<string>",
  "message": "<string>",
  "details": {
    "subcode": "<string>",
    "workspaceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  }
}

{
  "code": "<string>",
  "message": "<string>",
  "details": {
    "subcode": "<string>",
    "workspaceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  }
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

x-workspace-id

string<uuid>

required

Identificador del workspace multi-tenant.

Idempotency-Key

string

required

Clave única por operación para asegurar idempotencia en requests mutativos.

Required string length: 16 - 128

Path Parameters

toolId

string

required

Identificador de la tool en el catálogo, no su UUID (por ejemplo voice.calls, custom.http o book_appointment_cal). Se obtiene de GET /v1/tools.

Body

application/json

Payload utilizado para crear una conexión entre un agente y una tool.

agentId

string<uuid>

required

Agente propietario de la conexión.

connectionKey

string

Identificador lógico opcional para distinguir múltiples conexiones a la misma tool.

metadata

object

Información contextual para el proveedor (displayName, región, tags, etc.).

descriptionUsage

string

Guía breve (en lenguaje natural) de cuándo debe usarse esta conexión.

Example:

"Usa esta conexión cuando el usuario pregunte por campañas existentes."

usageExample

string

Ejemplo de uso recomendado (puede ser multi-línea).

auth

object

Configuración de autenticación utilizada para la conexión.

Show child attributes

Response

Conexión creada o registrada en estado pendiente

status

enum<string>

required

Estado actual de la conexión solicitada.

Available options:

connected,

pending,

error,

revoked

toolId

string

required

workspaceId

string<uuid>

required

agentId

string<uuid>

required

toolAgentConnectionId

string<uuid> | null

Identificador interno de la conexión creada cuando el estado es connected.

providerRef

string | null

Identificador de la entidad creada en el proveedor externo.

authorizationUrl

string<uri> | null

URL a la que debe dirigirse el usuario para completar el flujo cuando se requiere acción adicional.

message

string | null

Mensaje descriptivo sobre el estado de la conexión.

metadata

object

Información opcional suministrada por el adapter (p.ej. scopes otorgados).

descriptionUsage

string | null

Descripción breve de cuándo usar la conexión.

usageExample

string | null

Ejemplo multi-línea de uso recomendado.

Empezar

Referencia de endpoints

Agentes

Herramientas del agente

Telefonía

Webhooks

MCP

Crear una conexión entre un agente y la tool indicada

Authorizations

Headers

Path Parameters

Body

Response