Saltar al contenido

Referencia de herramientas

Visión general

Cada herramienta invocable: su función, sus scopes, sus parámetros y un ejemplo en curl, JavaScript y Python.

Las herramientas se agrupan por familia, con una página cada una. La referencia se genera a partir del código de la API: no puede desviarse de él, y una herramienta nueva aparece sola.

Familias de herramientas#

Formato de llamada#

POSThttps://piqline.com/api/v1/tools/{nom}

Todas las herramientas se llaman de la misma manera:

  • Authorization: Bearer piq_live_… y Content-Type: application/json.
  • Un cuerpo JSON: la entrada de la herramienta. Una herramienta sin parámetros acepta {}.
  • Una respuesta 200 con la forma { "tool": "nom", "output": … }.
  • Un error como application/problem+json: consulta Errores.

Los scopes de una clave, lo que limita cada herramienta y los límites están en Autenticación. La lista actual, con los esquemas de entrada, está en GEThttps://piqline.com/api/v1/tools.

El documento OpenAPI describe las mismas rutas para un generador de clientes.

¿Tienes una pregunta sobre la API o has encontrado un error en esta página? Escríbenos.