Zum Inhalt springen

Tool-Referenz

Schreiben

Im Workspace schreiben. 12 Tools, mit ihren Parametern und Aufrufbeispielen.

Tools des Piqline-Agenten, die Objekte des Workspace erstellen oder ändern. Sie verlangen den Scope write.

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.

updateWorkspaceProfile#

Speichert das Bedarfsprofil des Workspace: Ziele, Themen, Entitäten, Sprachen, Regionen, Niveau, Rhythmus.

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

Typ: Schreiben. Scopes: write.

ParameterTypErforderlichBeschreibung
needsobjectNein
stagestringNein
onboarding_statusnot_started | in_progress | done | skippedNein
summarystringNein
curl -s https://piqline.com/api/v1/tools/updateWorkspaceProfile \
  -H "Authorization: Bearer $PIQLINE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

followEntity#

Folgt einem Unternehmen, einer Marke oder einem öffentlichen Konto (nie einer Privatperson), um seine Items und Erwähnungen zu verknüpfen.

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

Typ: Schreiben. Scopes: write.

ParameterTypErforderlichBeschreibung
namestringJa
kindcompany | brand | accountNein
sirenstringNein
domainstringNein
handlesarray<object>Nein
roleself | competitor | client | target | otherNein
aliasesarray<string>Nein
curl -s https://piqline.com/api/v1/tools/followEntity \
  -H "Authorization: Bearer $PIQLINE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"texte"}'

unfollowEntity#

Beendet das Folgen einer Entität. Ihre bestehenden Verknüpfungen bleiben.

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

Typ: Löschen. Scopes: write.

ParameterTypErforderlichBeschreibung
entityIdstringJa
curl -s https://piqline.com/api/v1/tools/unfollowEntity \
  -H "Authorization: Bearer $PIQLINE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"entityId":"5a0e9c1f-2b7d-4e63-8f14-d3c8a6b92e70"}'

saveBookmark#

Speichert ein Lesezeichen im Tresor des Workspace. Eine http(s)-URL wird zum Lesen, Archivieren und Vektorisieren eingereiht.

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

Typ: Schreiben. Scopes: write.

ParameterTypErforderlichBeschreibung
titlestringJa
hrefstringJa
kinditem | source | signal | graph | search | document | board | chatNein
subtitlestringNein
notestringNein
tagsarray<string>Nein
origindashboard | api | slack | whatsapp | mail | otherNein
originRefstringNein
curl -s https://piqline.com/api/v1/tools/saveBookmark \
  -H "Authorization: Bearer $PIQLINE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"title":"texte","href":"texte"}'

setWatchContract#

Setzt einen Watch-Vertrag auf eine Quelle: Die Watch-Seite zeigt dann nur noch die passenden Items. Deterministisch, ohne Modell.

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

Typ: Schreiben. Scopes: write.

ParameterTypErforderlichBeschreibung
sourceIdstringJa
intentstringJaWhat this workspace watches on the source, in the person's words.
includearray<string>NeinKeep an item only if it contains at least one of these terms (whole word, any case or accent).
excludearray<string>NeinDrop an item containing any of these terms.
eventhiring | funding | launch | expansion | reorg | open_to_work | leaving | interested_comment | …NeinBusiness event the item must announce (hiring, funding, launch…), read from its text.
sectorsarray<string>Nein
curl -s https://piqline.com/api/v1/tools/setWatchContract \
  -H "Authorization: Bearer $PIQLINE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"sourceId":"5a0e9c1f-2b7d-4e63-8f14-d3c8a6b92e70","intent":"texte"}'

removeWatchContract#

Entfernt den Watch-Vertrag einer Quelle: Alle Items erscheinen wieder.

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

Typ: Löschen. Scopes: write.

ParameterTypErforderlichBeschreibung
sourceIdstringJa
curl -s https://piqline.com/api/v1/tools/removeWatchContract \
  -H "Authorization: Bearer $PIQLINE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"sourceId":"5a0e9c1f-2b7d-4e63-8f14-d3c8a6b92e70"}'

initReaderInterview#

Speichert die zwei Antworten des Lese-Interviews (Wesentliches oder Detail, Hauptabsicht) im Leseprofil.

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

Typ: Schreiben. Scopes: write.

