跳到正文

工具参考

写入

写入工作区。12 个工具,附参数和调用示例。

Piqline 智能体中创建或修改工作区对象的工具。它们需要 write scope。

每次调用都是一个 POST 请求,密钥放在 Authorization: Bearer 中。JSON 请求体是工具的输入,响应形如 { "tool": "nom", "output": … }。示例中只包含必填参数。参数说明与智能体读到的相同。

updateWorkspaceProfile#

保存工作区的需求档案:目标、主题、实体、语言、地区、级别、节奏。

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

类型:写入。Scope:write。

参数类型必填说明
needsobject否
stagestring否
onboarding_statusnot_started | in_progress | done | skipped否
summarystring否
curl -s https://piqline.com/api/v1/tools/updateWorkspaceProfile \
  -H "Authorization: Bearer $PIQLINE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

followEntity#

关注一家公司、一个品牌或一个公开账号(绝不关注私人个体),以关联其条目和提及。

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

类型:写入。Scope:write。

参数类型必填说明
namestring是
kindcompany | brand | account否
sirenstring否
domainstring否
handlesarray<object>否
roleself | competitor | client | target | other否
aliasesarray<string>否
curl -s https://piqline.com/api/v1/tools/followEntity \
  -H "Authorization: Bearer $PIQLINE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"texte"}'

unfollowEntity#

停止关注某个实体。已有的关联保留。

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

类型:删除。Scope:write。

参数类型必填说明
entityIdstring是
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#

把书签保存到工作区收藏库。http(s) URL 会进入队列,等待读取、归档和向量化。

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

类型:写入。Scope:write。

参数类型必填说明
titlestring是
hrefstring是
kinditem | source | signal | graph | search | document | board | chat否
subtitlestring否
notestring否
tagsarray<string>否
origindashboard | api | slack | whatsapp | mail | other否
originRefstring否
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#

为来源设置监控合约:监控页面随后只显示匹配的条目。确定性规则,不使用模型。

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

类型:写入。Scope:write。

参数类型必填说明
sourceIdstring是
intentstring是What this workspace watches on the source, in the person's words.
includearray<string>否Keep an item only if it contains at least one of these terms (whole word, any case or accent).
excludearray<string>否Drop an item containing any of these terms.
eventhiring | funding | launch | expansion | reorg | open_to_work | leaving | interested_comment | …否Business event the item must announce (hiring, funding, launch…), read from its text.
sectorsarray<string>否
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#

移除来源的监控合约:所有条目重新显示。

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

类型:删除。Scope:write。

参数类型必填说明
sourceIdstring是
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#

把阅读访谈的两个答案(只看要点还是看细节、主要意图)保存到阅读档案中。

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

类型:写入。Scope:write。

参数类型必填说明
densityessentiel | detail是
intentread-arrivals | spot-change | watch-entities | compare | measure-coverage | control-sources | analyze-market | prepare-output | …是
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#

把已经批准的更改应用到看板。

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

类型:写入。Scope:write。

参数类型必填说明
dashboardIdstring否
changesarray<object>是
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#

直接构建看板,不经过组件选择器。

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

类型:写入。Scope:write。

参数类型必填说明
specobject是
saveboolean否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"}]}}'

saveWorkspaceTable#

创建一个工作区表格,并填入有用的列。

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

类型:写入。Scope:write。

参数类型必填说明
namestring是
commentstring是
columnsarray<object>是
rowsarray<object>是
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#

根据工作区监控的条目撰写文本(文章、LinkedIn 帖子、X 串文、Instagram 配文、新闻简报、视频脚本、新闻稿、SEO 文章、电子邮件、摘要),支持九种语言,每个事实都以 [n] 标注来源;文本进入草稿。会消耗少量积分。

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

类型:写入。Scope:write。

参数类型必填说明
instructionstring是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 ».
examplestring否Optional sample text whose style to follow.
scopeobject否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.
penobject否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.
saveboolean否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"}'

setTableFeed#

让表格自动更新:一旦语料库中的条目符合规则,经确认后就会加入表格。status=paused 会停止填充。

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

类型:操作。Scope:act, write。

参数类型必填说明
schemastring否
namestring是
statuslive | paused否
promptstring是The person's words, unchanged.
summarystring是What you understood, in plain French, one sentence.
sourceIdsarray<string>否
sourceLabelsarray<string>否
querystring否
platformstring否
itemTypepost | video | article | listing | job_offer否
alreadyMatchinginteger否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"}'

对 API 有疑问,或发现本页有误? 联系我们.