Zum Inhalt springen

Tool-Referenz

Aktionen

Auf Quellen und Regeln einwirken. 12 Tools, mit ihren Parametern und Aufrufbeispielen.

Aktions-Tools des Piqline-Agenten. Im Chat verlangt jedes eine Bestätigung. Über die API gilt ein direkter Aufruf mit dem Scope act als Bestätigung: Rufen Sie diese Tools erst auf, nachdem die betroffene Person zugestimmt hat.

Jeder Aufruf ist eine POST-Anfrage mit dem Schlüssel in Authorization: Bearer. Der JSON-Body ist die Eingabe des Tools, und die Antwort hat die Form { "tool": "nom", "output": … }. Die Beispiele enthalten nur die erforderlichen Parameter. Die Parameterbeschreibungen sind die, die die Agenten lesen.

subscribeSource#

Abonniert eine neue Quelle. Startet eine echte Erfassung (Lese-Jobs, Plattformkontingente).

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

Typ: Aktion. Scopes: act.

ParameterTypErforderlichBeschreibung
platforminstagram | tiktok | youtube | twitter | x | threads | linkedin | reddit | …Ja
targetstringNeinHandle, URL, mot-clé Marketplace, ou communauté. Une recherche LinkedIn peut s’appuyer sur query.
titlestringNein
facebookKindpage | group | marketplaceNeinFacebook : page publique, groupe public, ou recherche Marketplace.
tiktokKindprofile | liveNeinTikTok only. live = /v1/tiktok/user/live probe, not profile posts.
linkedinKindcompany | searchNeinLinkedIn only. search = recurring public-post search on query.
locationstringNeinMarketplace : ville ou zone.
latnumberNein
lngnumberNein
radiusKmnumberNein
minPricenumberNein
maxPricenumberNein
sortBystringNein
conditionstringNein
dateListedstringNein
categoryIdstringNein
deliverystringNein
availabilitystringNein
datePostedlast-hour | last-day | last-week | last-month | last-yearNeinLinkedIn search only. Window of each run, default last-week.
querystringNeinMarketplace keyword or LinkedIn search query.
intentstringNeinLinkedIn search: the user's ask, kept on the source.
detectionEventhiring | funding | launch | expansion | reorg | open_to_work | leaving | interested_comment | …Nein
detectionRoundsarray<pre_seed | seed | series_a | series_b | series_c | series_d | bridge | extension | …>Nein
detectionSectorsarray<string>Nein
detectionGeosarray<string>Nein
detectionVocabularyarray<string>Nein
moreQueriesarray<string>NeinLinkedIn 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.
maxPostsintegerNeinLinkedIn 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>NeinLinkedIn 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 | weeklyNeinLinkedIn search only. Run rhythm chosen by the user (hourly, every_6h, daily, weekly). Omit to keep the rhythm suggested by the probe.
investigationobjectNeinLot 7: pass the investigation object from probeLinkedinWatch unchanged.
trackItemVariationsbooleanNeinMarketplace / 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.
enrichFromUrlbooleanNeinListing / 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#

Abonniert mehrere Quellen in einem Aufruf und liefert ein Ergebnis pro Quelle.

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

Typ: Aktion. Scopes: act.

ParameterTypErforderlichBeschreibung
sourcesarray<object>Ja
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#

Beendet das Folgen einer Quelle. Bereits erfasste Items bleiben im Korpus.

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

Typ: Aktion. Scopes: act.

ParameterTypErforderlichBeschreibung
sourceIdstringJa
labelstringNeinNom 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#

Setzt ein gespeichertes Board als Startseite des Workspace.

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

Typ: Aktion. Scopes: act.

ParameterTypErforderlichBeschreibung
dashboardIdstringJa
titlestringNeinTitre 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#

Erstellt oder aktualisiert eine Persistenz-Signalregel: Sie löst aus, wenn ein Item länger als der Schwellenwert online bleibt.

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

Typ: Aktion. Scopes: act.

ParameterTypErforderlichBeschreibung
ruleIdstringNein
thresholdDaysintegerNein
staleGraceDaysintegerNein
itemTypesarray<post | video | article | listing | job_offer>Nein
enabledbooleanNein
curl -s https://piqline.com/api/v1/tools/upsertSignalRule \
  -H "Authorization: Bearer $PIQLINE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

