Ir para o conteúdo

Referência das ferramentas

Corpus

Ler o corpus e o workspace. 22 ferramentas, com seus parâmetros e exemplos de chamada.

Ferramentas do agente Piqline. Elas leem o que o workspace já coletou: sem consumo de créditos, nada é gravado.

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.

getCoverageStats#

Volumes e saúde da coleta: totais, divisão por plataforma e por tipo, séries de ingestão na janela de análise (1h, 24h, 7d ou 30d).

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

Tipo: Leitura. Scopes: read.

ParâmetroTipoObrigatórioDescrição
period1h | 24h | 7d | 30dNãoAnalysis window
curl -s https://piqline.com/api/v1/tools/getCoverageStats \
  -H "Authorization: Bearer $PIQLINE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

listSources#

Fontes que o workspace acompanha, com número de itens, saúde e última leitura.

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

Tipo: Leitura. Scopes: read.

Esta ferramenta não recebe parâmetros: envie um corpo vazio, {}.

curl -s https://piqline.com/api/v1/tools/listSources \
  -H "Authorization: Bearer $PIQLINE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

searchItems#

Busca itens (posts, vídeos, artigos, anúncios, vagas) com filtros: texto, plataforma, tipo, fonte. Sem filtro, devolve os mais recentes (40 no máximo).

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

Tipo: Leitura. Scopes: read.

ParâmetroTipoObrigatórioDescrição
querystringNãoFree-text match on title and body
platformstringNão
itemTypepost | video | article | listing | job_offerNão
sourceIdstringNão
limitintegerNão
curl -s https://piqline.com/api/v1/tools/searchItems \
  -H "Authorization: Bearer $PIQLINE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

getItem#

Detalhe de um item: texto, transcrição, OCR, temas detectados, itens próximos em significado e suas datas de observação.

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

Tipo: Leitura. Scopes: read.

ParâmetroTipoObrigatórioDescrição
itemIdstringSim
curl -s https://piqline.com/api/v1/tools/getItem \
  -H "Authorization: Bearer $PIQLINE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"itemId":"5a0e9c1f-2b7d-4e63-8f14-d3c8a6b92e70"}'

searchPassages#

Busca por significado em documentos longos (PDFs lidos pelo Motor): as passagens mais próximas de uma pergunta, com o item, a página e o título da seção.

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

Tipo: Leitura. Scopes: read.

ParâmetroTipoObrigatórioDescrição
querystringSimQuestion or phrase to look for
itemIdstringNãoLimit to one document
limitintegerNão
curl -s https://piqline.com/api/v1/tools/searchPassages \
  -H "Authorization: Bearer $PIQLINE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"query":"levée de fonds"}'

citeItem#

Verifica se uma passagem aparece palavra por palavra em um item e devolve um número de citação; caso contrário, a passagem mais próxima. Base do modo Citações do chat.

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

Tipo: Leitura. Scopes: read.

ParâmetroTipoObrigatórioDescrição
itemIdstringSimItem id from searchItems or getItem
quotestringSimExact passage copied from the item text
curl -s https://piqline.com/api/v1/tools/citeItem \
  -H "Authorization: Bearer $PIQLINE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"itemId":"5a0e9c1f-2b7d-4e63-8f14-d3c8a6b92e70","quote":"texte"}'

drawDiagram#

Desenha a resposta como um diagrama SVG (linha do tempo, matriz, fluxo, árvore…): cores por papel do tema, SVG sanitizado antes da exibição. Base do modo Diagrama do chat.

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

Tipo: Leitura. Scopes: read.

ParâmetroTipoObrigatórioDescrição
typearchitecture | flowchart | sequence | state | timeline | swimlane | quadrant | tree | …SimVisual type chosen for the layout
titlestringSimShort name of the subject, in the user's language
descriptionstringSimOne sentence on what the diagram shows, for screen readers and the caption
svgstringSimA single <svg viewBox="0 0 960 H">…</svg> following the diagram rules
curl -s https://piqline.com/api/v1/tools/drawDiagram \
  -H "Authorization: Bearer $PIQLINE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"type":"architecture","title":"texte","description":"texte","svg":"texte"}'

