本文へスキップ

ツールリファレンス

コーパス

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

Piqline エージェントのツールです。ワークスペースがすでに収集した内容を読み取ります。クレジットは使わず、何も書き込みません。

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

getCoverageStats#

収集量とその状態。合計、プラットフォーム別と種類別の内訳、分析期間(1h、24h、7d、30d)の取り込み推移。

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

種類: 読み取り。スコープ: read。

パラメーター型必須説明
period1h | 24h | 7d | 30dいいえAnalysis window
curl -s https://piqline.com/api/v1/tools/getCoverageStats \
  -H "Authorization: Bearer $PIQLINE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

listSources#

ワークスペースが追跡しているソース。アイテム数、状態、最終読み取りを含みます。

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

種類: 読み取り。スコープ: read。

このツールにパラメーターはありません。空の本文 {} を送信してください。

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

searchItems#

アイテム(投稿、動画、記事、広告、求人)を、テキスト、プラットフォーム、種類、ソースで絞り込んで検索します。絞り込みがない場合は、最新のアイテムを返します(最大 40 件)。

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

種類: 読み取り。スコープ: read。

パラメーター型必須説明
querystringいいえFree-text match on title and body
platformstringいいえ
itemTypepost | video | article | listing | job_offerいいえ
sourceIdstringいいえ
limitintegerいいえ
curl -s https://piqline.com/api/v1/tools/searchItems \
  -H "Authorization: Bearer $PIQLINE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

getItem#

アイテムの詳細。テキスト、文字起こし、OCR、検出されたトピック、意味の近いアイテム、観測日。

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

種類: 読み取り。スコープ: read。

パラメーター型必須説明
itemIdstringはい
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#

長い文書(Motor が読み取った PDF)を意味で検索します。質問に最も近い箇所を、アイテム、ページ、セクション見出しとともに返します。

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

種類: 読み取り。スコープ: read。

パラメーター型必須説明
querystringはいQuestion or phrase to look for
itemIdstringいいえLimit to one document
limitintegerいいえ
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#

ある箇所がアイテム内に一字一句そのまま存在することを確認し、引用番号を返します。存在しない場合は、最も近い箇所を返します。チャットの引用モードの基盤です。

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

種類: 読み取り。スコープ: read。

パラメーター型必須説明
itemIdstringはいItem id from searchItems or getItem
quotestringはいExact 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#

回答を SVG の図(タイムライン、マトリクス、フロー、ツリーなど)として描画します。色はテーマのロールに従い、SVG は表示前にサニタイズされます。チャットの図モードの基盤です。

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

種類: 読み取り。スコープ: read。

パラメーター型必須説明
typearchitecture | flowchart | sequence | state | timeline | swimlane | quadrant | tree | …はいVisual type chosen for the layout
titlestringはいShort name of the subject, in the user's language
descriptionstringはいOne sentence on what the diagram shows, for screen readers and the caption
svgstringはいA 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#

キャンバス(piqline/canvas SDK だけをインポートする TSX ファイル)をコンパイルし、表示可能なコード、または修正すべきエラーを返します。チャットのキャンバスモードとレポートモードの基盤です。

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

種類: 読み取り。スコープ: read。

パラメーター型必須説明
titlestringはいShort title shown above the canvas, in French
sourcestringはいFull .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#

検出されたトピックと発言シェア、およびストーリー(複数のソースで見られる同じ話題)。

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

種類: 読み取り。スコープ: read。

パラメーター型必須説明
period1h | 24h | 7d | 30dいいえAnalysis window
curl -s https://piqline.com/api/v1/tools/getTopics \
  -H "Authorization: Bearer $PIQLINE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

getSignals#

ワークスペースの継続ルールによって発火した、未解決のシグナル。リードタイムとステータス付き。

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

種類: 読み取り。スコープ: read。

このツールにパラメーターはありません。空の本文 {} を送信してください。

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

listWorkspaceTables#

ワークスペースに作成済みのテーブル。名前、コメント、列数と行数、テーブルが自動で埋まるかどうか。

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

種類: 読み取り。スコープ: read。

このツールにパラメーターはありません。空の本文 {} を送信してください。

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

getWorkspaceTable#

ワークスペースのテーブルを JSON で返します。スキーマ、列、行を含みます。サイト、アプリ、エージェントの土台やフィードとして使えます(read スコープ)。

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

種類: 読み取り。スコープ: read。

パラメーター型必須説明
schemastringいいえSchema, default public.
namestringはいTable 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#

ワークスペースのヴォールトにあるブックマークとフォルダー。タイトル、種類、フォルダー、ステータス、受け入れ状況。単語、ステータス、種類での絞り込みも可能です。

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

種類: 読み取り。スコープ: read。

パラメーター型必須説明
querystringいいえOptional filter on title, note or tags.
statusinbox | reading | doneいいえ
kinditem | source | signal | graph | search | document | board | chatいいえ
curl -s https://piqline.com/api/v1/tools/listBookmarks \
  -H "Authorization: Bearer $PIQLINE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

listEntities#

追跡中のエンティティ(企業、ブランド、公開アカウント)と、期間内に関連付けられたアイテム。

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

種類: 読み取り。スコープ: read。

パラメーター型必須説明
period7d | 30d | 90dいいえ
curl -s https://piqline.com/api/v1/tools/listEntities \
  -H "Authorization: Bearer $PIQLINE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

listWatchContracts#

ソースに設定されたウォッチ契約。意図、残す語と除外する語、イベント。

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

種類: 読み取り。スコープ: read。

このツールにパラメーターはありません。空の本文 {} を送信してください。

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

checkInvestigation#

最新の Edge 調査、または指定した調査のステータス。保留中、実行中、候補付きの完了、失敗のいずれか。

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

種類: 読み取り。スコープ: read。

パラメーター型必須説明
missionIdstringいいえOmit 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#

最新のハント、または指定したハントのステータス。段階、見つかった人物(コードの判定とあなたの判定)、各条件のステータスと日付付きの公開証拠(URL、日付、抜粋)。連絡先は返しません。

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

種類: 読み取り。スコープ: read。

パラメーター型必須説明
missionIdstringいいえOmit 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#

目的に合わせて、追跡するソースのまとまりを提案します。何も作成しません。

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

種類: 読み取り。スコープ: read。

パラメーター型必須説明
namestringはい
rationalestringはいWhy this pack answers the goal
candidatesarray<object>はい
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#

このワークスペースのボードに置けるウィジェット。利用者に合わせて順位付けし、理由を添えます。

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

種類: 読み取り。スコープ: read。

パラメーター型必須説明
period7d | 30d | 90dいいえWindow 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#

ワークスペースの収集結果から得た広告主の広告ファイル。広告、配信中の広告、日付、ライブラリ、国、読み取ったニーズ、月ごとの新規広告とランプアップ、最新の広告、シグナル。人物は対象外です。クレジットは使いません。

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

種類: 読み取り。スコープ: read。

パラメーター型必須説明
advertiserstringはいName (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#

ワークスペースの広告シグナル(1 時間ごとに計算)。キャンペーンの開始と停止、ランプアップ、新しい国、新しいプラットフォーム、有料の求人、プロモーション、ローンチ、新しい広告主。クレジットは使いません。

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

種類: 読み取り。スコープ: read。

パラメーター型必須説明
kindad_campaign_started | ad_campaign_stopped | ad_ramp_up | ad_new_country | ad_new_platform | ad_hiring | ad_promotion | ad_launch | …いいえad_hiring for paid recruitment campaigns, ad_campaign_started for new campaigns, etc.
activeOnlybooleanいいえ
limitintegerいいえ
curl -s https://piqline.com/api/v1/tools/listAdSignals \
  -H "Authorization: Bearer $PIQLINE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

listCollectedAds#

ワークスペースで収集済みの広告コレクション(Meta、TikTok、Google、LinkedIn)。一覧を返します。コレクション名を指定すると、その内訳(切り口、オファー、トーン、フォーマット)、ペース、最も長く配信されている広告、ライブラリ、ステータス、切り口、単語で絞り込んだ広告を返します。クレジットは使いません。

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

種類: 読み取り。スコープ: read。

パラメーター型必須説明
collectionstringいいえName of a collection (exact, start or fragment).
librarymeta | tiktok | google | linkedinいいえ
statuslive | newいいえlive: active or shown within 14 days. new: first seen at the last pass.
anglepromotion | lancement | marque | preuve_sociale | education | recrutement | evenement | lead | …いいえ
querystringいいえWord to find in the advertiser, title, text, button or transcript.
limitintegerいいえ
curl -s https://piqline.com/api/v1/tools/listCollectedAds \
  -H "Authorization: Bearer $PIQLINE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

API についてのご質問や、このページの誤りはありませんか。 お問い合わせ.