Referência das ferramentas
Escrita
Escrever no workspace. 12 ferramentas, com seus parâmetros e exemplos de chamada.
Ferramentas do agente Piqline que criam ou alteram objetos do workspace. Exigem o scope write.
Cada chamada é uma requisição POST com a chave em Authorization: Bearer. O corpo JSON é a entrada da ferramenta, e a resposta tem o formato { "tool": "nom", "output": … }. Os exemplos trazem apenas os parâmetros obrigatórios. As descrições dos parâmetros são as que os agentes leem.
updateWorkspaceProfile#
Salva o perfil de necessidades do workspace: objetivos, assuntos, entidades, idiomas, regiões, nível, ritmo.
POSThttps://piqline.com/api/v1/tools/updateWorkspaceProfile
Tipo: Escrita. Scopes: write.
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
needs | object | Não | |
stage | string | Não | |
onboarding_status | not_started | in_progress | done | skipped | Não | |
summary | string | Não |
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#
Acompanha uma empresa, uma marca ou uma conta pública (nunca uma pessoa física) para vincular seus itens e menções.
POSThttps://piqline.com/api/v1/tools/followEntity
Tipo: Escrita. Scopes: write.
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
name | string | Sim | |
kind | company | brand | account | Não | |
siren | string | Não | |
domain | string | Não | |
handles | array<object> | Não | |
role | self | competitor | client | target | other | Não | |
aliases | array<string> | Não |
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#
Para de acompanhar uma entidade. Os vínculos existentes permanecem.
POSThttps://piqline.com/api/v1/tools/unfollowEntity
Tipo: Exclusão. Scopes: write.
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
entityId | string | Sim |
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 um favorito no cofre do workspace. Uma URL http(s) entra na fila para leitura, arquivamento e vetorização.
POSThttps://piqline.com/api/v1/tools/saveBookmark
Tipo: Escrita. Scopes: write.
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
title | string | Sim | |
href | string | Sim | |
kind | item | source | signal | graph | search | document | board | chat | Não | |
subtitle | string | Não | |
note | string | Não | |
tags | array<string> | Não | |
origin | dashboard | api | slack | whatsapp | mail | other | Não | |
originRef | string | Não |
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#
Define um contrato de monitoramento em uma fonte: a página de monitoramento mostra então apenas os itens correspondentes. Determinístico, sem modelo.
POSThttps://piqline.com/api/v1/tools/setWatchContract
Tipo: Escrita. Scopes: write.
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
sourceId | string | Sim | |
intent | string | Sim | What this workspace watches on the source, in the person's words. |
include | array<string> | Não | Keep an item only if it contains at least one of these terms (whole word, any case or accent). |
exclude | array<string> | Não | Drop an item containing any of these terms. |
event | hiring | funding | launch | expansion | reorg | open_to_work | leaving | interested_comment | … | Não | Business event the item must announce (hiring, funding, launch…), read from its text. |
sectors | array<string> | Não |
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#
Remove o contrato de monitoramento de uma fonte: todos os itens voltam a aparecer.
POSThttps://piqline.com/api/v1/tools/removeWatchContract
Tipo: Exclusão. Scopes: write.
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
sourceId | string | Sim |
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 as duas respostas da entrevista de leitura (o essencial ou o detalhe, intenção principal) no perfil de leitura.
POSThttps://piqline.com/api/v1/tools/initReaderInterview
Tipo: Escrita. Scopes: write.
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
density | essentiel | detail | Sim | |
intent | read-arrivals | spot-change | watch-entities | compare | measure-coverage | control-sources | analyze-market | prepare-output | … | Sim |
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#
Aplica a um board alterações que já foram aprovadas.
POSThttps://piqline.com/api/v1/tools/applyBoardChange
Tipo: Escrita. Scopes: write.
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
dashboardId | string | Não | |
changes | array<object> | Sim |
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#
Monta um board diretamente, sem passar pelo seletor de widgets.
POSThttps://piqline.com/api/v1/tools/buildDashboard
Tipo: Escrita. Scopes: write.
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
spec | object | Sim | |
save | boolean | Não | 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#
Cria uma tabela do workspace, preenchida com as colunas úteis.
POSThttps://piqline.com/api/v1/tools/saveWorkspaceTable
Tipo: Escrita. Scopes: write.
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
name | string | Sim | |
comment | string | Sim | |
columns | array<object> | Sim | |
rows | array<object> | Sim |
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#
Escreve um texto a partir dos itens dos monitoramentos do workspace (artigo, post de LinkedIn, thread do X, legenda de Instagram, newsletter, roteiro de vídeo, comunicado de imprensa, artigo SEO, e-mail, resumo), em nove idiomas, com cada fato citado [n] até a sua fonte; o texto entra nos rascunhos. Consome alguns créditos.
POSThttps://piqline.com/api/v1/tools/writeFromWatch
Tipo: Escrita. Scopes: write.
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
instruction | string | Sim | 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 | Não | Optional sample text whose style to follow. |
scope | object | Não | 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 | Não | 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 | Não | 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á vida a uma tabela: assim que um item do corpus corresponde à regra, ele é adicionado, após confirmação. status=paused interrompe o preenchimento.
POSThttps://piqline.com/api/v1/tools/setTableFeed
Tipo: Ação. Scopes: act, write.
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
schema | string | Não | |
name | string | Sim | |
status | live | paused | Não | |
prompt | string | Sim | The person's words, unchanged. |
summary | string | Sim | What you understood, in plain French, one sentence. |
sourceIds | array<string> | Não | |
sourceLabels | array<string> | Não | |
query | string | Não | |
platform | string | Não | |
itemType | post | video | article | listing | job_offer | Não | |
alreadyMatching | integer | Não | 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"]