Aller au contenu

Référence des outils

Action

Agir sur les sources et les règles. 12 outils, avec leurs paramètres et des exemples d’appel.

Outils d’action de l’agent Piqline. Dans le chat, chacun demande une confirmation. Par l’API, l’appel direct avec le scope act vaut confirmation : n’appelez ces outils qu’après l’accord de la personne concernée.

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.

subscribeSource#

S’abonne à une nouvelle source. Lance une vraie collecte (jobs de lecture, quotas des plateformes).

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

Type : Action. Scopes : act.

ParamètreTypeRequisDescription
platforminstagram | tiktok | youtube | twitter | x | threads | linkedin | reddit | …Oui
targetstringNonHandle, URL, mot-clé Marketplace, ou communauté. Une recherche LinkedIn peut s’appuyer sur query.
titlestringNon
facebookKindpage | group | marketplaceNonFacebook : page publique, groupe public, ou recherche Marketplace.
tiktokKindprofile | liveNonTikTok only. live = /v1/tiktok/user/live probe, not profile posts.
linkedinKindcompany | searchNonLinkedIn only. search = recurring public-post search on query.
locationstringNonMarketplace : ville ou zone.
latnumberNon
lngnumberNon
radiusKmnumberNon
minPricenumberNon
maxPricenumberNon
sortBystringNon
conditionstringNon
dateListedstringNon
categoryIdstringNon
deliverystringNon
availabilitystringNon
datePostedlast-hour | last-day | last-week | last-month | last-yearNonLinkedIn search only. Window of each run, default last-week.
querystringNonMarketplace keyword or LinkedIn search query.
intentstringNonLinkedIn search: the user's ask, kept on the source.
detectionEventhiring | funding | launch | expansion | reorg | open_to_work | leaving | interested_comment | …Non
detectionRoundsarray<pre_seed | seed | series_a | series_b | series_c | series_d | bridge | extension | …>Non
detectionSectorsarray<string>Non
detectionGeosarray<string>Non
detectionVocabularyarray<string>Non
moreQueriesarray<string>NonLinkedIn search only. Up to 3 other phrases followed together with query, one per job family, each probed by probeLinkedinWatch with at least one relevant post.
maxPostsintegerNonLinkedIn search only. Posts read at most per run: 15, 50, 100 or 200 (default 50). Each post read uses credits; a run reads only posts newer than the last one stored.
detectionAuthorsarray<recruiter | founder | manager>NonLinkedIn search only. Keep only posts whose author's title reads as one of these roles (recruiter, founder, manager). Empty = every author.
rhythmhourly | every_6h | daily | weeklyNonLinkedIn search only. Run rhythm chosen by the user (hourly, every_6h, daily, weekly). Omit to keep the rhythm suggested by the probe.
investigationobjectNonLot 7: pass the investigation object from probeLinkedinWatch unchanged.
trackItemVariationsbooleanNonMarketplace / listing only. True only if the user explicitly asked to follow price, text or presence on the same item (T8). Default false: new items only.
enrichFromUrlbooleanNonListing / web only. Open each item URL to read the page text. Default false. Each opened page uses credits. Set true only if the user explicitly asked.
curl -s https://piqline.com/api/v1/tools/subscribeSource \
  -H "Authorization: Bearer $PIQLINE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"platform":"instagram"}'

subscribeSources#

S’abonne à plusieurs sources en un appel et renvoie un résultat par source.

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

Type : Action. Scopes : act.

ParamètreTypeRequisDescription
sourcesarray<object>Oui
curl -s https://piqline.com/api/v1/tools/subscribeSources \
  -H "Authorization: Bearer $PIQLINE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"sources":[{"platform":"instagram"}]}'

unsubscribeSource#

Arrête le suivi d’une source. Les items déjà collectés restent dans le corpus.

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

Type : Action. Scopes : act.

ParamètreTypeRequisDescription
sourceIdstringOui
labelstringNonNom lisible de la source (celui de listSources). Obligatoire pour la carte de confirmation.
curl -s https://piqline.com/api/v1/tools/unsubscribeSource \
  -H "Authorization: Bearer $PIQLINE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"sourceId":"5a0e9c1f-2b7d-4e63-8f14-d3c8a6b92e70"}'

setHomeDashboard#

Définit un board enregistré comme accueil du workspace.

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

Type : Action. Scopes : act.

ParamètreTypeRequisDescription
dashboardIdstringOui
titlestringNonTitre du tableau, pour la carte de confirmation. Jamais l’identifiant seul.
curl -s https://piqline.com/api/v1/tools/setHomeDashboard \
  -H "Authorization: Bearer $PIQLINE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"dashboardId":"5a0e9c1f-2b7d-4e63-8f14-d3c8a6b92e70"}'

upsertSignalRule#

Crée ou met à jour une règle de signal de persistance : elle se déclenche quand un item reste en ligne plus longtemps que le seuil.

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

Type : Action. Scopes : act.

ParamètreTypeRequisDescription
ruleIdstringNon
thresholdDaysintegerNon
staleGraceDaysintegerNon
itemTypesarray<post | video | article | listing | job_offer>Non
enabledbooleanNon
curl -s https://piqline.com/api/v1/tools/upsertSignalRule \
  -H "Authorization: Bearer $PIQLINE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

upsertQuestionRule#

