Listar herramientas - Insurance Boosters API

GET

tools

Listar herramientas

curl --request GET \
  --url https://api.insuranceboosters.com/api/v1/tools \
  --header 'x-ib-api-key: <api-key>'

const options = {method: 'GET', headers: {'x-ib-api-key': '<api-key>'}};

fetch('https://api.insuranceboosters.com/api/v1/tools', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

const options = {method: 'GET', headers: {'x-ib-api-key': '<api-key>'}};

fetch('https://api.insuranceboosters.com/api/v1/tools', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

const url = 'https://api.insuranceboosters.com/api/v1/tools';
const options = {method: 'GET', headers: {'x-ib-api-key': '<api-key>'}};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));

using RestSharp;


var options = new RestClientOptions("https://api.insuranceboosters.com/api/v1/tools");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("x-ib-api-key", "<api-key>");
var response = await client.GetAsync(request);

Console.WriteLine("{0}", response.Content);

using RestSharp;


var options = new RestClientOptions("https://api.insuranceboosters.com/api/v1/tools");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("x-ib-api-key", "<api-key>");
var response = await client.GetAsync(request);

Console.WriteLine("{0}", response.Content);

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.insuranceboosters.com/api/v1/tools"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-ib-api-key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.insuranceboosters.com/api/v1/tools")

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

request = Net::HTTP::Get.new(url)
request["x-ib-api-key"] = '<api-key>'

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

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.insuranceboosters.com/api/v1/tools",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-ib-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

val client = OkHttpClient()

val request = Request.Builder()
  .url("https://api.insuranceboosters.com/api/v1/tools")
  .get()
  .addHeader("x-ib-api-key", "<api-key>")
  .build()

val response = client.newCall(request).execute()

import Foundation

let url = URL(string: "https://api.insuranceboosters.com/api/v1/tools")!
var request = URLRequest(url: url)
request.httpMethod = "GET"
request.timeoutInterval = 10
request.allHTTPHeaderFields = ["x-ib-api-key": "<api-key>"]

let (data, _) = try await URLSession.shared.data(for: request)
print(String(decoding: data, as: UTF8.self))

[
  {
    "id": "tool_01",
    "tenantId": "<tenantId>",
    "deleted": false,
    "name": "Consultar cliente",
    "apiName": "consultarCliente",
    "instructions": "Consulta los datos de un cliente por su identificador.",
    "toolType": "http",
    "inputs": [
      {
        "name": "clienteId",
        "type": "string",
        "description": "Identificador del cliente.",
        "required": true,
        "collectFromUser": false
      }
    ],
    "details": {
      "endpoint": "https://api.ejemplo.com/clientes/{{clienteId}}",
      "method": "GET",
      "authentication": {
        "type": "no_auth"
      }
    },
    "createdAt": 1720000000000,
    "lastUpdatedAt": 1720000000000
  }
]

Lista todas las herramientas configuradas. La operación no usa paginación.

Endpoint

GET /tools

Ejemplo de solicitud

curl "https://api.insuranceboosters.com/api/v1/tools" \
  -H "x-ib-api-key: TU_API_KEY"

Respuesta exitosa (`200`)

La respuesta es un arreglo. Si todavía no tienes herramientas, devuelve [].

[
  {
    "id": "tool_01",
    "tenantId": "<tenantId>",
    "deleted": false,
    "name": "Consultar cliente",
    "apiName": "consultarCliente",
    "instructions": "Consulta los datos de un cliente por su identificador.",
    "toolType": "http",
    "details": {
      "endpoint": "https://api.ejemplo.com/clientes/{{clienteId}}",
      "method": "GET",
      "authentication": {
        "type": "no_auth"
      }
    },
    "createdAt": 1720000000000,
    "lastUpdatedAt": 1720000000000
  }
]

Cada elemento puede ser http, human_handoff, conversation_ended, phone_connect, department_availability o run_code. Consulta Tipos de herramienta para ver la forma de cada variante. Las herramientas eliminadas no aparecen.

La respuesta contiene la configuración completa sin redactar, incluidos tokens, headers y código. Trátala y almacénala como un secreto.

Errores frecuentes

HTTP	Qué significa	Qué hacer
`401`	API key inválida o faltante.	Verifica `x-ib-api-key`.
`500`	No fue posible listar las herramientas.	Reintenta; si continúa, contacta soporte.

Authorizations

x-ib-api-key

