Zum Inhalt springen

Tool-Referenz

Korpus

Korpus und Workspace lesen. 22 Tools, mit ihren Parametern und Aufrufbeispielen.

Tools des Piqline-Agenten. Sie lesen, was der Workspace bereits erfasst hat: keine Credits verbraucht, nichts geschrieben.

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.

getCoverageStats#

Erfassungsvolumen und Zustand: Summen, aufgeteilt nach Plattform und Art, Erfassungsreihen über das Analysefenster (1h, 24h, 7d oder 30d).

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

Typ: Lesen. Scopes: read.

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

listSources#

Quellen, denen der Workspace folgt, mit Anzahl der Items, Zustand und letztem Lesevorgang.

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

Typ: Lesen. Scopes: read.

Dieses Tool nimmt keine Parameter: Senden Sie einen leeren Body, {}.

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

searchItems#

Sucht Items (Beiträge, Videos, Artikel, Anzeigen, Jobs) mit Filtern: Text, Plattform, Art, Quelle. Ohne Filter werden die neuesten geliefert (höchstens 40).

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

Typ: Lesen. Scopes: read.

ParameterTypErforderlichBeschreibung
querystringNeinFree-text match on title and body
platformstringNein
itemTypepost | video | article | listing | job_offerNein
sourceIdstringNein
limitintegerNein
curl -s https://piqline.com/api/v1/tools/searchItems \
  -H "Authorization: Bearer $PIQLINE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

getItem#

Detail eines Items: Text, Transkript, OCR, erkannte Themen, bedeutungsnahe Items und seine Beobachtungsdaten.

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

Typ: Lesen. Scopes: read.

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

Bedeutungssuche in langen Dokumenten (vom Motor gelesene PDFs): die Passagen, die einer Frage am nächsten kommen, mit Item, Seite und Abschnittstitel.

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

Typ: Lesen. Scopes: read.

ParameterTypErforderlichBeschreibung
querystringJaQuestion or phrase to look for
itemIdstringNeinLimit to one document
limitintegerNein
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#

Prüft, ob eine Passage wörtlich in einem Item vorkommt, und liefert eine Zitatnummer; andernfalls die nächstliegende Passage. Grundlage des Modus Zitate im Chat.

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

Typ: Lesen. Scopes: read.

ParameterTypErforderlichBeschreibung
itemIdstringJaItem id from searchItems or getItem
quotestringJaExact 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#

Zeichnet die Antwort als SVG-Diagramm (Zeitleiste, Matrix, Ablauf, Baum …): Farben nach Rolle im Theme, SVG vor der Anzeige bereinigt. Grundlage des Modus Diagramm im Chat.

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

Typ: Lesen. Scopes: read.

ParameterTypErforderlichBeschreibung
typearchitecture | flowchart | sequence | state | timeline | swimlane | quadrant | tree | …JaVisual type chosen for the layout
titlestringJaShort name of the subject, in the user's language
descriptionstringJaOne sentence on what the diagram shows, for screen readers and the caption
svgstringJaA 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#

Kompiliert ein Canvas (eine TSX-Datei, die nur das SDK piqline/canvas importiert) und liefert anzeigefertigen Code oder den zu behebenden Fehler. Grundlage der Modi Canvas und Bericht im Chat.

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

Typ: Lesen. Scopes: read.

ParameterTypErforderlichBeschreibung
titlestringJaShort title shown above the canvas, in French
sourcestringJaFull .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#

Erkannte Themen mit ihrem Anteil an der Aufmerksamkeit und Stories (dasselbe Thema, gesehen in mehreren Quellen).

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

Typ: Lesen. Scopes: read.

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

getSignals#

Offene Signale, ausgelöst durch die Persistenzregeln des Workspace, mit Vorlaufzeit und Status.

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

Typ: Lesen. Scopes: read.

Dieses Tool nimmt keine Parameter: Senden Sie einen leeren Body, {}.

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

listWorkspaceTables#

Bereits im Workspace erstellte Tabellen: Name, Kommentar, Anzahl der Spalten und Zeilen und ob sich die Tabelle selbst füllt.

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

Typ: Lesen. Scopes: read.

Dieses Tool nimmt keine Parameter: Senden Sie einen leeren Body, {}.

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

getWorkspaceTable#

Eine Workspace-Tabelle als JSON: Schema, Spalten und Zeilen. Dient als Grundlage oder Datenquelle für eine Website, eine App oder einen Agenten (Scope read).

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

Typ: Lesen. Scopes: read.

ParameterTypErforderlichBeschreibung
schemastringNeinSchema, default public.
namestringJaTable 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#

Lesezeichen und Ordner des Workspace-Tresors: Titel, Typ, Ordner, Status, Aufnahme. Optionaler Filter nach Wort, Status oder Typ.

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

Typ: Lesen. Scopes: read.

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

listEntities#

Verfolgte Entitäten (Unternehmen, Marken, öffentliche Konten) und verknüpfte Items im Zeitraum.

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

Typ: Lesen. Scopes: read.

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

listWatchContracts#

Auf Quellen gesetzte Watch-Verträge: Absicht, behaltene und ausgeschlossene Begriffe, Ereignis.

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

Typ: Lesen. Scopes: read.

Dieses Tool nimmt keine Parameter: Senden Sie einen leeren Body, {}.

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

checkInvestigation#

Status der letzten Edge-Recherche oder einer bestimmten: ausstehend, laufend, abgeschlossen mit ihren Kandidaten oder fehlgeschlagen.

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

Typ: Lesen. Scopes: read.

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

Status der letzten Suche oder einer bestimmten: Stufe, gefundene Personen mit dem Urteil des Codes und Ihrem, und je Kriterium sein Status und sein datierter öffentlicher Beleg (URL, Datum, Ausschnitt). Nie Kontaktdaten.

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

Typ: Lesen. Scopes: read.

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

Schlägt für ein Ziel einen stimmigen Satz von Quellen zum Verfolgen vor. Erstellt nichts.

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

Typ: Lesen. Scopes: read.

ParameterTypErforderlichBeschreibung
namestringJa
rationalestringJaWhy this pack answers the goal
candidatesarray<object>Ja
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, die auf ein Board dieses Workspace gelegt werden können, für die Person gereiht, mit ihren Gründen.

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

Typ: Lesen. Scopes: read.

ParameterTypErforderlichBeschreibung
period7d | 30d | 90dNeinWindow 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#

Anzeigenakte eines Werbetreibenden aus den Erfassungen des Workspace: Anzeigen, laufende, Daten, Bibliotheken, Länder, gelesene Bedarfe, neue Anzeigen pro Monat und Hochfahren, neueste Anzeigen, Signale. Nie eine Person. Keine Credits.

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

Typ: Lesen. Scopes: read.

ParameterTypErforderlichBeschreibung
advertiserstringJaName (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#

Anzeigensignale des Workspace, stündlich berechnet: Kampagne gestartet oder gestoppt, Hochfahren, neues Land, neue Plattform, bezahlte Einstellung, Aktion, Launch, neuer Werbetreibender. Keine Credits.

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

Typ: Lesen. Scopes: read.

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

listCollectedAds#

Anzeigenerfassungen des Workspace (Meta, TikTok, Google, LinkedIn), bereits gelesen: die Liste oder, mit dem Namen einer Erfassung, ihre Aufschlüsselungen (Winkel, Angebote, Tonalitäten, Formate), ihr Rhythmus, ihre am längsten laufenden Anzeigen und ihre Anzeigen, gefiltert nach Bibliothek, Status, Winkel oder Wort. Keine Credits.

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

Typ: Lesen. Scopes: read.

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

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