createCanvas#

Compila um canvas (um arquivo TSX que só importa o SDK piqline/canvas) e devolve código pronto para exibir, ou o erro a corrigir. Base dos modos Canvas e Relatório do chat.

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

Tipo: Leitura. Scopes: read.

ParâmetroTipoObrigatórioDescrição
titlestringSimShort title shown above the canvas, in French
sourcestringSimFull .canvas.tsx source
curl -s https://piqline.com/api/v1/tools/createCanvas \
  -H "Authorization: Bearer $PIQLINE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"title":"texte","source":"texte"}'

getTopics#

Temas detectados com sua parcela de voz e histórias (o mesmo assunto visto em várias fontes).

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

Tipo: Leitura. Scopes: read.

ParâmetroTipoObrigatórioDescrição
period1h | 24h | 7d | 30dNãoAnalysis window
curl -s https://piqline.com/api/v1/tools/getTopics \
  -H "Authorization: Bearer $PIQLINE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

getSignals#

Sinais abertos, disparados pelas regras de persistência do workspace, com seu prazo e status.

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

Tipo: Leitura. Scopes: read.

Esta ferramenta não recebe parâmetros: envie um corpo vazio, {}.

curl -s https://piqline.com/api/v1/tools/getSignals \
  -H "Authorization: Bearer $PIQLINE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

listWorkspaceTables#

Tabelas já criadas no workspace: nome, comentário, número de colunas e linhas, e se a tabela se preenche sozinha.

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

Tipo: Leitura. Scopes: read.

Esta ferramenta não recebe parâmetros: envie um corpo vazio, {}.

curl -s https://piqline.com/api/v1/tools/listWorkspaceTables \
  -H "Authorization: Bearer $PIQLINE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

getWorkspaceTable#

Uma tabela do workspace em JSON: esquema, colunas e linhas. Serve de base ou de alimentação para um site, um app ou um agente (scope read).

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

Tipo: Leitura. Scopes: read.

ParâmetroTipoObrigatórioDescrição
schemastringNãoSchema, default public.
namestringSimTable name.
curl -s https://piqline.com/api/v1/tools/getWorkspaceTable \
  -H "Authorization: Bearer $PIQLINE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"texte"}'

listBookmarks#

Favoritos e pastas do cofre do workspace: título, tipo, pasta, status, admissão. Filtro opcional por palavra, status ou tipo.

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

Tipo: Leitura. Scopes: read.

ParâmetroTipoObrigatórioDescrição
querystringNãoOptional filter on title, note or tags.
statusinbox | reading | doneNão
kinditem | source | signal | graph | search | document | board | chatNão
curl -s https://piqline.com/api/v1/tools/listBookmarks \
  -H "Authorization: Bearer $PIQLINE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

listEntities#

Entidades acompanhadas (empresas, marcas, contas públicas) e itens vinculados no período.

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

Tipo: Leitura. Scopes: read.

ParâmetroTipoObrigatórioDescrição
period7d | 30d | 90dNão
curl -s https://piqline.com/api/v1/tools/listEntities \
  -H "Authorization: Bearer $PIQLINE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

listWatchContracts#

Contratos de monitoramento definidos nas fontes: intenção, termos mantidos e excluídos, evento.

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

Tipo: Leitura. Scopes: read.

Esta ferramenta não recebe parâmetros: envie um corpo vazio, {}.

curl -s https://piqline.com/api/v1/tools/listWatchContracts \
  -H "Authorization: Bearer $PIQLINE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

checkInvestigation#

Status da última investigação Edge, ou de uma específica: pendente, em execução, concluída com seus candidatos, ou falha.

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

Tipo: Leitura. Scopes: read.

ParâmetroTipoObrigatórioDescrição
missionIdstringNãoOmit to read the latest investigator mission of this workspace
curl -s https://piqline.com/api/v1/tools/checkInvestigation \
  -H "Authorization: Bearer $PIQLINE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

