本文へスキップ

ツールリファレンス

アクション

ソースとルールを操作する。12 個のツールを、パラメーターと呼び出し例とともに掲載しています。

Piqline エージェントのアクションツールです。チャットでは、いずれも確認を求めます。API では、act スコープでの直接呼び出しが確認とみなされます。これらのツールは、当事者の同意を得てから呼び出してください。

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

subscribeSource#

新しいソースを購読します。実際の収集(読み取りジョブ、プラットフォームのクォータ)が始まります。

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

種類: アクション。スコープ: act。

パラメーター型必須説明
platforminstagram | tiktok | youtube | twitter | x | threads | linkedin | reddit | …はい
targetstringいいえHandle, URL, mot-clé Marketplace, ou communauté. Une recherche LinkedIn peut s’appuyer sur query.
titlestringいいえ
facebookKindpage | group | marketplaceいいえFacebook : page publique, groupe public, ou recherche Marketplace.
tiktokKindprofile | liveいいえTikTok only. live = /v1/tiktok/user/live probe, not profile posts.
linkedinKindcompany | searchいいえLinkedIn only. search = recurring public-post search on query.
locationstringいいえMarketplace : ville ou zone.
latnumberいいえ
lngnumberいいえ
radiusKmnumberいいえ
minPricenumberいいえ
maxPricenumberいいえ
sortBystringいいえ
conditionstringいいえ
dateListedstringいいえ
categoryIdstringいいえ
deliverystringいいえ
availabilitystringいいえ
datePostedlast-hour | last-day | last-week | last-month | last-yearいいえLinkedIn search only. Window of each run, default last-week.
querystringいいえMarketplace keyword or LinkedIn search query.
intentstringいいえLinkedIn search: the user's ask, kept on the source.
detectionEventhiring | funding | launch | expansion | reorg | open_to_work | leaving | interested_comment | …いいえ
detectionRoundsarray<pre_seed | seed | series_a | series_b | series_c | series_d | bridge | extension | …>いいえ
detectionSectorsarray<string>いいえ
detectionGeosarray<string>いいえ
detectionVocabularyarray<string>いいえ
moreQueriesarray<string>いいえLinkedIn search only. Up to 3 other phrases followed together with query, one per job family, each probed by probeLinkedinWatch with at least one relevant post.
maxPostsintegerいいえLinkedIn search only. Posts read at most per run: 15, 50, 100 or 200 (default 50). Each post read uses credits; a run reads only posts newer than the last one stored.
detectionAuthorsarray<recruiter | founder | manager>いいえLinkedIn search only. Keep only posts whose author's title reads as one of these roles (recruiter, founder, manager). Empty = every author.
rhythmhourly | every_6h | daily | weeklyいいえLinkedIn search only. Run rhythm chosen by the user (hourly, every_6h, daily, weekly). Omit to keep the rhythm suggested by the probe.
investigationobjectいいえLot 7: pass the investigation object from probeLinkedinWatch unchanged.
trackItemVariationsbooleanいいえMarketplace / listing only. True only if the user explicitly asked to follow price, text or presence on the same item (T8). Default false: new items only.
enrichFromUrlbooleanいいえListing / web only. Open each item URL to read the page text. Default false. Each opened page uses credits. Set true only if the user explicitly asked.
curl -s https://piqline.com/api/v1/tools/subscribeSource \
  -H "Authorization: Bearer $PIQLINE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"platform":"instagram"}'

subscribeSources#

複数のソースを 1 回の呼び出しで購読し、ソースごとに 1 つの結果を返します。

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

種類: アクション。スコープ: act。

パラメーター型必須説明
sourcesarray<object>はい
curl -s https://piqline.com/api/v1/tools/subscribeSources \
  -H "Authorization: Bearer $PIQLINE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"sources":[{"platform":"instagram"}]}'

unsubscribeSource#

ソースの追跡を止めます。すでに収集したアイテムはコーパスに残ります。

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

種類: アクション。スコープ: act。

パラメーター型必須説明
sourceIdstringはい
labelstringいいえNom lisible de la source (celui de listSources). Obligatoire pour la carte de confirmation.
curl -s https://piqline.com/api/v1/tools/unsubscribeSource \
  -H "Authorization: Bearer $PIQLINE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"sourceId":"5a0e9c1f-2b7d-4e63-8f14-d3c8a6b92e70"}'

setHomeDashboard#

保存済みのボードを、ワークスペースのホームに設定します。

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

種類: アクション。スコープ: act。

パラメーター型必須説明
dashboardIdstringはい
titlestringいいえTitre du tableau, pour la carte de confirmation. Jamais l’identifiant seul.
curl -s https://piqline.com/api/v1/tools/setHomeDashboard \
  -H "Authorization: Bearer $PIQLINE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"dashboardId":"5a0e9c1f-2b7d-4e63-8f14-d3c8a6b92e70"}'

upsertSignalRule#

継続シグナルのルールを作成または更新します。アイテムがしきい値より長くオンラインに残ると発火します。

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

種類: アクション。スコープ: act。

パラメーター型必須説明
ruleIdstringいいえ
thresholdDaysintegerいいえ
staleGraceDaysintegerいいえ
itemTypesarray<post | video | article | listing | job_offer>いいえ
enabledbooleanいいえ
curl -s https://piqline.com/api/v1/tools/upsertSignalRule \
  -H "Authorization: Bearer $PIQLINE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

upsertQuestionRule#

