Ir para o conteúdo

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âmetroTipoObrigatórioDescrição
needsobjectNão
stagestringNão
onboarding_statusnot_started | in_progress | done | skippedNão
summarystringNão
curl -s https://piqline.com/api/v1/tools/updateWorkspaceProfile \
  -H "Authorization: Bearer $PIQLINE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

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âmetroTipoObrigatórioDescrição
namestringSim
kindcompany | brand | accountNão
sirenstringNão
domainstringNão
handlesarray<object>Não
roleself | competitor | client | target | otherNão
aliasesarray<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"}'

unfollowEntity#

Para de acompanhar uma entidade. Os vínculos existentes permanecem.

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

Tipo: Exclusão. Scopes: write.

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

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âmetroTipoObrigatórioDescrição
titlestringSim
hrefstringSim
kinditem | source | signal | graph | search | document | board | chatNão
subtitlestringNão
notestringNão
tagsarray<string>Não
origindashboard | api | slack | whatsapp | mail | otherNão
originRefstringNã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"}'

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âmetroTipoObrigatórioDescrição
sourceIdstringSim
intentstringSimWhat this workspace watches on the source, in the person's words.
includearray<string>NãoKeep an item only if it contains at least one of these terms (whole word, any case or accent).
excludearray<string>NãoDrop an item containing any of these terms.
eventhiring | funding | launch | expansion | reorg | open_to_work | leaving | interested_comment | …NãoBusiness event the item must announce (hiring, funding, launch…), read from its text.
sectorsarray<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"}'

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

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

applyBoardChange#

Aplica a um board alterações que já foram aprovadas.

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

Tipo: Escrita. Scopes: write.

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

buildDashboard#

Monta um board diretamente, sem passar pelo seletor de widgets.

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

Tipo: Escrita. Scopes: write.

ParâmetroTipoObrigatórioDescrição
specobjectSim
savebooleanNãoPersist 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"}]}}'

saveWorkspaceTable#

Cria uma tabela do workspace, preenchida com as colunas úteis.

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

Tipo: Escrita. Scopes: write.

ParâmetroTipoObrigatórioDescrição
namestringSim
commentstringSim
columnsarray<object>Sim
rowsarray<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":[{}]}'

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âmetroTipoObrigatórioDescrição
instructionstringSimWhat to write and for whom, in plain words, e.g. « Le post de la semaine sur ce qui a bougé dans la cosmétique ».
examplestringNãoOptional sample text whose style to follow.
scopeobjectNãoWhich 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.
penobjectNãoFormat (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.
savebooleanNãoKeep 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"}'

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âmetroTipoObrigatórioDescrição
schemastringNão
namestringSim
statuslive | pausedNão
promptstringSimThe person's words, unchanged.
summarystringSimWhat you understood, in plain French, one sentence.
sourceIdsarray<string>Não
sourceLabelsarray<string>Não
querystringNão
platformstringNão
itemTypepost | video | article | listing | job_offerNão
alreadyMatchingintegerNãoHow 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"}'

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