Vai al contenuto

Riferimento dei tool

Corpus

Leggere il corpus e il workspace. 22 tool, con i loro parametri ed esempi di chiamata.

Tool dell'agente Piqline. Leggono ciò che il workspace ha già raccolto: nessun credito consumato, nulla viene scritto.

Ogni chiamata è una richiesta POST con la chiave in Authorization: Bearer. Il corpo JSON è l'input del tool, e la risposta ha la forma { "tool": "nom", "output": … }. Gli esempi contengono solo i parametri obbligatori. Le descrizioni dei parametri sono quelle che leggono gli agenti.

getCoverageStats#

Volumi e stato della raccolta: totali, suddivisione per piattaforma e per tipo, serie di acquisizione sulla finestra di analisi (1h, 24h, 7d o 30d).

POSThttps://piqline.com/api/v1/tools/getCoverageStats

Tipo: Lettura. Scope: read.

ParametroTipoObbligatorioDescrizione
period1h | 24h | 7d | 30dNoAnalysis window
curl -s https://piqline.com/api/v1/tools/getCoverageStats \
  -H "Authorization: Bearer $PIQLINE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

listSources#

Fonti seguite dal workspace, con numero di elementi, stato e ultima lettura.

POSThttps://piqline.com/api/v1/tools/listSources

Tipo: Lettura. Scope: read.

Questo tool non ha parametri: invia un corpo vuoto, {}.

curl -s https://piqline.com/api/v1/tools/listSources \
  -H "Authorization: Bearer $PIQLINE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

searchItems#

Cerca elementi (post, video, articoli, inserzioni, offerte di lavoro) con filtri: testo, piattaforma, tipo, fonte. Senza filtro, restituisce i più recenti (al massimo 40).

POSThttps://piqline.com/api/v1/tools/searchItems

Tipo: Lettura. Scope: read.

ParametroTipoObbligatorioDescrizione
querystringNoFree-text match on title and body
platformstringNo
itemTypepost | video | article | listing | job_offerNo
sourceIdstringNo
limitintegerNo
curl -s https://piqline.com/api/v1/tools/searchItems \
  -H "Authorization: Bearer $PIQLINE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

getItem#

Dettaglio di un elemento: testo, trascrizione, OCR, argomenti rilevati, elementi vicini per significato e date di osservazione.

POSThttps://piqline.com/api/v1/tools/getItem

Tipo: Lettura. Scope: read.

ParametroTipoObbligatorioDescrizione
itemIdstringSì
curl -s https://piqline.com/api/v1/tools/getItem \
  -H "Authorization: Bearer $PIQLINE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"itemId":"5a0e9c1f-2b7d-4e63-8f14-d3c8a6b92e70"}'

searchPassages#

Ricerca per significato nei documenti lunghi (PDF letti dal Motor): i passaggi più vicini a una domanda, con l'elemento, la pagina e il titolo della sezione.

POSThttps://piqline.com/api/v1/tools/searchPassages

Tipo: Lettura. Scope: read.

ParametroTipoObbligatorioDescrizione
querystringSìQuestion or phrase to look for
itemIdstringNoLimit to one document
limitintegerNo
curl -s https://piqline.com/api/v1/tools/searchPassages \
  -H "Authorization: Bearer $PIQLINE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"query":"levée de fonds"}'

citeItem#

Verifica che un passaggio compaia parola per parola in un elemento e restituisce un numero di citazione; altrimenti il passaggio più vicino. Base della modalità Citazioni della chat.

POSThttps://piqline.com/api/v1/tools/citeItem

Tipo: Lettura. Scope: read.

ParametroTipoObbligatorioDescrizione
itemIdstringSìItem id from searchItems or getItem
quotestringSìExact passage copied from the item text
curl -s https://piqline.com/api/v1/tools/citeItem \
  -H "Authorization: Bearer $PIQLINE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"itemId":"5a0e9c1f-2b7d-4e63-8f14-d3c8a6b92e70","quote":"texte"}'

drawDiagram#

Disegna la risposta come diagramma SVG (timeline, matrice, flusso, albero…): colori per ruolo del tema, SVG ripulito prima della visualizzazione. Base della modalità Diagramma della chat.

POSThttps://piqline.com/api/v1/tools/drawDiagram

Tipo: Lettura. Scope: read.

