Vai al contenuto

Riferimento dei tool

Azioni

Agire su fonti e regole. 12 tool, con i loro parametri ed esempi di chiamata.

Tool di azione dell'agente Piqline. Nella chat, ciascuno chiede conferma. Tramite l'API, una chiamata diretta con lo scope act vale come conferma: chiama questi tool solo dopo che la persona interessata ha dato il suo consenso.

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.

subscribeSource#

Si iscrive a una nuova fonte. Avvia una vera raccolta (job di lettura, quote delle piattaforme).

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

Tipo: Azione. Scope: act.

ParametroTipoObbligatorioDescrizione
platforminstagram | tiktok | youtube | twitter | x | threads | linkedin | reddit | …Sì
targetstringNoHandle, URL, mot-clé Marketplace, ou communauté. Une recherche LinkedIn peut s’appuyer sur query.
titlestringNo
facebookKindpage | group | marketplaceNoFacebook : page publique, groupe public, ou recherche Marketplace.
tiktokKindprofile | liveNoTikTok only. live = /v1/tiktok/user/live probe, not profile posts.
linkedinKindcompany | searchNoLinkedIn only. search = recurring public-post search on query.
locationstringNoMarketplace : ville ou zone.
latnumberNo
lngnumberNo
radiusKmnumberNo
minPricenumberNo
maxPricenumberNo
sortBystringNo
conditionstringNo
dateListedstringNo
categoryIdstringNo
deliverystringNo
availabilitystringNo
datePostedlast-hour | last-day | last-week | last-month | last-yearNoLinkedIn search only. Window of each run, default last-week.
querystringNoMarketplace keyword or LinkedIn search query.
intentstringNoLinkedIn search: the user's ask, kept on the source.
detectionEventhiring | funding | launch | expansion | reorg | open_to_work | leaving | interested_comment | …No
detectionRoundsarray<pre_seed | seed | series_a | series_b | series_c | series_d | bridge | extension | …>No
detectionSectorsarray<string>No
detectionGeosarray<string>No
detectionVocabularyarray<string>No
moreQueriesarray<string>NoLinkedIn 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.
maxPostsintegerNoLinkedIn 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>NoLinkedIn 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 | weeklyNoLinkedIn search only. Run rhythm chosen by the user (hourly, every_6h, daily, weekly). Omit to keep the rhythm suggested by the probe.
investigationobjectNoLot 7: pass the investigation object from probeLinkedinWatch unchanged.
trackItemVariationsbooleanNoMarketplace / 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.
enrichFromUrlbooleanNoListing / 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#

Si iscrive a più fonti in una sola chiamata e restituisce un risultato per fonte.

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

Tipo: Azione. Scope: act.

ParametroTipoObbligatorioDescrizione
sourcesarray<object>Sì
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#

Smette di seguire una fonte. Gli elementi già raccolti restano nel corpus.

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

Tipo: Azione. Scope: act.

ParametroTipoObbligatorioDescrizione
sourceIdstringSì
labelstringNoNom 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#

Imposta una board salvata come home del workspace.

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

Tipo: Azione. Scope: act.

ParametroTipoObbligatorioDescrizione
dashboardIdstringSì
titlestringNoTitre 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#

Crea o aggiorna una regola di segnale di persistenza: scatta quando un elemento resta online più a lungo della soglia.

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

Tipo: Azione. Scope: act.

ParametroTipoObbligatorioDescrizione
ruleIdstringNo
thresholdDaysintegerNo
staleGraceDaysintegerNo
itemTypesarray<post | video | article | listing | job_offer>No
enabledbooleanNo
curl -s https://piqline.com/api/v1/tools/upsertSignalRule \
  -H "Authorization: Bearer $PIQLINE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

upsertQuestionRule#

Crea o aggiorna una domanda permanente: una frase in linguaggio naturale che Jev pone a ogni nuovo elemento delle fonti del workspace. La soglia di probabilità genera il segnale.

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

Tipo: Azione. Scope: act.

ParametroTipoObbligatorioDescrizione
ruleIdstringNo
questionstringSì
minProbabilitynumberNo
itemTypesarray<post | video | article | listing | job_offer>No
enabledbooleanNo
curl -s https://piqline.com/api/v1/tools/upsertQuestionRule \
  -H "Authorization: Bearer $PIQLINE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"question":"texte"}'

startInvestigation#

Mette in coda un'indagine Edge in background per questo workspace (owner o admin).

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

Tipo: Azione. Scope: act.

ParametroTipoObbligatorioDescrizione
intentstringSìNeed in one sentence, from sujets / zones / langues already noted
perimeterobjectNoOptional 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#

Avvia una ricerca: trova persone che soddisfano criteri verificabili, con ogni criterio provato da una fonte pubblica datata. I criteri sensibili sono rifiutati, non viene restituito alcun recapito. Viene eseguita in background e consuma i crediti del mese; owner o admin.

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

Tipo: Azione. Scope: act.

ParametroTipoObbligatorioDescrizione
briefstringSìWho to find, in one or two sentences.
purposestringSìWhy these people are sought, in one sentence. Recorded with the hunt.
criteriaarray<object>Sì
targetintegerNoHow 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 retroattivo delle campagne di 1-6 inserzionisti già raccolti, su N mesi: una tabella del workspace (inserzionista, mese, nuove inserzioni, interruzioni, librerie, paesi, esigenze lette, aumento di ritmo) e le cifre di un riepilogo citato. Nessun credito.

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

Tipo: Scrittura. Scope: write.

ParametroTipoObbligatorioDescrizione
advertisersarray<string>SìNames of the advertisers, as in the collections.
monthsintegerNo
namestringNoTable 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#

Chi paga i creator YouTube in una nicchia: ricerca di video recenti, sponsor dedotti da ciascun video, una tabella del workspace «Sponsor · nicchia». Consuma crediti; conferma nella chat, owner o admin.

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

Tipo: Azione. Scope: act, write, explore.

ParametroTipoObbligatorioDescrizione
nichestringSìWords of the niche, as a creator would title a video (« compléments alimentaires »).
videosintegerNo
periodthis_week | this_month | this_yearNo
countrystringNoYouTube region, FR by default.
followbooleanNotrue: 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#

Importa la cronologia Google di una raccolta di un inserzionista: fino a 20 pagine (circa 800 inserzioni dal 2021) per datare le campagne passate. Consuma crediti; conferma nella chat, owner o admin.

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

Tipo: Azione. Scope: act, write, explore.

ParametroTipoObbligatorioDescrizione
collectionstringSìName 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#

Avvia una raccolta di inserzioni su un inserzionista (nome o dominio) o su una parola chiave: legge Meta, TikTok, Google e LinkedIn, porta ogni inserzione nello stesso formato, poi legge l'angolo, l'offerta, il pubblico e il tono. Consuma crediti; conferma nella chat, owner o admin.

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

Tipo: Azione. Scope: act, write, explore.

ParametroTipoObbligatorioDescrizione
querystringSìNom ou domaine de l'annonceur (kind advertiser), ou mot-clé (kind keyword).
kindadvertiser | keywordNo
librariesarray<meta | tiktok | google | linkedin>NoBibliothèques à lire. Google ne cherche pas par mot-clé.
countrystringNoCode 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 | largeNoapercu : une page par bibliothèque. large : jusqu'à quatre pages (plus long).
cadencemanuel | quotidien | hebdomadaireNomanuel : à 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"}'

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