Referência das ferramentas
Ações
Agir sobre fontes e regras. 12 ferramentas, com seus parâmetros e exemplos de chamada.
Ferramentas de ação do agente Piqline. No chat, cada uma pede confirmação. Pela API, uma chamada direta com o scope act conta como confirmação: só chame essas ferramentas depois que a pessoa envolvida concordar.
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.
subscribeSource#
Assina uma nova fonte. Inicia uma coleta real (tarefas de leitura, cotas das plataformas).
POSThttps://piqline.com/api/v1/tools/subscribeSource
Tipo: Ação. Scopes: act.
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
platform | instagram | tiktok | youtube | twitter | x | threads | linkedin | reddit | … | Sim | |
target | string | Não | Handle, URL, mot-clé Marketplace, ou communauté. Une recherche LinkedIn peut s’appuyer sur query. |
title | string | Não | |
facebookKind | page | group | marketplace | Não | Facebook : page publique, groupe public, ou recherche Marketplace. |
tiktokKind | profile | live | Não | TikTok only. live = /v1/tiktok/user/live probe, not profile posts. |
linkedinKind | company | search | Não | LinkedIn only. search = recurring public-post search on query. |
location | string | Não | Marketplace : ville ou zone. |
lat | number | Não | |
lng | number | Não | |
radiusKm | number | Não | |
minPrice | number | Não | |
maxPrice | number | Não | |
sortBy | string | Não | |
condition | string | Não | |
dateListed | string | Não | |
categoryId | string | Não | |
delivery | string | Não | |
availability | string | Não | |
datePosted | last-hour | last-day | last-week | last-month | last-year | Não | LinkedIn search only. Window of each run, default last-week. |
query | string | Não | Marketplace keyword or LinkedIn search query. |
intent | string | Não | LinkedIn search: the user's ask, kept on the source. |
detectionEvent | hiring | funding | launch | expansion | reorg | open_to_work | leaving | interested_comment | … | Não | |
detectionRounds | array<pre_seed | seed | series_a | series_b | series_c | series_d | bridge | extension | …> | Não | |
detectionSectors | array<string> | Não | |
detectionGeos | array<string> | Não | |
detectionVocabulary | array<string> | Não | |
moreQueries | array<string> | Não | LinkedIn search only. Up to 3 other phrases followed together with query, one per job family, each probed by probeLinkedinWatch with at least one relevant post. |
maxPosts | integer | Não | LinkedIn search only. Posts read at most per run: 15, 50, 100 or 200 (default 50). Each post read uses credits; a run reads only posts newer than the last one stored. |
detectionAuthors | array<recruiter | founder | manager> | Não | LinkedIn search only. Keep only posts whose author's title reads as one of these roles (recruiter, founder, manager). Empty = every author. |
rhythm | hourly | every_6h | daily | weekly | Não | LinkedIn search only. Run rhythm chosen by the user (hourly, every_6h, daily, weekly). Omit to keep the rhythm suggested by the probe. |
investigation | object | Não | Lot 7: pass the investigation object from probeLinkedinWatch unchanged. |
trackItemVariations | boolean | Não | Marketplace / listing only. True only if the user explicitly asked to follow price, text or presence on the same item (T8). Default false: new items only. |
enrichFromUrl | boolean | Não | Listing / web only. Open each item URL to read the page text. Default false. Each opened page uses credits. Set true only if the user explicitly asked. |
curl -s https://piqline.com/api/v1/tools/subscribeSource \
-H "Authorization: Bearer $PIQLINE_API_KEY" \
-H "Content-Type: application/json" \
-d '{"platform":"instagram"}'const response = await fetch("https://piqline.com/api/v1/tools/subscribeSource", {
method: "POST",
headers: {
Authorization: "Bearer " + process.env.PIQLINE_API_KEY,
"Content-Type": "application/json",
},
body: JSON.stringify({
"platform": "instagram"
}),
});
const { output } = await response.json();import os
import requests
response = requests.post(
"https://piqline.com/api/v1/tools/subscribeSource",
headers={"Authorization": "Bearer " + os.environ["PIQLINE_API_KEY"]},
json={
"platform": "instagram",
},
)
output = response.json()["output"]subscribeSources#
Assina várias fontes em uma única chamada e devolve um resultado por fonte.
POSThttps://piqline.com/api/v1/tools/subscribeSources
Tipo: Ação. Scopes: act.
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
sources | array<object> | Sim |
curl -s https://piqline.com/api/v1/tools/subscribeSources \
-H "Authorization: Bearer $PIQLINE_API_KEY" \
-H "Content-Type: application/json" \
-d '{"sources":[{"platform":"instagram"}]}'const response = await fetch("https://piqline.com/api/v1/tools/subscribeSources", {
method: "POST",
headers: {
Authorization: "Bearer " + process.env.PIQLINE_API_KEY,
"Content-Type": "application/json",
},
body: JSON.stringify({
"sources": [
{
"platform": "instagram"
}
]
}),
});
const { output } = await response.json();import os
import requests
response = requests.post(
"https://piqline.com/api/v1/tools/subscribeSources",
headers={"Authorization": "Bearer " + os.environ["PIQLINE_API_KEY"]},
json={
"sources": [
{
"platform": "instagram",
},
],
},
)
output = response.json()["output"]unsubscribeSource#
Para de acompanhar uma fonte. Os itens já coletados permanecem no corpus.
POSThttps://piqline.com/api/v1/tools/unsubscribeSource
Tipo: Ação. Scopes: act.
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
sourceId | string | Sim | |
label | string | Não | Nom lisible de la source (celui de listSources). Obligatoire pour la carte de confirmation. |
curl -s https://piqline.com/api/v1/tools/unsubscribeSource \
-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/unsubscribeSource", {
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/unsubscribeSource",
headers={"Authorization": "Bearer " + os.environ["PIQLINE_API_KEY"]},
json={
"sourceId": "5a0e9c1f-2b7d-4e63-8f14-d3c8a6b92e70",
},
)
output = response.json()["output"]setHomeDashboard#
Define um board salvo como a página inicial do workspace.
POSThttps://piqline.com/api/v1/tools/setHomeDashboard
Tipo: Ação. Scopes: act.
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
dashboardId | string | Sim | |
title | string | Não | Titre du tableau, pour la carte de confirmation. Jamais l’identifiant seul. |
curl -s https://piqline.com/api/v1/tools/setHomeDashboard \
-H "Authorization: Bearer $PIQLINE_API_KEY" \
-H "Content-Type: application/json" \
-d '{"dashboardId":"5a0e9c1f-2b7d-4e63-8f14-d3c8a6b92e70"}'const response = await fetch("https://piqline.com/api/v1/tools/setHomeDashboard", {
method: "POST",
headers: {
Authorization: "Bearer " + process.env.PIQLINE_API_KEY,
"Content-Type": "application/json",
},
body: JSON.stringify({
"dashboardId": "5a0e9c1f-2b7d-4e63-8f14-d3c8a6b92e70"
}),
});
const { output } = await response.json();import os
import requests
response = requests.post(
"https://piqline.com/api/v1/tools/setHomeDashboard",
headers={"Authorization": "Bearer " + os.environ["PIQLINE_API_KEY"]},
json={
"dashboardId": "5a0e9c1f-2b7d-4e63-8f14-d3c8a6b92e70",
},
)
output = response.json()["output"]upsertSignalRule#
Cria ou atualiza uma regra de sinal de persistência: ela dispara quando um item permanece no ar por mais tempo que o limite.
POSThttps://piqline.com/api/v1/tools/upsertSignalRule
Tipo: Ação. Scopes: act.
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
ruleId | string | Não | |
thresholdDays | integer | Não | |
staleGraceDays | integer | Não | |
itemTypes | array<post | video | article | listing | job_offer> | Não | |
enabled | boolean | Não |
curl -s https://piqline.com/api/v1/tools/upsertSignalRule \
-H "Authorization: Bearer $PIQLINE_API_KEY" \
-H "Content-Type: application/json" \
-d '{}'const response = await fetch("https://piqline.com/api/v1/tools/upsertSignalRule", {
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/upsertSignalRule",
headers={"Authorization": "Bearer " + os.environ["PIQLINE_API_KEY"]},
json={},
)
output = response.json()["output"]upsertQuestionRule#
Cria ou atualiza uma pergunta permanente: uma frase em linguagem natural que o Jev faz a cada novo item das fontes do workspace. O limite de probabilidade gera o sinal.
POSThttps://piqline.com/api/v1/tools/upsertQuestionRule
Tipo: Ação. Scopes: act.
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
ruleId | string | Não | |
question | string | Sim | |
minProbability | number | Não | |
itemTypes | array<post | video | article | listing | job_offer> | Não | |
enabled | boolean | Não |
curl -s https://piqline.com/api/v1/tools/upsertQuestionRule \
-H "Authorization: Bearer $PIQLINE_API_KEY" \
-H "Content-Type: application/json" \
-d '{"question":"texte"}'const response = await fetch("https://piqline.com/api/v1/tools/upsertQuestionRule", {
method: "POST",
headers: {
Authorization: "Bearer " + process.env.PIQLINE_API_KEY,
"Content-Type": "application/json",
},
body: JSON.stringify({
"question": "texte"
}),
});
const { output } = await response.json();import os
import requests
response = requests.post(
"https://piqline.com/api/v1/tools/upsertQuestionRule",
headers={"Authorization": "Bearer " + os.environ["PIQLINE_API_KEY"]},
json={
"question": "texte",
},
)
output = response.json()["output"]startInvestigation#
Coloca na fila uma investigação Edge em segundo plano para este workspace (owner ou admin).
POSThttps://piqline.com/api/v1/tools/startInvestigation
Tipo: Ação. Scopes: act.
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
intent | string | Sim | Need in one sentence, from sujets / zones / langues already noted |
perimeter | object | Não | Optional sectors, geos, accounts, seed URLs from the need profile |
curl -s https://piqline.com/api/v1/tools/startInvestigation \
-H "Authorization: Bearer $PIQLINE_API_KEY" \
-H "Content-Type: application/json" \
-d '{"intent":"texte"}'const response = await fetch("https://piqline.com/api/v1/tools/startInvestigation", {
method: "POST",
headers: {
Authorization: "Bearer " + process.env.PIQLINE_API_KEY,
"Content-Type": "application/json",
},
body: JSON.stringify({
"intent": "texte"
}),
});
const { output } = await response.json();import os
import requests
response = requests.post(
"https://piqline.com/api/v1/tools/startInvestigation",
headers={"Authorization": "Bearer " + os.environ["PIQLINE_API_KEY"]},
json={
"intent": "texte",
},
)
output = response.json()["output"]startHunt#
Inicia uma busca: encontrar pessoas que atendam a critérios verificáveis, cada critério comprovado por uma fonte pública datada. Critérios sensíveis são recusados, nenhum dado de contato é devolvido. Roda em segundo plano e consome os créditos do mês; owner ou admin.
POSThttps://piqline.com/api/v1/tools/startHunt
Tipo: Ação. Scopes: act.
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
brief | string | Sim | Who to find, in one or two sentences. |
purpose | string | Sim | Why these people are sought, in one sentence. Recorded with the hunt. |
criteria | array<object> | Sim | |
target | integer | Não | How many people to find. |
curl -s https://piqline.com/api/v1/tools/startHunt \
-H "Authorization: Bearer $PIQLINE_API_KEY" \
-H "Content-Type: application/json" \
-d '{"brief":"texte","purpose":"texte","criteria":[{"label":"texte"}]}'const response = await fetch("https://piqline.com/api/v1/tools/startHunt", {
method: "POST",
headers: {
Authorization: "Bearer " + process.env.PIQLINE_API_KEY,
"Content-Type": "application/json",
},
body: JSON.stringify({
"brief": "texte",
"purpose": "texte",
"criteria": [
{
"label": "texte"
}
]
}),
});
const { output } = await response.json();import os
import requests
response = requests.post(
"https://piqline.com/api/v1/tools/startHunt",
headers={"Authorization": "Bearer " + os.environ["PIQLINE_API_KEY"]},
json={
"brief": "texte",
"purpose": "texte",
"criteria": [
{
"label": "texte",
},
],
},
)
output = response.json()["output"]buildAdAudit#
Auditoria retroativa das campanhas de 1 a 6 anunciantes já coletados, ao longo de N meses: uma tabela do workspace (anunciante, mês, novos anúncios, encerramentos, bibliotecas, países, necessidades lidas, aumento de ritmo) e os números de um resumo citado. Sem créditos.
POSThttps://piqline.com/api/v1/tools/buildAdAudit
Tipo: Escrita. Scopes: write.
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
advertisers | array<string> | Sim | Names of the advertisers, as in the collections. |
months | integer | Não | |
name | string | Não | Table name. Default: « Audit publicitaire ». |
curl -s https://piqline.com/api/v1/tools/buildAdAudit \
-H "Authorization: Bearer $PIQLINE_API_KEY" \
-H "Content-Type: application/json" \
-d '{"advertisers":["texte"]}'const response = await fetch("https://piqline.com/api/v1/tools/buildAdAudit", {
method: "POST",
headers: {
Authorization: "Bearer " + process.env.PIQLINE_API_KEY,
"Content-Type": "application/json",
},
body: JSON.stringify({
"advertisers": [
"texte"
]
}),
});
const { output } = await response.json();import os
import requests
response = requests.post(
"https://piqline.com/api/v1/tools/buildAdAudit",
headers={"Authorization": "Bearer " + os.environ["PIQLINE_API_KEY"]},
json={
"advertisers": [
"texte",
],
},
)
output = response.json()["output"]findCreatorSponsors#
Quem paga criadores do YouTube em um nicho: pesquisa de vídeos recentes, patrocinadores deduzidos de cada vídeo, uma tabela do workspace “Patrocinadores · nicho”. Consome créditos; confirmação no chat, owner ou admin.
POSThttps://piqline.com/api/v1/tools/findCreatorSponsors
Tipo: Ação. Scopes: act, write, explore.
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
niche | string | Sim | Words of the niche, as a creator would title a video (« compléments alimentaires »). |
videos | integer | Não | |
period | this_week | this_month | this_year | Não | |
country | string | Não | YouTube region, FR by default. |
follow | boolean | Não | true: follow the niche, run again every week, and raise A13 when a brand starts sponsoring creators of the niche (in the bell and alert e-mails). |
curl -s https://piqline.com/api/v1/tools/findCreatorSponsors \
-H "Authorization: Bearer $PIQLINE_API_KEY" \
-H "Content-Type: application/json" \
-d '{"niche":"texte"}'const response = await fetch("https://piqline.com/api/v1/tools/findCreatorSponsors", {
method: "POST",
headers: {
Authorization: "Bearer " + process.env.PIQLINE_API_KEY,
"Content-Type": "application/json",
},
body: JSON.stringify({
"niche": "texte"
}),
});
const { output } = await response.json();import os
import requests
response = requests.post(
"https://piqline.com/api/v1/tools/findCreatorSponsors",
headers={"Authorization": "Bearer " + os.environ["PIQLINE_API_KEY"]},
json={
"niche": "texte",
},
)
output = response.json()["output"]importAdHistory#
Importa o histórico do Google de uma coleta de anunciante: até 20 páginas (cerca de 800 anúncios desde 2021) para datar campanhas passadas. Consome créditos; confirmação no chat, owner ou admin.
POSThttps://piqline.com/api/v1/tools/importAdHistory
Tipo: Ação. Scopes: act, write, explore.
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
collection | string | Sim | Name of the advertiser collection. |
curl -s https://piqline.com/api/v1/tools/importAdHistory \
-H "Authorization: Bearer $PIQLINE_API_KEY" \
-H "Content-Type: application/json" \
-d '{"collection":"texte"}'const response = await fetch("https://piqline.com/api/v1/tools/importAdHistory", {
method: "POST",
headers: {
Authorization: "Bearer " + process.env.PIQLINE_API_KEY,
"Content-Type": "application/json",
},
body: JSON.stringify({
"collection": "texte"
}),
});
const { output } = await response.json();import os
import requests
response = requests.post(
"https://piqline.com/api/v1/tools/importAdHistory",
headers={"Authorization": "Bearer " + os.environ["PIQLINE_API_KEY"]},
json={
"collection": "texte",
},
)
output = response.json()["output"]startAdCollection#
Inicia uma coleta de anúncios de um anunciante (nome ou domínio) ou de uma palavra-chave: lê Meta, TikTok, Google e LinkedIn, coloca cada anúncio no mesmo formato e lê o ângulo, a oferta, o público e o tom. Consome créditos; confirmação no chat, owner ou admin.
POSThttps://piqline.com/api/v1/tools/startAdCollection
Tipo: Ação. Scopes: act, write, explore.
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
query | string | Sim | Nom ou domaine de l'annonceur (kind advertiser), ou mot-clé (kind keyword). |
kind | advertiser | keyword | Não | |
libraries | array<meta | tiktok | google | linkedin> | Não | Bibliothèques à lire. Google ne cherche pas par mot-clé. |
country | string | Não | Code pays ISO. Restreint Meta et LinkedIn, choisit l'entité annonceur de Google (FR par défaut). Courants : FR, BE, CH, LU, DE, ES, IT, NL, GB, IE, US, CA, MA, SN, CI, AU, BR, JP. |
depth | apercu | large | Não | apercu : une page par bibliothèque. large : jusqu'à quatre pages (plus long). |
cadence | manuel | quotidien | hebdomadaire | Não | manuel : à la main. quotidien ou hebdomadaire : la collecte se repasse seule, dans le plafond du jour, et ses signaux arrivent dans la cloche. |
curl -s https://piqline.com/api/v1/tools/startAdCollection \
-H "Authorization: Bearer $PIQLINE_API_KEY" \
-H "Content-Type: application/json" \
-d '{"query":"levée de fonds"}'const response = await fetch("https://piqline.com/api/v1/tools/startAdCollection", {
method: "POST",
headers: {
Authorization: "Bearer " + process.env.PIQLINE_API_KEY,
"Content-Type": "application/json",
},
body: JSON.stringify({
"query": "levée de fonds"
}),
});
const { output } = await response.json();import os
import requests
response = requests.post(
"https://piqline.com/api/v1/tools/startAdCollection",
headers={"Authorization": "Bearer " + os.environ["PIQLINE_API_KEY"]},
json={
"query": "levée de fonds",
},
)
output = response.json()["output"]