ParameterTypErforderlichBeschreibung
densityessentiel | detailJa
intentread-arrivals | spot-change | watch-entities | compare | measure-coverage | control-sources | analyze-market | prepare-output | …Ja
curl -s https://piqline.com/api/v1/tools/initReaderInterview \
  -H "Authorization: Bearer $PIQLINE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"density":"essentiel","intent":"read-arrivals"}'

applyBoardChange#

Wendet bereits freigegebene Änderungen auf ein Board an.

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

Typ: Schreiben. Scopes: write.

ParameterTypErforderlichBeschreibung
dashboardIdstringNein
changesarray<object>Ja
curl -s https://piqline.com/api/v1/tools/applyBoardChange \
  -H "Authorization: Bearer $PIQLINE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"changes":[{"id":"5a0e9c1f-2b7d-4e63-8f14-d3c8a6b92e70","kind":"add","widgetId":"5a0e9c1f-2b7d-4e63-8f14-d3c8a6b92e70","reason":"texte","title":"texte"}]}'

buildDashboard#

Baut ein Board direkt, ohne den Widget-Picker.

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

Typ: Schreiben. Scopes: write.

ParameterTypErforderlichBeschreibung
specobjectJa
savebooleanNeinPersist the board when the user is owner/admin.
curl -s https://piqline.com/api/v1/tools/buildDashboard \
  -H "Authorization: Bearer $PIQLINE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"spec":{"version":1,"title":"texte","description":"texte","period":"1h","widgets":[{"kind":"texte","title":"texte"}]}}'

saveWorkspaceTable#

Erstellt eine Workspace-Tabelle, gefüllt mit den nützlichen Spalten.

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

Typ: Schreiben. Scopes: write.

ParameterTypErforderlichBeschreibung
namestringJa
commentstringJa
columnsarray<object>Ja
rowsarray<object>Ja
curl -s https://piqline.com/api/v1/tools/saveWorkspaceTable \
  -H "Authorization: Bearer $PIQLINE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"texte","comment":"texte","columns":[{"id":"5a0e9c1f-2b7d-4e63-8f14-d3c8a6b92e70","name":"texte","type":"text"}],"rows":[{}]}'

writeFromWatch#

Schreibt einen Text aus den Items der Beobachtungen des Workspace (Artikel, LinkedIn-Beitrag, X-Thread, Instagram-Bildunterschrift, Newsletter, Videoskript, Pressemitteilung, SEO-Artikel, E-Mail, Zusammenfassung), in neun Sprachen, jede Tatsache mit [n] auf ihre Quelle belegt; der Text kommt zu den Entwürfen. Verbraucht einige Credits.

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

Typ: Schreiben. Scopes: write.

ParameterTypErforderlichBeschreibung
instructionstringJaWhat to write and for whom, in plain words, e.g. « Le post de la semaine sur ce qui a bougé dans la cosmétique ».
examplestringNeinOptional sample text whose style to follow.
scopeobjectNeinWhich items of the workspace watches to write from: sources, topics, keywords, platforms, item types or item ids, period and depth. Default: the last 7 days, 15 items.
penobjectNeinFormat (article, linkedin, x_thread, instagram, newsletter, video_script, press_release, seo_brief, email, summary), goal, tone, framework, length, voice, language (fr, en, es, de, it, pt, nl, he, ar), creativity, variants and options.
savebooleanNeinKeep the text in the workspace drafts (default). false: return it only.
curl -s https://piqline.com/api/v1/tools/writeFromWatch \
  -H "Authorization: Bearer $PIQLINE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"instruction":"texte"}'

setTableFeed#

Erweckt eine Tabelle zum Leben: Sobald ein Item des Korpus zur Regel passt, wird es nach Bestätigung hinzugefügt. status=paused stoppt das Füllen.

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

Typ: Aktion. Scopes: act, write.

ParameterTypErforderlichBeschreibung
schemastringNein
namestringJa
statuslive | pausedNein
promptstringJaThe person's words, unchanged.
summarystringJaWhat you understood, in plain French, one sentence.
sourceIdsarray<string>Nein
sourceLabelsarray<string>Nein
querystringNein
platformstringNein
itemTypepost | video | article | listing | job_offerNein
alreadyMatchingintegerNeinHow many items searchItems found just now.
curl -s https://piqline.com/api/v1/tools/setTableFeed \
  -H "Authorization: Bearer $PIQLINE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"texte","prompt":"texte","summary":"texte"}'

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