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.
| Parametro | Tipo | Obbligatorio | Descrizione |
|---|---|---|---|
needs | object | No | |
stage | string | No | |
onboarding_status | not_started | in_progress | done | skipped | No | |
summary | string | No |
curl -s https://piqline.com/api/v1/tools/updateWorkspaceProfile \
-H "Authorization: Bearer $PIQLINE_API_KEY" \
-H "Content-Type: application/json" \
-d '{}'const response = await fetch("https://piqline.com/api/v1/tools/updateWorkspaceProfile", {
method: "POST",
headers: {
Authorization: "Bearer " + process.env.PIQLINE_API_KEY,
"Content-Type": "application/json",
},
body: JSON.stringify({}),
});
const { output } = await response.json();import os
import requests
response = requests.post(
"https://piqline.com/api/v1/tools/updateWorkspaceProfile",
headers={"Authorization": "Bearer " + os.environ["PIQLINE_API_KEY"]},
json={},
)
output = response.json()["output"]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.
| Parametro | Tipo | Obbligatorio | Descrizione |
|---|---|---|---|
name | string | Sì | |
kind | company | brand | account | No | |
siren | string | No | |
domain | string | No | |
handles | array<object> | No | |
role | self | competitor | client | target | other | No | |
aliases | array<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"}'const response = await fetch("https://piqline.com/api/v1/tools/followEntity", {
method: "POST",
headers: {
Authorization: "Bearer " + process.env.PIQLINE_API_KEY,
"Content-Type": "application/json",
},
body: JSON.stringify({
"name": "texte"
}),
});
const { output } = await response.json();import os
import requests
response = requests.post(
"https://piqline.com/api/v1/tools/followEntity",
headers={"Authorization": "Bearer " + os.environ["PIQLINE_API_KEY"]},
json={
"name": "texte",
},
)
output = response.json()["output"]unfollowEntity#
Smette di seguire un'entità. I suoi collegamenti esistenti restano.
POSThttps://piqline.com/api/v1/tools/unfollowEntity
Tipo: Eliminazione. Scope: write.
| Parametro | Tipo | Obbligatorio | Descrizione |
|---|---|---|---|
entityId | string | Sì |
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"}'const response = await fetch("https://piqline.com/api/v1/tools/unfollowEntity", {
method: "POST",
headers: {
Authorization: "Bearer " + process.env.PIQLINE_API_KEY,
"Content-Type": "application/json",
},
body: JSON.stringify({
"entityId": "5a0e9c1f-2b7d-4e63-8f14-d3c8a6b92e70"
}),
});
const { output } = await response.json();import os
import requests
response = requests.post(
"https://piqline.com/api/v1/tools/unfollowEntity",
headers={"Authorization": "Bearer " + os.environ["PIQLINE_API_KEY"]},
json={
"entityId": "5a0e9c1f-2b7d-4e63-8f14-d3c8a6b92e70",
},
)
output = response.json()["output"]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.
| Parametro | Tipo | Obbligatorio | Descrizione |
|---|---|---|---|
title | string | Sì | |
href | string | Sì | |
kind | item | source | signal | graph | search | document | board | chat | No | |
subtitle | string | No | |
note | string | No | |
tags | array<string> | No | |
origin | dashboard | api | slack | whatsapp | mail | other | No | |
originRef | string | No |
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"}'const response = await fetch("https://piqline.com/api/v1/tools/saveBookmark", {
method: "POST",
headers: {
Authorization: "Bearer " + process.env.PIQLINE_API_KEY,
"Content-Type": "application/json",
},
body: JSON.stringify({
"title": "texte",
"href": "texte"
}),
});
const { output } = await response.json();import os
import requests
response = requests.post(
"https://piqline.com/api/v1/tools/saveBookmark",
headers={"Authorization": "Bearer " + os.environ["PIQLINE_API_KEY"]},
json={
"title": "texte",
"href": "texte",
},
)
output = response.json()["output"]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.
| Parametro | Tipo | Obbligatorio | Descrizione |
|---|---|---|---|
sourceId | string | Sì | |
intent | string | Sì | What this workspace watches on the source, in the person's words. |
include | array<string> | No | Keep an item only if it contains at least one of these terms (whole word, any case or accent). |
exclude | array<string> | No | Drop an item containing any of these terms. |
event | hiring | funding | launch | expansion | reorg | open_to_work | leaving | interested_comment | … | No | Business event the item must announce (hiring, funding, launch…), read from its text. |
sectors | array<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"}'const response = await fetch("https://piqline.com/api/v1/tools/setWatchContract", {
method: "POST",
headers: {
Authorization: "Bearer " + process.env.PIQLINE_API_KEY,
"Content-Type": "application/json",
},
body: JSON.stringify({
"sourceId": "5a0e9c1f-2b7d-4e63-8f14-d3c8a6b92e70",
"intent": "texte"
}),
});
const { output } = await response.json();import os
import requests
response = requests.post(
"https://piqline.com/api/v1/tools/setWatchContract",
headers={"Authorization": "Bearer " + os.environ["PIQLINE_API_KEY"]},
json={
"sourceId": "5a0e9c1f-2b7d-4e63-8f14-d3c8a6b92e70",
"intent": "texte",
},
)
output = response.json()["output"]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.
| Parametro | Tipo | Obbligatorio | Descrizione |
|---|---|---|---|
sourceId | string | Sì |
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"}'const response = await fetch("https://piqline.com/api/v1/tools/removeWatchContract", {
method: "POST",
headers: {
Authorization: "Bearer " + process.env.PIQLINE_API_KEY,
"Content-Type": "application/json",
},
body: JSON.stringify({
"sourceId": "5a0e9c1f-2b7d-4e63-8f14-d3c8a6b92e70"
}),
});
const { output } = await response.json();import os
import requests
response = requests.post(
"https://piqline.com/api/v1/tools/removeWatchContract",
headers={"Authorization": "Bearer " + os.environ["PIQLINE_API_KEY"]},
json={
"sourceId": "5a0e9c1f-2b7d-4e63-8f14-d3c8a6b92e70",
},
)
output = response.json()["output"]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.
| Parametro | Tipo | Obbligatorio | Descrizione |
|---|---|---|---|
density | essentiel | detail | Sì | |
intent | read-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"}'const response = await fetch("https://piqline.com/api/v1/tools/initReaderInterview", {
method: "POST",
headers: {
Authorization: "Bearer " + process.env.PIQLINE_API_KEY,
"Content-Type": "application/json",
},
body: JSON.stringify({
"density": "essentiel",
"intent": "read-arrivals"
}),
});
const { output } = await response.json();import os
import requests
response = requests.post(
"https://piqline.com/api/v1/tools/initReaderInterview",
headers={"Authorization": "Bearer " + os.environ["PIQLINE_API_KEY"]},
json={
"density": "essentiel",
"intent": "read-arrivals",
},
)
output = response.json()["output"]applyBoardChange#
Applica a una board modifiche già approvate.
POSThttps://piqline.com/api/v1/tools/applyBoardChange
Tipo: Scrittura. Scope: write.
| Parametro | Tipo | Obbligatorio | Descrizione |
|---|---|---|---|
dashboardId | string | No | |
changes | array<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"}]}'const response = await fetch("https://piqline.com/api/v1/tools/applyBoardChange", {
method: "POST",
headers: {
Authorization: "Bearer " + process.env.PIQLINE_API_KEY,
"Content-Type": "application/json",
},
body: JSON.stringify({
"changes": [
{
"id": "5a0e9c1f-2b7d-4e63-8f14-d3c8a6b92e70",
"kind": "add",
"widgetId": "5a0e9c1f-2b7d-4e63-8f14-d3c8a6b92e70",
"reason": "texte",
"title": "texte"
}
]
}),
});
const { output } = await response.json();import os
import requests
response = requests.post(
"https://piqline.com/api/v1/tools/applyBoardChange",
headers={"Authorization": "Bearer " + os.environ["PIQLINE_API_KEY"]},
json={
"changes": [
{
"id": "5a0e9c1f-2b7d-4e63-8f14-d3c8a6b92e70",
"kind": "add",
"widgetId": "5a0e9c1f-2b7d-4e63-8f14-d3c8a6b92e70",
"reason": "texte",
"title": "texte",
},
],
},
)
output = response.json()["output"]buildDashboard#
Costruisce direttamente una board, senza passare dalla selezione dei widget.
POSThttps://piqline.com/api/v1/tools/buildDashboard
Tipo: Scrittura. Scope: write.
| Parametro | Tipo | Obbligatorio | Descrizione |
|---|---|---|---|
spec | object | Sì | |
save | boolean | No | Persist 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"}]}}'const response = await fetch("https://piqline.com/api/v1/tools/buildDashboard", {
method: "POST",
headers: {
Authorization: "Bearer " + process.env.PIQLINE_API_KEY,
"Content-Type": "application/json",
},
body: JSON.stringify({
"spec": {
"version": 1,
"title": "texte",
"description": "texte",
"period": "1h",
"widgets": [
{
"kind": "texte",
"title": "texte"
}
]
}
}),
});
const { output } = await response.json();import os
import requests
response = requests.post(
"https://piqline.com/api/v1/tools/buildDashboard",
headers={"Authorization": "Bearer " + os.environ["PIQLINE_API_KEY"]},
json={
"spec": {
"version": 1,
"title": "texte",
"description": "texte",
"period": "1h",
"widgets": [
{
"kind": "texte",
"title": "texte",
},
],
},
},
)
output = response.json()["output"]saveWorkspaceTable#
Crea una tabella del workspace, popolata con le colonne utili.
POSThttps://piqline.com/api/v1/tools/saveWorkspaceTable
Tipo: Scrittura. Scope: write.
| Parametro | Tipo | Obbligatorio | Descrizione |
|---|---|---|---|
name | string | Sì | |
comment | string | Sì | |
columns | array<object> | Sì | |
rows | array<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":[{}]}'const response = await fetch("https://piqline.com/api/v1/tools/saveWorkspaceTable", {
method: "POST",
headers: {
Authorization: "Bearer " + process.env.PIQLINE_API_KEY,
"Content-Type": "application/json",
},
body: JSON.stringify({
"name": "texte",
"comment": "texte",
"columns": [
{
"id": "5a0e9c1f-2b7d-4e63-8f14-d3c8a6b92e70",
"name": "texte",
"type": "text"
}
],
"rows": [
{}
]
}),
});
const { output } = await response.json();import os
import requests
response = requests.post(
"https://piqline.com/api/v1/tools/saveWorkspaceTable",
headers={"Authorization": "Bearer " + os.environ["PIQLINE_API_KEY"]},
json={
"name": "texte",
"comment": "texte",
"columns": [
{
"id": "5a0e9c1f-2b7d-4e63-8f14-d3c8a6b92e70",
"name": "texte",
"type": "text",
},
],
"rows": [
{},
],
},
)
output = response.json()["output"]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.
| Parametro | Tipo | Obbligatorio | Descrizione |
|---|---|---|---|
instruction | string | Sì | 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 ». |
example | string | No | Optional sample text whose style to follow. |
scope | object | No | Which 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. |
pen | object | No | Format (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. |
save | boolean | No | Keep 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"}'const response = await fetch("https://piqline.com/api/v1/tools/writeFromWatch", {
method: "POST",
headers: {
Authorization: "Bearer " + process.env.PIQLINE_API_KEY,
"Content-Type": "application/json",
},
body: JSON.stringify({
"instruction": "texte"
}),
});
const { output } = await response.json();import os
import requests
response = requests.post(
"https://piqline.com/api/v1/tools/writeFromWatch",
headers={"Authorization": "Bearer " + os.environ["PIQLINE_API_KEY"]},
json={
"instruction": "texte",
},
)
output = response.json()["output"]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.
| Parametro | Tipo | Obbligatorio | Descrizione |
|---|---|---|---|
schema | string | No | |
name | string | Sì | |
status | live | paused | No | |
prompt | string | Sì | The person's words, unchanged. |
summary | string | Sì | What you understood, in plain French, one sentence. |
sourceIds | array<string> | No | |
sourceLabels | array<string> | No | |
query | string | No | |
platform | string | No | |
itemType | post | video | article | listing | job_offer | No | |
alreadyMatching | integer | No | How 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"}'const response = await fetch("https://piqline.com/api/v1/tools/setTableFeed", {
method: "POST",
headers: {
Authorization: "Bearer " + process.env.PIQLINE_API_KEY,
"Content-Type": "application/json",
},
body: JSON.stringify({
"name": "texte",
"prompt": "texte",
"summary": "texte"
}),
});
const { output } = await response.json();import os
import requests
response = requests.post(
"https://piqline.com/api/v1/tools/setTableFeed",
headers={"Authorization": "Bearer " + os.environ["PIQLINE_API_KEY"]},
json={
"name": "texte",
"prompt": "texte",
"summary": "texte",
},
)
output = response.json()["output"]