Crée ou met à jour une question permanente : une phrase en langage courant que Jev pose sur chaque nouvel item des sources du workspace. Le seuil de probabilité fait le signal.

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

Type : Action. Scopes : act.

ParamètreTypeRequisDescription
ruleIdstringNon
questionstringOui
minProbabilitynumberNon
itemTypesarray<post | video | article | listing | job_offer>Non
enabledbooleanNon
curl -s https://piqline.com/api/v1/tools/upsertQuestionRule \
  -H "Authorization: Bearer $PIQLINE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"question":"texte"}'

startInvestigation#

Met en file une enquête Edge en arrière-plan pour ce workspace (owner ou admin).

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

Type : Action. Scopes : act.

ParamètreTypeRequisDescription
intentstringOuiNeed in one sentence, from sujets / zones / langues already noted
perimeterobjectNonOptional sectors, geos, accounts, seed URLs from the need profile
curl -s https://piqline.com/api/v1/tools/startInvestigation \
  -H "Authorization: Bearer $PIQLINE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"intent":"texte"}'

startHunt#

Lance une chasse : trouver des personnes qui remplissent des critères vérifiables, chaque critère prouvé par une source publique datée. Critères sensibles refusés, aucune coordonnée rendue. Tourne en arrière-plan et consomme des crédits du mois ; owner ou admin.

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

Type : Action. Scopes : act.

ParamètreTypeRequisDescription
briefstringOuiWho to find, in one or two sentences.
purposestringOuiWhy these people are sought, in one sentence. Recorded with the hunt.
criteriaarray<object>Oui
targetintegerNonHow many people to find.
curl -s https://piqline.com/api/v1/tools/startHunt \
  -H "Authorization: Bearer $PIQLINE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"brief":"texte","purpose":"texte","criteria":[{"label":"texte"}]}'

buildAdAudit#

Audit rétroactif des campagnes de 1 à 6 annonceurs déjà collectés, sur N mois : une table du workspace (annonceur, mois, nouvelles annonces, arrêts, bibliothèques, pays, besoins lus, montée en puissance) et les chiffres d’un résumé cité. Aucun crédit.

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

Type : Écriture. Scopes : write.

ParamètreTypeRequisDescription
advertisersarray<string>OuiNames of the advertisers, as in the collections.
monthsintegerNon
namestringNonTable name. Default: « Audit publicitaire ».
curl -s https://piqline.com/api/v1/tools/buildAdAudit \
  -H "Authorization: Bearer $PIQLINE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"advertisers":["texte"]}'

findCreatorSponsors#

Qui paie des créateurs YouTube dans une niche : recherche de vidéos récentes, sponsors inférés de chaque vidéo, table « Sponsors · niche » du workspace. Consomme des crédits ; confirmation dans le chat, owner ou admin.

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

Type : Action. Scopes : act, write, explore.

ParamètreTypeRequisDescription
nichestringOuiWords of the niche, as a creator would title a video (« compléments alimentaires »).
videosintegerNon
periodthis_week | this_month | this_yearNon
countrystringNonYouTube region, FR by default.
followbooleanNontrue: follow the niche, run again every week, and raise A13 when a brand starts sponsoring creators of the niche (in the bell and alert e-mails).
curl -s https://piqline.com/api/v1/tools/findCreatorSponsors \
  -H "Authorization: Bearer $PIQLINE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"niche":"texte"}'

importAdHistory#

Importe l’historique Google d’une collecte annonceur : jusqu’à 20 pages (environ 800 annonces depuis 2021) pour dater les campagnes passées. Consomme des crédits ; confirmation dans le chat, owner ou admin.

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

Type : Action. Scopes : act, write, explore.

ParamètreTypeRequisDescription
collectionstringOuiName of the advertiser collection.
curl -s https://piqline.com/api/v1/tools/importAdHistory \
  -H "Authorization: Bearer $PIQLINE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"collection":"texte"}'

startAdCollection#

Lance une collecte publicitaire sur un annonceur (nom ou domaine) ou un mot-clé : lit Meta, TikTok, Google et LinkedIn, met chaque annonce au même format, puis lit l’angle, l’offre, l’audience et le ton. Consomme des crédits ; confirmation dans le chat, owner ou admin.

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

Type : Action. Scopes : act, write, explore.

ParamètreTypeRequisDescription
querystringOuiNom ou domaine de l'annonceur (kind advertiser), ou mot-clé (kind keyword).
kindadvertiser | keywordNon
librariesarray<meta | tiktok | google | linkedin>NonBibliothèques à lire. Google ne cherche pas par mot-clé.
countrystringNonCode pays ISO. Restreint Meta et LinkedIn, choisit l'entité annonceur de Google (FR par défaut). Courants : FR, BE, CH, LU, DE, ES, IT, NL, GB, IE, US, CA, MA, SN, CI, AU, BR, JP.
depthapercu | largeNonapercu : une page par bibliothèque. large : jusqu'à quatre pages (plus long).
cadencemanuel | quotidien | hebdomadaireNonmanuel : à la main. quotidien ou hebdomadaire : la collecte se repasse seule, dans le plafond du jour, et ses signaux arrivent dans la cloche.
curl -s https://piqline.com/api/v1/tools/startAdCollection \
  -H "Authorization: Bearer $PIQLINE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"query":"levée de fonds"}'

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