Aller au contenu

Référence des outils

Corpus

Lire le corpus et le workspace. 19 outils, avec leurs paramètres et des exemples d’appel.

Outils de l’agent Piqline. Ils lisent ce que le workspace a déjà collecté : aucun crédit fournisseur, aucune écriture.

Chaque appel est une requête POST avec la clé en Authorization: Bearer. Le corps JSON est l’entrée de l’outil, et la réponse a la forme { "tool": "nom", "output": … }. Les exemples ne portent que les paramètres requis. Les descriptions des paramètres sont celles que lisent les agents, en anglais.

getCoverageStats#

Volumes et santé de la collecte : totaux, répartition par plateforme et par nature, série d’ingestion sur la fenêtre d’analyse (1h, 24h, 7d ou 30d).

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

Type : Lecture. Scopes : read.

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

listSources#

Sources suivies par le workspace, avec le nombre d’items, l’état de santé et la dernière lecture.

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

Type : Lecture. Scopes : read.

Cet outil n’attend aucun paramètre : envoyez un corps vide, {}.

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

searchItems#

Recherche d’items (posts, vidéos, articles, annonces, offres) avec filtres : texte, plateforme, nature, source. Sans filtre, renvoie les plus récents (40 au plus).

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

Type : Lecture. Scopes : read.

ParamètreTypeRequisDescription
querystringNonFree-text match on title and body
platformstringNon
itemTypepost | video | article | listing | job_offerNon
sourceIdstringNon
limitintegerNon
curl -s https://piqline.com/api/v1/tools/searchItems \
  -H "Authorization: Bearer $PIQLINE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

getItem#

Détail d’un item : texte, transcription, OCR, thèmes détectés, items proches par le sens, et ses dates d’observation.

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

Type : Lecture. Scopes : read.

ParamètreTypeRequisDescription
itemIdstringOui
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#

Recherche par le sens dans les documents longs (PDF lus par le Motor) : passages les plus proches d’une question, avec l’item, la page et le titre de section.

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

Type : Lecture. Scopes : read.

ParamètreTypeRequisDescription
querystringOuiQuestion or phrase to look for
itemIdstringNonLimit to one document
limitintegerNon
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#

Vérifie qu’un passage est écrit mot pour mot dans un item et rend un numéro de citation ; sinon le passage le plus proche. Base du mode « Citations » du chat.

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

Type : Lecture. Scopes : read.

ParamètreTypeRequisDescription
itemIdstringOuiItem id from searchItems or getItem
quotestringOuiExact 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#

Dessine la réponse en un schéma SVG (frise, matrice, flux, arbre…) : couleurs par rôle du thème, SVG nettoyé avant affichage. Base du mode « Diagramme » du chat.

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

Type : Lecture. Scopes : read.

ParamètreTypeRequisDescription
typearchitecture | flowchart | sequence | state | timeline | swimlane | quadrant | tree | …OuiVisual type chosen for the layout
titlestringOuiShort name of the subject, in the user's language
descriptionstringOuiOne sentence on what the diagram shows, for screen readers and the caption
svgstringOuiA 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#

Compile un canvas (fichier TSX qui n’importe que le SDK piqline/canvas, même API que cursor/canvas) et rend le code prêt à afficher, ou l’erreur à corriger. Base des modes Canvas et Rapport du chat.

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

Type : Lecture. Scopes : read.

ParamètreTypeRequisDescription
titlestringOuiShort title shown above the canvas, in French
sourcestringOuiFull .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#

Thèmes détectés avec leur part de voix, et récits (le même sujet vu sur plusieurs sources).

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

Type : Lecture. Scopes : read.

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

getSignals#

Signaux ouverts, déclenchés par les règles de persistance du workspace, avec leur avance et leur statut.

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

Type : Lecture. Scopes : read.

Cet outil n’attend aucun paramètre : envoyez un corps vide, {}.

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

listWorkspaceTables#

Tables déjà créées dans le workspace : nom, commentaire, nombre de colonnes et de lignes, et si la table se remplit toute seule.

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

Type : Lecture. Scopes : read.

Cet outil n’attend aucun paramètre : envoyez un corps vide, {}.

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

getWorkspaceTable#

Une table du workspace en JSON : schéma, colonnes et lignes. Sert de base ou de feed pour un site, une appli ou un agent (scope read).

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

Type : Lecture. Scopes : read.

ParamètreTypeRequisDescription
schemastringNonSchema, default public.
namestringOuiTable 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#

Signets et dossiers du coffre du workspace : titre, type, dossier, statut, admission. Filtre optionnel par mot, statut ou type.

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

Type : Lecture. Scopes : read.

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

listEntities#

Entités suivies (entreprises, marques, comptes publics) et items liés sur la période.

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

Type : Lecture. Scopes : read.

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

listWatchContracts#

Contrats de veille posés sur les sources : intention, termes gardés et exclus, événement.

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

Type : Lecture. Scopes : read.

Cet outil n’attend aucun paramètre : envoyez un corps vide, {}.

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

checkInvestigation#

État de la dernière enquête Edge, ou d’une enquête donnée : en attente, en cours, terminée avec ses candidats, ou en échec.

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

Type : Lecture. Scopes : read.

ParamètreTypeRequisDescription
missionIdstringNonOmit 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 '{}'

planSourcePack#

Propose un ensemble cohérent de sources à suivre pour un objectif. Ne crée rien.

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

Type : Lecture. Scopes : read.

ParamètreTypeRequisDescription
namestringOui
rationalestringOuiWhy this pack answers the goal
candidatesarray<object>Oui
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#

Widgets proposables pour un board de ce workspace, classés pour la personne, avec leurs raisons.

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

Type : Lecture. Scopes : read.

ParamètreTypeRequisDescription
period7d | 30d | 90dNonWindow 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 '{}'

listCollectedAds#

Collectes publicitaires du workspace (Meta, TikTok, Google, LinkedIn), déjà lues : la liste, ou, avec le nom d’une collecte, ses répartitions (angles, offres, tons, formats), son rythme, ses annonces les plus longues et ses annonces filtrables par bibliothèque, statut, angle ou mot. Aucun crédit.

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

Type : Lecture. Scopes : read.

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

Une question sur l’API, ou une erreur dans cette page ? Écrivez-nous.