Ir para o conteúdo

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âmetroTipoObrigatórioDescrição
platforminstagram | tiktok | youtube | twitter | x | threads | linkedin | reddit | …Sim
targetstringNãoHandle, URL, mot-clé Marketplace, ou communauté. Une recherche LinkedIn peut s’appuyer sur query.
titlestringNão
facebookKindpage | group | marketplaceNãoFacebook : page publique, groupe public, ou recherche Marketplace.
tiktokKindprofile | liveNãoTikTok only. live = /v1/tiktok/user/live probe, not profile posts.
linkedinKindcompany | searchNãoLinkedIn only. search = recurring public-post search on query.
locationstringNãoMarketplace : ville ou zone.
latnumberNão
lngnumberNão
radiusKmnumberNão
minPricenumberNão
maxPricenumberNão
sortBystringNão
conditionstringNão
dateListedstringNão
categoryIdstringNão
deliverystringNão
availabilitystringNão
datePostedlast-hour | last-day | last-week | last-month | last-yearNãoLinkedIn search only. Window of each run, default last-week.
querystringNãoMarketplace keyword or LinkedIn search query.
intentstringNãoLinkedIn search: the user's ask, kept on the source.
detectionEventhiring | funding | launch | expansion | reorg | open_to_work | leaving | interested_comment | …Não
detectionRoundsarray<pre_seed | seed | series_a | series_b | series_c | series_d | bridge | extension | …>Não
detectionSectorsarray<string>Não
detectionGeosarray<string>Não
detectionVocabularyarray<string>Não
moreQueriesarray<string>NãoLinkedIn 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.
maxPostsintegerNãoLinkedIn 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.
detectionAuthorsarray<recruiter | founder | manager>NãoLinkedIn search only. Keep only posts whose author's title reads as one of these roles (recruiter, founder, manager). Empty = every author.
rhythmhourly | every_6h | daily | weeklyNãoLinkedIn search only. Run rhythm chosen by the user (hourly, every_6h, daily, weekly). Omit to keep the rhythm suggested by the probe.
investigationobjectNãoLot 7: pass the investigation object from probeLinkedinWatch unchanged.
trackItemVariationsbooleanNãoMarketplace / 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.
enrichFromUrlbooleanNãoListing / 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"}'

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âmetroTipoObrigatórioDescrição
sourcesarray<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"}]}'

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âmetroTipoObrigatórioDescrição
sourceIdstringSim
labelstringNãoNom 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"}'

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âmetroTipoObrigatórioDescrição
dashboardIdstringSim
titlestringNãoTitre 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"}'

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âmetroTipoObrigatórioDescrição
ruleIdstringNão
thresholdDaysintegerNão
staleGraceDaysintegerNão
itemTypesarray<post | video | article | listing | job_offer>Não
enabledbooleanNão
curl -s https://piqline.com/api/v1/tools/upsertSignalRule \
  -H "Authorization: Bearer $PIQLINE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

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âmetroTipoObrigatórioDescrição
ruleIdstringNão
questionstringSim
minProbabilitynumberNão
itemTypesarray<post | video | article | listing | job_offer>Não
enabledbooleanNão
curl -s https://piqline.com/api/v1/tools/upsertQuestionRule \
  -H "Authorization: Bearer $PIQLINE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"question":"texte"}'

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âmetroTipoObrigatórioDescrição
intentstringSimNeed in one sentence, from sujets / zones / langues already noted
perimeterobjectNãoOptional 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"}'

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âmetroTipoObrigatórioDescrição
briefstringSimWho to find, in one or two sentences.
purposestringSimWhy these people are sought, in one sentence. Recorded with the hunt.
criteriaarray<object>Sim
targetintegerNãoHow 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"}]}'

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âmetroTipoObrigatórioDescrição
advertisersarray<string>SimNames of the advertisers, as in the collections.
monthsintegerNão
namestringNãoTable 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"]}'

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âmetroTipoObrigatórioDescrição
nichestringSimWords of the niche, as a creator would title a video (« compléments alimentaires »).
videosintegerNão
periodthis_week | this_month | this_yearNão
countrystringNãoYouTube region, FR by default.
followbooleanNãotrue: 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"}'

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âmetroTipoObrigatórioDescrição
collectionstringSimName 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"}'

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âmetroTipoObrigatórioDescrição
querystringSimNom ou domaine de l'annonceur (kind advertiser), ou mot-clé (kind keyword).
kindadvertiser | keywordNão
librariesarray<meta | tiktok | google | linkedin>NãoBibliothèques à lire. Google ne cherche pas par mot-clé.
countrystringNãoCode 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.
depthapercu | largeNãoapercu : une page par bibliothèque. large : jusqu'à quatre pages (plus long).
cadencemanuel | quotidien | hebdomadaireNãomanuel : à 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"}'

Uma dúvida sobre a API, ou um erro nesta página? Escreva para nós.