Obter ferramenta durante chamada

Recuperar uma ferramenta durante chamada específica por ID

GET https://app.autocalls.ai/api//user/tools/{id}

Obter ferramenta durante chamada

cURL

curl --request GET \
  --url https://app.autocalls.ai/api/user/tools/{id} \
  --header 'Accept: <accept>' \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: <content-type>'

200 Response

{
  "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"
}

Este endpoint permite que você recupere informações detalhadas sobre uma ferramenta durante chamada específica.

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

Parâmetros de Caminho

id · integer · required

O identificador único da ferramenta

Campos de resposta

id · integer

O identificador único da ferramenta

name · string

O nome da ferramenta (minúsculas com sublinhados)

description · string

Explicação detalhada de quando e como a IA deve usar esta ferramenta

endpoint · string

A URL do endpoint da API que será chamado

method · string

Método HTTP (GET, POST, PUT, PATCH, DELETE)

timeout · integer

Timeout da solicitação em segundos (1-30)

headers · array

Cabeçalhos HTTP para enviar com a solicitação

Show propriedades de header

name · string

Nome do cabeçalho

value · string

Valor do cabeçalho

schema · array

Parâmetros que a IA extrairá e enviará para o endpoint

Show propriedades de schema

name · string

Nome do parâmetro

type · string

Tipo do parâmetro (string, number, boolean)

description · string

Descrição para ajudar a IA a entender como extrair este parâmetro

created_at · string

Timestamp ISO 8601 de quando a ferramenta foi criada

updated_at · string

Timestamp ISO 8601 de quando a ferramenta foi atualizada pela última vez

200 Response

{
  "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"
}

Atribuindo Ferramentas a Assistentes

Para usar esta ferramenta com um assistente, veja:

• Criar Assistente - Anexe ferramentas usando o parâmetro tool_ids
• Atualizar Assistente - Gerencie atribuições de ferramentas usando o parâmetro tool_ids