Skip to main content
POST
/
v1
/
tools
/
connections
Crear una conexión entre un agente y una tool (por body)
curl --request POST \
  --url https://api-prod.studio.getsupervisor.ai/v1/tools/connections \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --header 'x-workspace-id: <x-workspace-id>' \
  --data '
{
  "toolId": "<string>",
  "agentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "connectionKey": "<string>",
  "metadata": {},
  "auth": {
    "type": "none",
    "data": {}
  }
}
'
{
  "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": {}
}

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

Body

application/json

Payload utilizado para crear una conexión entre un agente y una tool indicando la tool en el body.

​
toolId
string
required

Identificador interno de la tool (snake_case).

​
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.).

​
auth
object

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

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).