定期質問を作成または更新します。ワークスペースのソースに届く新しいアイテムごとに、Jev に投げかける平易な文です。確率のしきい値がシグナルを決めます。

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

種類: アクション。スコープ: act。

パラメーター型必須説明
ruleIdstringいいえ
questionstringはい
minProbabilitynumberいいえ
itemTypesarray<post | video | article | listing | job_offer>いいえ
enabledbooleanいいえ
curl -s https://piqline.com/api/v1/tools/upsertQuestionRule \
  -H "Authorization: Bearer $PIQLINE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"question":"texte"}'

startInvestigation#

このワークスペースのバックグラウンド Edge 調査をキューに入れます(オーナーまたは管理者)。

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

種類: アクション。スコープ: act。

パラメーター型必須説明
intentstringはいNeed in one sentence, from sujets / zones / langues already noted
perimeterobjectいいえOptional sectors, geos, accounts, seed URLs from the need profile
curl -s https://piqline.com/api/v1/tools/startInvestigation \
  -H "Authorization: Bearer $PIQLINE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"intent":"texte"}'

startHunt#

ハントを開始します。検証可能な条件を満たす人物を探し、各条件を日付付きの公開ソースで裏付けます。機微な条件は拒否され、連絡先は返しません。バックグラウンドで実行され、当月のクレジットを使います。オーナーまたは管理者。

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

種類: アクション。スコープ: act。

パラメーター型必須説明
briefstringはいWho to find, in one or two sentences.
purposestringはいWhy these people are sought, in one sentence. Recorded with the hunt.
criteriaarray<object>はい
targetintegerいいえHow many people to find.
curl -s https://piqline.com/api/v1/tools/startHunt \
  -H "Authorization: Bearer $PIQLINE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"brief":"texte","purpose":"texte","criteria":[{"label":"texte"}]}'

buildAdAudit#

すでに収集した 1〜6 社の広告主のキャンペーンを、N か月分さかのぼって監査します。ワークスペースのテーブル(広告主、月、新規広告、停止、ライブラリ、国、読み取ったニーズ、ランプアップ)と、出典付き要約の数値を返します。クレジットは使いません。

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

種類: 書き込み。スコープ: write。

パラメーター型必須説明
advertisersarray<string>はいNames of the advertisers, as in the collections.
monthsintegerいいえ
namestringいいえTable name. Default: « Audit publicitaire ».
curl -s https://piqline.com/api/v1/tools/buildAdAudit \
  -H "Authorization: Bearer $PIQLINE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"advertisers":["texte"]}'

findCreatorSponsors#

あるニッチで YouTube クリエイターに報酬を支払っているのは誰か。最近の動画を検索し、各動画からスポンサーを推定して、ワークスペースのテーブル「Sponsors · niche」を作成します。クレジットを使います。チャットでは確認が必要で、オーナーまたは管理者。

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

種類: アクション。スコープ: act, write, explore。

パラメーター型必須説明
nichestringはいWords of the niche, as a creator would title a video (« compléments alimentaires »).
videosintegerいいえ
periodthis_week | this_month | this_yearいいえ
countrystringいいえYouTube region, FR by default.
followbooleanいいえtrue: follow the niche, run again every week, and raise A13 when a brand starts sponsoring creators of the niche (in the bell and alert e-mails).
curl -s https://piqline.com/api/v1/tools/findCreatorSponsors \
  -H "Authorization: Bearer $PIQLINE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"niche":"texte"}'

importAdHistory#

広告主コレクションの Google 履歴をインポートします。最大 20 ページ(2021 年以降の約 800 件の広告)で、過去のキャンペーンの日付を特定します。クレジットを使います。チャットでは確認が必要で、オーナーまたは管理者。

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

種類: アクション。スコープ: act, write, explore。

パラメーター型必須説明
collectionstringはいName of the advertiser collection.
curl -s https://piqline.com/api/v1/tools/importAdHistory \
  -H "Authorization: Bearer $PIQLINE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"collection":"texte"}'

startAdCollection#

広告主(名前またはドメイン)またはキーワードの広告収集を開始します。Meta、TikTok、Google、LinkedIn を読み取り、すべての広告を同じ形式にそろえ、切り口、オファー、オーディエンス、トーンを読み取ります。クレジットを使います。チャットでは確認が必要で、オーナーまたは管理者。

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

種類: アクション。スコープ: act, write, explore。

パラメーター型必須説明
querystringはいNom ou domaine de l'annonceur (kind advertiser), ou mot-clé (kind keyword).
kindadvertiser | keywordいいえ
librariesarray<meta | tiktok | google | linkedin>いいえBibliothèques à lire. Google ne cherche pas par mot-clé.
countrystringいいえCode pays ISO. Restreint Meta et LinkedIn, choisit l'entité annonceur de Google (FR par défaut). Courants : FR, BE, CH, LU, DE, ES, IT, NL, GB, IE, US, CA, MA, SN, CI, AU, BR, JP.
depthapercu | largeいいえapercu : une page par bibliothèque. large : jusqu'à quatre pages (plus long).
cadencemanuel | quotidien | hebdomadaireいいえmanuel : à la main. quotidien ou hebdomadaire : la collecte se repasse seule, dans le plafond du jour, et ses signaux arrivent dans la cloche.
curl -s https://piqline.com/api/v1/tools/startAdCollection \
  -H "Authorization: Bearer $PIQLINE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"query":"levée de fonds"}'

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