本文へスキップ

ツールリファレンス

書き込み

ワークスペースに書き込む。12 個のツールを、パラメーターと呼び出し例とともに掲載しています。

ワークスペースのオブジェクトを作成または変更する、Piqline エージェントのツールです。write スコープが必要です。

各呼び出しは POST リクエストで、キーは Authorization: Bearer に入れます。JSON の本文がツールの入力で、レスポンスは { "tool": "nom", "output": … } の形式です。例には必須パラメーターだけを入れています。パラメーターの説明は、エージェントが読むものと同じです。

updateWorkspaceProfile#

ワークスペースのニーズプロファイルを保存します。目的、テーマ、エンティティ、言語、地域、レベル、ペース。

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

種類: 書き込み。スコープ: 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

種類: 書き込み。スコープ: 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

種類: 削除。スコープ: 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

種類: 書き込み。スコープ: 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

種類: 書き込み。スコープ: 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

種類: 削除。スコープ: 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#

読み方のインタビューの 2 つの回答(要点か詳細か、主な意図)を、閲覧プロファイルに保存します。

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

種類: 書き込み。スコープ: 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

種類: 書き込み。スコープ: 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

種類: 書き込み。スコープ: 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

種類: 書き込み。スコープ: 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 記事、メール、要約)。9 言語に対応し、すべての事実に出典を [n] で付けます。文章は下書きに追加されます。少量のクレジットを使います。

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

種類: 書き込み。スコープ: 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

種類: アクション。スコープ: 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 についてのご質問や、このページの誤りはありませんか。 お問い合わせ.