string

header

required

Response

Lista de herramientas.

Configuración completa de una herramienta. Las respuestas HTTP y de código no se redactan: pueden contener tokens, headers y código.

name

string

required

Nombre visible de la herramienta.

Minimum string length: 1

apiName

string

required

Nombre que el agente usa para llamar la herramienta.

Minimum string length: 1

instructions

string

required

Explica al agente cuándo y para qué debe usarla.

Minimum string length: 1

toolType

string

required

Allowed value: "http"

details

object

required

Show child attributes

string

required

Identificador de la herramienta.

tenantId

string

required

Identificador asociado a la herramienta.

createdAt

number

required

Fecha de creación en milisegundos desde epoch.

lastUpdatedAt

number

required

Fecha de la última actualización en milisegundos desde epoch.

inputs

object[]

Show child attributes

loadingText

string

Texto que puedes mostrar mientras se ejecuta la herramienta.

showLoadingText

boolean

Indica si se muestra loadingText durante la ejecución.

storeOutputAsVariable

boolean

Indica si la respuesta se guarda como variable de sesión.

outputVariableName

string

Nombre de la variable donde se guarda la respuesta.

outputVariablePath

string

Ruta con notación de puntos para extraer una parte de la respuesta JSON.

deleted

boolean

Estado de eliminación lógica. Las operaciones de lectura omiten herramientas eliminadas.

Listar herramientas

curl --request GET \
  --url https://api.insuranceboosters.com/api/v1/tools \
  --header 'x-ib-api-key: <api-key>'

const options = {method: 'GET', headers: {'x-ib-api-key': '<api-key>'}};

fetch('https://api.insuranceboosters.com/api/v1/tools', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

const options = {method: 'GET', headers: {'x-ib-api-key': '<api-key>'}};

fetch('https://api.insuranceboosters.com/api/v1/tools', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

const url = 'https://api.insuranceboosters.com/api/v1/tools';
const options = {method: 'GET', headers: {'x-ib-api-key': '<api-key>'}};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));

using RestSharp;


var options = new RestClientOptions("https://api.insuranceboosters.com/api/v1/tools");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("x-ib-api-key", "<api-key>");
var response = await client.GetAsync(request);

Console.WriteLine("{0}", response.Content);

using RestSharp;


var options = new RestClientOptions("https://api.insuranceboosters.com/api/v1/tools");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("x-ib-api-key", "<api-key>");
var response = await client.GetAsync(request);

Console.WriteLine("{0}", response.Content);

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.insuranceboosters.com/api/v1/tools"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-ib-api-key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.insuranceboosters.com/api/v1/tools")

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

request = Net::HTTP::Get.new(url)
request["x-ib-api-key"] = '<api-key>'

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

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.insuranceboosters.com/api/v1/tools",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-ib-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

val client = OkHttpClient()

val request = Request.Builder()
  .url("https://api.insuranceboosters.com/api/v1/tools")
  .get()
  .addHeader("x-ib-api-key", "<api-key>")
  .build()

val response = client.newCall(request).execute()

import Foundation

let url = URL(string: "https://api.insuranceboosters.com/api/v1/tools")!
var request = URLRequest(url: url)
request.httpMethod = "GET"
request.timeoutInterval = 10
request.allHTTPHeaderFields = ["x-ib-api-key": "<api-key>"]

let (data, _) = try await URLSession.shared.data(for: request)
print(String(decoding: data, as: UTF8.self))

[
  {
    "id": "tool_01",
    "tenantId": "<tenantId>",
    "deleted": false,
    "name": "Consultar cliente",
    "apiName": "consultarCliente",
    "instructions": "Consulta los datos de un cliente por su identificador.",
    "toolType": "http",
    "inputs": [
      {
        "name": "clienteId",
        "type": "string",
        "description": "Identificador del cliente.",
        "required": true,
        "collectFromUser": false
      }
    ],
    "details": {
      "endpoint": "https://api.ejemplo.com/clientes/{{clienteId}}",
      "method": "GET",
      "authentication": {
        "type": "no_auth"
      }
    },
    "createdAt": 1720000000000,
    "lastUpdatedAt": 1720000000000
  }
]

​Endpoint

​Ejemplo de solicitud

​Respuesta exitosa (200)

​Errores frecuentes

Authorizations

Response

Endpoint

Ejemplo de solicitud

Respuesta exitosa (`200`)

Errores frecuentes