Skip to main content
GET
/
user
/
tools
Listar ferramentas utilizadas durante a chamada
curl --request GET \
  --url https://suasofia.online/api/user/tools \
  --header 'Accept: <accept>' \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: <content-type>'
[
  {
    "id": 1,
    "name": "get_weather",
    "description": "Use esta ferramenta para obter o clima atual em uma cidade específica. Chame isto 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": "O nome da cidade para obter o clima"
      },
      {
        "name": "temperature",
        "type": "number",
        "description": "Valor da temperatura atual"
      },
      {
        "name": "is_raining",
        "type": "boolean",
        "description": "Se está chovendo atualmente"
      }
    ],
    "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. Chame isto 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": "A mensagem de 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": "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 que você recupere todas as ferramentas utilizadas durante a chamada. As ferramentas utilizadas durante a chamada permitem que seus assistentes de IA interajam com APIs externas durante uma chamada.

Cabeçalhos

Authorization
string
required
Token Bearer para autenticação
Content-Type
string
required
Deve ser application/json
Accept
string
required
Deve ser application/json

Campos de resposta

data
array
Array de ferramentas utilizadas durante a chamada
[
  {
    "id": 1,
    "name": "get_weather",
    "description": "Use esta ferramenta para obter o clima atual em uma cidade específica. Chame isto 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": "O nome da cidade para obter o clima"
      },
      {
        "name": "temperature",
        "type": "number",
        "description": "Valor da temperatura atual"
      },
      {
        "name": "is_raining",
        "type": "boolean",
        "description": "Se está chovendo atualmente"
      }
    ],
    "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. Chame isto 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": "A mensagem de 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": "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"
  }
]

Atribuindo Ferramentas a Assistentes

Para usar estas ferramentas com assistentes, veja: