Vai al contenuto

Riferimento dei tool

Scrittura

Scrivere nel workspace. 12 tool, con i loro parametri ed esempi di chiamata.

Tool dell'agente Piqline che creano o modificano oggetti del workspace. Richiedono lo scope write.

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.

updateWorkspaceProfile#

Salva il profilo di esigenza del workspace: obiettivi, argomenti, entità, lingue, regioni, livello, ritmo.

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

Tipo: Scrittura. Scope: write.

ParametroTipoObbligatorioDescrizione
needsobjectNo
stagestringNo
onboarding_statusnot_started | in_progress | done | skippedNo
summarystringNo
curl -s https://piqline.com/api/v1/tools/updateWorkspaceProfile \
  -H "Authorization: Bearer $PIQLINE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

followEntity#

Segue un'azienda, un marchio o un account pubblico (mai una persona privata) per collegare i suoi elementi e le sue menzioni.

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

Tipo: Scrittura. Scope: write.

ParametroTipoObbligatorioDescrizione
namestringSì
kindcompany | brand | accountNo
sirenstringNo
domainstringNo
handlesarray<object>No
roleself | competitor | client | target | otherNo
aliasesarray<string>No
curl -s https://piqline.com/api/v1/tools/followEntity \
  -H "Authorization: Bearer $PIQLINE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"texte"}'

unfollowEntity#

Smette di seguire un'entità. I suoi collegamenti esistenti restano.

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

Tipo: Eliminazione. Scope: write.

ParametroTipoObbligatorioDescrizione
entityIdstringSì
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#

Salva un segnalibro nel vault del workspace. Un URL http(s) viene messo in coda per la lettura, l'archiviazione e la vettorizzazione.

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

Tipo: Scrittura. Scope: write.

ParametroTipoObbligatorioDescrizione
titlestringSì
hrefstringSì
kinditem | source | signal | graph | search | document | board | chatNo
subtitlestringNo
notestringNo
tagsarray<string>No
origindashboard | api | slack | whatsapp | mail | otherNo
originRefstringNo
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#

Imposta un contratto di monitoraggio su una fonte: la pagina di monitoraggio mostra poi solo gli elementi corrispondenti. Deterministico, senza modello.

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

Tipo: Scrittura. Scope: write.

ParametroTipoObbligatorioDescrizione
sourceIdstringSì
intentstringSìWhat this workspace watches on the source, in the person's words.
includearray<string>NoKeep an item only if it contains at least one of these terms (whole word, any case or accent).
excludearray<string>NoDrop an item containing any of these terms.
eventhiring | funding | launch | expansion | reorg | open_to_work | leaving | interested_comment | …NoBusiness event the item must announce (hiring, funding, launch…), read from its text.
sectorsarray<string>No
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#

Rimuove il contratto di monitoraggio di una fonte: tutti gli elementi tornano visibili.

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

Tipo: Eliminazione. Scope: write.

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

Salva le due risposte dell'intervista di lettura (essenziale o dettaglio, intento principale) nel profilo di lettura.

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

Tipo: Scrittura. Scope: write.

ParametroTipoObbligatorioDescrizione
densityessentiel | detailSì
intentread-arrivals | spot-change | watch-entities | compare | measure-coverage | control-sources | analyze-market | prepare-output | …Sì
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#

Applica a una board modifiche già approvate.

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

Tipo: Scrittura. Scope: write.

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

Costruisce direttamente una board, senza passare dalla selezione dei widget.

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

Tipo: Scrittura. Scope: write.

ParametroTipoObbligatorioDescrizione
specobjectSì
savebooleanNoPersist 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#

Crea una tabella del workspace, popolata con le colonne utili.

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

Tipo: Scrittura. Scope: write.

ParametroTipoObbligatorioDescrizione
namestringSì
commentstringSì
columnsarray<object>Sì
rowsarray<object>Sì
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#

Scrive un testo a partire dagli elementi dei monitoraggi del workspace (articolo, post LinkedIn, thread X, didascalia Instagram, newsletter, script video, comunicato stampa, articolo SEO, e-mail, riepilogo), in nove lingue, con ogni fatto citato [n] rispetto alla sua fonte; il testo entra nelle bozze. Consuma alcuni crediti.

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

Tipo: Scrittura. Scope: write.

ParametroTipoObbligatorioDescrizione
instructionstringSìWhat to write and for whom, in plain words, e.g. « Le post de la semaine sur ce qui a bougé dans la cosmétique ».
examplestringNoOptional sample text whose style to follow.
scopeobjectNoWhich 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.
penobjectNoFormat (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.
savebooleanNoKeep 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#

Dà vita a una tabella: non appena un elemento del corpus corrisponde alla regola, viene aggiunto, dopo conferma. status=paused interrompe il popolamento.

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

Tipo: Azione. Scope: act, write.

ParametroTipoObbligatorioDescrizione
schemastringNo
namestringSì
statuslive | pausedNo
promptstringSìThe person's words, unchanged.
summarystringSìWhat you understood, in plain French, one sentence.
sourceIdsarray<string>No
sourceLabelsarray<string>No
querystringNo
platformstringNo
itemTypepost | video | article | listing | job_offerNo
alreadyMatchingintegerNoHow 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"}'

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