Riferimento dei tool
Panoramica
Ogni tool richiamabile: il suo ruolo, i suoi scope, i suoi parametri e un esempio in curl, JavaScript e Python.
I tool sono raggruppati per famiglia, una pagina ciascuna. Il riferimento è generato dal codice dell'API: non può discostarsene, e un nuovo tool compare da solo.
Famiglie di tool#
Formato della chiamata#
POSThttps://piqline.com/api/v1/tools/{nom}
Ogni tool si chiama allo stesso modo:
Authorization: Bearer piq_live_…eContent-Type: application/json.- Un corpo JSON: l'input del tool. Un tool senza parametri accetta
{}. - Una risposta
200con la forma{ "tool": "nom", "output": … }. - Un errore come
application/problem+json: vedi Errori.
Gli scope di una chiave, ciò che limita ogni tool e i limiti si trovano in Autenticazione. L'elenco in tempo reale, con gli schemi di input, è in GEThttps://piqline.com/api/v1/tools.
Il documento OpenAPI descrive le stesse route per un generatore di client.