ParametroTipoObbligatorioDescrizione
typearchitecture | flowchart | sequence | state | timeline | swimlane | quadrant | tree | …SìVisual type chosen for the layout
titlestringSìShort name of the subject, in the user's language
descriptionstringSìOne sentence on what the diagram shows, for screen readers and the caption
svgstringSìA single <svg viewBox="0 0 960 H">…</svg> following the diagram rules
curl -s https://piqline.com/api/v1/tools/drawDiagram \
  -H "Authorization: Bearer $PIQLINE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"type":"architecture","title":"texte","description":"texte","svg":"texte"}'

createCanvas#

Compila un canvas (un file TSX che importa solo l'SDK piqline/canvas) e restituisce il codice pronto da visualizzare, oppure l'errore da correggere. Base delle modalità Canvas e Report della chat.

POSThttps://piqline.com/api/v1/tools/createCanvas

Tipo: Lettura. Scope: read.

ParametroTipoObbligatorioDescrizione
titlestringSìShort title shown above the canvas, in French
sourcestringSìFull .canvas.tsx source
curl -s https://piqline.com/api/v1/tools/createCanvas \
  -H "Authorization: Bearer $PIQLINE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"title":"texte","source":"texte"}'

getTopics#

Argomenti rilevati con la loro quota di voce e le storie (lo stesso soggetto visto in più fonti).

POSThttps://piqline.com/api/v1/tools/getTopics

Tipo: Lettura. Scope: read.

ParametroTipoObbligatorioDescrizione
period1h | 24h | 7d | 30dNoAnalysis window
curl -s https://piqline.com/api/v1/tools/getTopics \
  -H "Authorization: Bearer $PIQLINE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

getSignals#

Segnali aperti, attivati dalle regole di persistenza del workspace, con il loro anticipo e il loro stato.

POSThttps://piqline.com/api/v1/tools/getSignals

Tipo: Lettura. Scope: read.

Questo tool non ha parametri: invia un corpo vuoto, {}.

curl -s https://piqline.com/api/v1/tools/getSignals \
  -H "Authorization: Bearer $PIQLINE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

listWorkspaceTables#

Tabelle già create nel workspace: nome, commento, numero di colonne e di righe, e se la tabella si popola da sola.

POSThttps://piqline.com/api/v1/tools/listWorkspaceTables

Tipo: Lettura. Scope: read.

Questo tool non ha parametri: invia un corpo vuoto, {}.

curl -s https://piqline.com/api/v1/tools/listWorkspaceTables \
  -H "Authorization: Bearer $PIQLINE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

getWorkspaceTable#

Una tabella del workspace in JSON: schema, colonne e righe. Serve da base o da feed per un sito, un'app o un agente (scope read).

POSThttps://piqline.com/api/v1/tools/getWorkspaceTable

Tipo: Lettura. Scope: read.

ParametroTipoObbligatorioDescrizione
schemastringNoSchema, default public.
namestringSìTable name.
curl -s https://piqline.com/api/v1/tools/getWorkspaceTable \
  -H "Authorization: Bearer $PIQLINE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"texte"}'

listBookmarks#

Segnalibri e cartelle del vault del workspace: titolo, tipo, cartella, stato, ammissione. Filtro facoltativo per parola, stato o tipo.

POSThttps://piqline.com/api/v1/tools/listBookmarks

Tipo: Lettura. Scope: read.

ParametroTipoObbligatorioDescrizione
querystringNoOptional filter on title, note or tags.
statusinbox | reading | doneNo
kinditem | source | signal | graph | search | document | board | chatNo
curl -s https://piqline.com/api/v1/tools/listBookmarks \
  -H "Authorization: Bearer $PIQLINE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

listEntities#

Entità seguite (aziende, marchi, account pubblici) ed elementi collegati nel periodo.

POSThttps://piqline.com/api/v1/tools/listEntities

Tipo: Lettura. Scope: read.

ParametroTipoObbligatorioDescrizione
period7d | 30d | 90dNo
curl -s https://piqline.com/api/v1/tools/listEntities \
  -H "Authorization: Bearer $PIQLINE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

listWatchContracts#

Contratti di monitoraggio impostati sulle fonti: intento, termini mantenuti ed esclusi, evento.

POSThttps://piqline.com/api/v1/tools/listWatchContracts

Tipo: Lettura. Scope: read.

Questo tool non ha parametri: invia un corpo vuoto, {}.

curl -s https://piqline.com/api/v1/tools/listWatchContracts \
  -H "Authorization: Bearer $PIQLINE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

checkInvestigation#

Stato dell'ultima indagine Edge, o di una indagine specifica: in attesa, in corso, conclusa con i suoi candidati, oppure fallita.

POSThttps://piqline.com/api/v1/tools/checkInvestigation

Tipo: Lettura. Scope: read.

ParametroTipoObbligatorioDescrizione
missionIdstringNoOmit to read the latest investigator mission of this workspace
curl -s https://piqline.com/api/v1/tools/checkInvestigation \
  -H "Authorization: Bearer $PIQLINE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

checkHunt#

Stato dell'ultima ricerca, o di una ricerca specifica: fase, persone trovate con il verdetto del codice e il tuo, e per ogni criterio il suo stato e la sua prova pubblica datata (URL, data, estratto). Mai recapiti.

POSThttps://piqline.com/api/v1/tools/checkHunt

Tipo: Lettura. Scope: read.

ParametroTipoObbligatorioDescrizione
missionIdstringNoOmit to read the latest hunt of this workspace.
curl -s https://piqline.com/api/v1/tools/checkHunt \
  -H "Authorization: Bearer $PIQLINE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

planSourcePack#

Propone un insieme coerente di fonti da seguire per un obiettivo. Non crea nulla.

POSThttps://piqline.com/api/v1/tools/planSourcePack

Tipo: Lettura. Scope: read.

ParametroTipoObbligatorioDescrizione
namestringSì
rationalestringSìWhy this pack answers the goal
candidatesarray<object>Sì
curl -s https://piqline.com/api/v1/tools/planSourcePack \
  -H "Authorization: Bearer $PIQLINE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"texte","rationale":"texte","candidates":[{"platform":"instagram","target":"texte","label":"texte","why":"texte","confidence":"high"}]}'

listWidgets#

Widget che possono andare su una board di questo workspace, ordinati per la persona, con le loro motivazioni.

POSThttps://piqline.com/api/v1/tools/listWidgets

Tipo: Lettura. Scope: read.

ParametroTipoObbligatorioDescrizione
period7d | 30d | 90dNoWindow used by isProposable. Default 7d.
curl -s https://piqline.com/api/v1/tools/listWidgets \
  -H "Authorization: Bearer $PIQLINE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

getAdvertiserCampaigns#

Scheda delle inserzioni di un inserzionista dalle raccolte del workspace: inserzioni, quelle attive, date, librerie, paesi, esigenze lette, nuove inserzioni al mese e aumenti di ritmo, ultime inserzioni, segnali. Mai una persona. Nessun credito.

POSThttps://piqline.com/api/v1/tools/getAdvertiserCampaigns

Tipo: Lettura. Scope: read.

ParametroTipoObbligatorioDescrizione
advertiserstringSìName (or part of it) of the advertiser.
curl -s https://piqline.com/api/v1/tools/getAdvertiserCampaigns \
  -H "Authorization: Bearer $PIQLINE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"advertiser":"texte"}'

listAdSignals#

Segnali pubblicitari del workspace, calcolati ogni ora: campagna avviata o interrotta, aumento di ritmo, nuovo paese, nuova piattaforma, assunzione a pagamento, promozione, lancio, nuovo inserzionista. Nessun credito.

POSThttps://piqline.com/api/v1/tools/listAdSignals

Tipo: Lettura. Scope: read.

ParametroTipoObbligatorioDescrizione
kindad_campaign_started | ad_campaign_stopped | ad_ramp_up | ad_new_country | ad_new_platform | ad_hiring | ad_promotion | ad_launch | …Noad_hiring for paid recruitment campaigns, ad_campaign_started for new campaigns, etc.
activeOnlybooleanNo
limitintegerNo
curl -s https://piqline.com/api/v1/tools/listAdSignals \
  -H "Authorization: Bearer $PIQLINE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

listCollectedAds#

Raccolte di inserzioni del workspace (Meta, TikTok, Google, LinkedIn), già lette: l'elenco oppure, con il nome di una raccolta, le sue suddivisioni (angoli, offerte, toni, formati), il suo ritmo, le sue inserzioni più longeve e le sue inserzioni filtrate per libreria, stato, angolo o parola. Nessun credito.

POSThttps://piqline.com/api/v1/tools/listCollectedAds

Tipo: Lettura. Scope: read.

ParametroTipoObbligatorioDescrizione
collectionstringNoName of a collection (exact, start or fragment).
librarymeta | tiktok | google | linkedinNo
statuslive | newNolive: active or shown within 14 days. new: first seen at the last pass.
anglepromotion | lancement | marque | preuve_sociale | education | recrutement | evenement | lead | …No
querystringNoWord to find in the advertiser, title, text, button or transcript.
limitintegerNo
curl -s https://piqline.com/api/v1/tools/listCollectedAds \
  -H "Authorization: Bearer $PIQLINE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

Una domanda sull'API, o un errore in questa pagina? Scrivici.