checkHunt#

Status da última busca, ou de uma específica: etapa, pessoas encontradas com o veredito do código e o seu, e para cada critério seu status e sua prova pública datada (URL, data, trecho). Nunca dados de contato.

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

Tipo: Leitura. Scopes: read.

ParâmetroTipoObrigatórioDescrição
missionIdstringNãoOmit to read the latest hunt of this workspace.
curl -s https://piqline.com/api/v1/tools/checkHunt \
  -H "Authorization: Bearer $PIQLINE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

planSourcePack#

Propõe um conjunto coerente de fontes a acompanhar para um objetivo. Não cria nada.

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

Tipo: Leitura. Scopes: read.

ParâmetroTipoObrigatórioDescrição
namestringSim
rationalestringSimWhy this pack answers the goal
candidatesarray<object>Sim
curl -s https://piqline.com/api/v1/tools/planSourcePack \
  -H "Authorization: Bearer $PIQLINE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"texte","rationale":"texte","candidates":[{"platform":"instagram","target":"texte","label":"texte","why":"texte","confidence":"high"}]}'

listWidgets#

Widgets que podem entrar em um board deste workspace, classificados para a pessoa, com seus motivos.

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

Tipo: Leitura. Scopes: read.

ParâmetroTipoObrigatórioDescrição
period7d | 30d | 90dNãoWindow used by isProposable. Default 7d.
curl -s https://piqline.com/api/v1/tools/listWidgets \
  -H "Authorization: Bearer $PIQLINE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

getAdvertiserCampaigns#

Dossiê de anúncios de um anunciante a partir das coletas do workspace: anúncios, ativos, datas, bibliotecas, países, necessidades lidas, novos anúncios por mês e aumentos de ritmo, últimos anúncios, sinais. Nunca uma pessoa. Sem créditos.

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

Tipo: Leitura. Scopes: read.

ParâmetroTipoObrigatórioDescrição
advertiserstringSimName (or part of it) of the advertiser.
curl -s https://piqline.com/api/v1/tools/getAdvertiserCampaigns \
  -H "Authorization: Bearer $PIQLINE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"advertiser":"texte"}'

listAdSignals#

Sinais de anúncios do workspace, calculados a cada hora: campanha iniciada ou encerrada, aumento de ritmo, novo país, nova plataforma, contratação paga, promoção, lançamento, novo anunciante. Sem créditos.

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

Tipo: Leitura. Scopes: read.

ParâmetroTipoObrigatórioDescrição
kindad_campaign_started | ad_campaign_stopped | ad_ramp_up | ad_new_country | ad_new_platform | ad_hiring | ad_promotion | ad_launch | …Nãoad_hiring for paid recruitment campaigns, ad_campaign_started for new campaigns, etc.
activeOnlybooleanNão
limitintegerNão
curl -s https://piqline.com/api/v1/tools/listAdSignals \
  -H "Authorization: Bearer $PIQLINE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

listCollectedAds#

Coletas de anúncios do workspace (Meta, TikTok, Google, LinkedIn), já lidas: a lista ou, com o nome de uma coleta, suas divisões (ângulos, ofertas, tons, formatos), seu ritmo, seus anúncios mais duradouros e seus anúncios filtrados por biblioteca, status, ângulo ou palavra. Sem créditos.

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

Tipo: Leitura. Scopes: read.

ParâmetroTipoObrigatórioDescrição
collectionstringNãoName of a collection (exact, start or fragment).
librarymeta | tiktok | google | linkedinNão
statuslive | newNãolive: active or shown within 14 days. new: first seen at the last pass.
anglepromotion | lancement | marque | preuve_sociale | education | recrutement | evenement | lead | …Não
querystringNãoWord to find in the advertiser, title, text, button or transcript.
limitintegerNão
curl -s https://piqline.com/api/v1/tools/listCollectedAds \
  -H "Authorization: Bearer $PIQLINE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

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