upsertQuestionRule#

Erstellt oder aktualisiert eine Dauerfrage: ein Satz in einfacher Sprache, den Jev an jedes neue Item der Quellen des Workspace stellt. Der Wahrscheinlichkeitsschwellenwert erzeugt das Signal.

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

Typ: Aktion. Scopes: act.

ParameterTypErforderlichBeschreibung
ruleIdstringNein
questionstringJa
minProbabilitynumberNein
itemTypesarray<post | video | article | listing | job_offer>Nein
enabledbooleanNein
curl -s https://piqline.com/api/v1/tools/upsertQuestionRule \
  -H "Authorization: Bearer $PIQLINE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"question":"texte"}'

startInvestigation#

Reiht eine Edge-Recherche im Hintergrund für diesen Workspace ein (Owner oder Admin).

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

Typ: Aktion. Scopes: act.

ParameterTypErforderlichBeschreibung
intentstringJaNeed in one sentence, from sujets / zones / langues already noted
perimeterobjectNeinOptional 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#

Startet eine Suche: Personen finden, die nachprüfbare Kriterien erfüllen, jedes Kriterium durch eine datierte öffentliche Quelle belegt. Sensible Kriterien werden abgelehnt, es werden keine Kontaktdaten geliefert. Läuft im Hintergrund und verbraucht die Credits des Monats; Owner oder Admin.

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

Typ: Aktion. Scopes: act.

ParameterTypErforderlichBeschreibung
briefstringJaWho to find, in one or two sentences.
purposestringJaWhy these people are sought, in one sentence. Recorded with the hunt.
criteriaarray<object>Ja
targetintegerNeinHow 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#

Rückwirkendes Audit der Kampagnen von 1 bis 6 bereits erfassten Werbetreibenden über N Monate: eine Workspace-Tabelle (Werbetreibender, Monat, neue Anzeigen, Stopps, Bibliotheken, Länder, gelesene Bedarfe, Hochfahren) und die Zahlen einer zitierten Zusammenfassung. Keine Credits.

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

Typ: Schreiben. Scopes: write.

ParameterTypErforderlichBeschreibung
advertisersarray<string>JaNames of the advertisers, as in the collections.
monthsintegerNein
namestringNeinTable 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#

Wer YouTube-Creator in einer Nische bezahlt: Suche nach aktuellen Videos, aus jedem Video abgeleitete Sponsoren, eine Workspace-Tabelle „Sponsoren · Nische“. Verbraucht Credits; Bestätigung im Chat, Owner oder Admin.

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

Typ: Aktion. Scopes: act, write, explore.

ParameterTypErforderlichBeschreibung
nichestringJaWords of the niche, as a creator would title a video (« compléments alimentaires »).
videosintegerNein
periodthis_week | this_month | this_yearNein
countrystringNeinYouTube region, FR by default.
followbooleanNeintrue: 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#

Importiert den Google-Verlauf einer Werbetreibenden-Erfassung: bis zu 20 Seiten (etwa 800 Anzeigen seit 2021), um vergangene Kampagnen zu datieren. Verbraucht Credits; Bestätigung im Chat, Owner oder Admin.

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

Typ: Aktion. Scopes: act, write, explore.

ParameterTypErforderlichBeschreibung
collectionstringJaName 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#

Startet eine Anzeigenerfassung zu einem Werbetreibenden (Name oder Domain) oder einem Stichwort: liest Meta, TikTok, Google und LinkedIn, bringt jede Anzeige ins gleiche Format und liest dann Winkel, Angebot, Zielgruppe und Tonalität. Verbraucht Credits; Bestätigung im Chat, Owner oder Admin.

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

Typ: Aktion. Scopes: act, write, explore.

ParameterTypErforderlichBeschreibung
querystringJaNom ou domaine de l'annonceur (kind advertiser), ou mot-clé (kind keyword).
kindadvertiser | keywordNein
librariesarray<meta | tiktok | google | linkedin>NeinBibliothèques à lire. Google ne cherche pas par mot-clé.
countrystringNeinCode 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 | largeNeinapercu : une page par bibliothèque. large : jusqu'à quatre pages (plus long).
cadencemanuel | quotidien | hebdomadaireNeinmanuel : à 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"}'

Eine Frage zur API oder ein Fehler auf dieser Seite? Schreiben Sie uns.