Skip to main content
POST
/
v1
/
tools
/
connections
/
{toolAgentConnectionId}
/
execute
Ejecutar una acción de una tool usando el toolAgentConnectionId
curl --request POST \
  --url https://api-prod.studio.getsupervisor.ai/v1/tools/connections/{toolAgentConnectionId}/execute \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --header 'x-workspace-id: <x-workspace-id>' \
  --data '
{
  "action": "<string>",
  "args": {}
}
'
{
  "status": "ok",
  "toolId": "<string>",
  "toolExecutionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "result": {},
  "metadata": {},
  "toolAgentConnectionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "providerRef": "<string>",
  "message": "<string>"
}

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
​
x-api-key
string

API Key opcional para llamadas sin token Bearer o con permisos programáticos.

Path Parameters

​
toolAgentConnectionId
string<uuid>
required

Identificador interno de la conexión agente-tool.

Body

application/json

Payload utilizado para ejecutar una acción de una tool usando una conexión existente.

​
action
string
required

Acción solicitada dentro de la tool (create, syncAgent, etc.).

Minimum string length: 1
​
args
object

Payload validado según el contrato de la tool.

Response

Ejecución completada de forma síncrona

​
status
enum<string>
required

Resultado alto nivel de la operación.

Available options:
ok,
queued,
error
​
toolId
string
required
​
toolExecutionId
string<uuid>
required

Identificador interno de la ejecución (útil para correlación y auditoría).

​
result
object

Respuesta específica del adapter.

​
metadata
object
​
toolAgentConnectionId
string<uuid> | null

Conexión utilizada para la ejecución, cuando aplica.

​
providerRef
string | null

Identificador del recurso manipulado en el proveedor externo.

​
message
string | null

Mensaje adicional (warnings, información del adapter).