ツールリファレンス
アクション
ソースとルールを操作する。12 個のツールを、パラメーターと呼び出し例とともに掲載しています。
Piqline エージェントのアクションツールです。チャットでは、いずれも確認を求めます。API では、act スコープでの直接呼び出しが確認とみなされます。これらのツールは、当事者の同意を得てから呼び出してください。
各呼び出しは POST リクエストで、キーは Authorization: Bearer に入れます。JSON の本文がツールの入力で、レスポンスは { "tool": "nom", "output": … } の形式です。例には必須パラメーターだけを入れています。パラメーターの説明は、エージェントが読むものと同じです。
subscribeSource#
新しいソースを購読します。実際の収集(読み取りジョブ、プラットフォームのクォータ)が始まります。
POSThttps://piqline.com/api/v1/tools/subscribeSource
種類: アクション。スコープ: act。
| パラメーター | 型 | 必須 | 説明 |
|---|---|---|---|
platform | instagram | tiktok | youtube | twitter | x | threads | linkedin | reddit | … | はい | |
target | string | いいえ | Handle, URL, mot-clé Marketplace, ou communauté. Une recherche LinkedIn peut s’appuyer sur query. |
title | string | いいえ | |
facebookKind | page | group | marketplace | いいえ | Facebook : page publique, groupe public, ou recherche Marketplace. |
tiktokKind | profile | live | いいえ | TikTok only. live = /v1/tiktok/user/live probe, not profile posts. |
linkedinKind | company | search | いいえ | LinkedIn only. search = recurring public-post search on query. |
location | string | いいえ | Marketplace : ville ou zone. |
lat | number | いいえ | |
lng | number | いいえ | |
radiusKm | number | いいえ | |
minPrice | number | いいえ | |
maxPrice | number | いいえ | |
sortBy | string | いいえ | |
condition | string | いいえ | |
dateListed | string | いいえ | |
categoryId | string | いいえ | |
delivery | string | いいえ | |
availability | string | いいえ | |
datePosted | last-hour | last-day | last-week | last-month | last-year | いいえ | LinkedIn search only. Window of each run, default last-week. |
query | string | いいえ | Marketplace keyword or LinkedIn search query. |
intent | string | いいえ | LinkedIn search: the user's ask, kept on the source. |
detectionEvent | hiring | funding | launch | expansion | reorg | open_to_work | leaving | interested_comment | … | いいえ | |
detectionRounds | array<pre_seed | seed | series_a | series_b | series_c | series_d | bridge | extension | …> | いいえ | |
detectionSectors | array<string> | いいえ | |
detectionGeos | array<string> | いいえ | |
detectionVocabulary | array<string> | いいえ | |
moreQueries | array<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. |
maxPosts | integer | いいえ | 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. |
detectionAuthors | array<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. |
rhythm | hourly | 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. |
investigation | object | いいえ | Lot 7: pass the investigation object from probeLinkedinWatch unchanged. |
trackItemVariations | boolean | いいえ | 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. |
enrichFromUrl | boolean | いいえ | 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"}'const response = await fetch("https://piqline.com/api/v1/tools/subscribeSource", {
method: "POST",
headers: {
Authorization: "Bearer " + process.env.PIQLINE_API_KEY,
"Content-Type": "application/json",
},
body: JSON.stringify({
"platform": "instagram"
}),
});
const { output } = await response.json();import os
import requests
response = requests.post(
"https://piqline.com/api/v1/tools/subscribeSource",
headers={"Authorization": "Bearer " + os.environ["PIQLINE_API_KEY"]},
json={
"platform": "instagram",
},
)
output = response.json()["output"]subscribeSources#
複数のソースを 1 回の呼び出しで購読し、ソースごとに 1 つの結果を返します。
POSThttps://piqline.com/api/v1/tools/subscribeSources
種類: アクション。スコープ: act。
| パラメーター | 型 | 必須 | 説明 |
|---|---|---|---|
sources | array<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"}]}'const response = await fetch("https://piqline.com/api/v1/tools/subscribeSources", {
method: "POST",
headers: {
Authorization: "Bearer " + process.env.PIQLINE_API_KEY,
"Content-Type": "application/json",
},
body: JSON.stringify({
"sources": [
{
"platform": "instagram"
}
]
}),
});
const { output } = await response.json();import os
import requests
response = requests.post(
"https://piqline.com/api/v1/tools/subscribeSources",
headers={"Authorization": "Bearer " + os.environ["PIQLINE_API_KEY"]},
json={
"sources": [
{
"platform": "instagram",
},
],
},
)
output = response.json()["output"]unsubscribeSource#
ソースの追跡を止めます。すでに収集したアイテムはコーパスに残ります。
POSThttps://piqline.com/api/v1/tools/unsubscribeSource
種類: アクション。スコープ: act。
| パラメーター | 型 | 必須 | 説明 |
|---|---|---|---|
sourceId | string | はい | |
label | string | いいえ | 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"}'const response = await fetch("https://piqline.com/api/v1/tools/unsubscribeSource", {
method: "POST",
headers: {
Authorization: "Bearer " + process.env.PIQLINE_API_KEY,
"Content-Type": "application/json",
},
body: JSON.stringify({
"sourceId": "5a0e9c1f-2b7d-4e63-8f14-d3c8a6b92e70"
}),
});
const { output } = await response.json();import os
import requests
response = requests.post(
"https://piqline.com/api/v1/tools/unsubscribeSource",
headers={"Authorization": "Bearer " + os.environ["PIQLINE_API_KEY"]},
json={
"sourceId": "5a0e9c1f-2b7d-4e63-8f14-d3c8a6b92e70",
},
)
output = response.json()["output"]setHomeDashboard#
保存済みのボードを、ワークスペースのホームに設定します。
POSThttps://piqline.com/api/v1/tools/setHomeDashboard
種類: アクション。スコープ: act。
| パラメーター | 型 | 必須 | 説明 |
|---|---|---|---|
dashboardId | string | はい | |
title | string | いいえ | 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"}'const response = await fetch("https://piqline.com/api/v1/tools/setHomeDashboard", {
method: "POST",
headers: {
Authorization: "Bearer " + process.env.PIQLINE_API_KEY,
"Content-Type": "application/json",
},
body: JSON.stringify({
"dashboardId": "5a0e9c1f-2b7d-4e63-8f14-d3c8a6b92e70"
}),
});
const { output } = await response.json();import os
import requests
response = requests.post(
"https://piqline.com/api/v1/tools/setHomeDashboard",
headers={"Authorization": "Bearer " + os.environ["PIQLINE_API_KEY"]},
json={
"dashboardId": "5a0e9c1f-2b7d-4e63-8f14-d3c8a6b92e70",
},
)
output = response.json()["output"]upsertSignalRule#
継続シグナルのルールを作成または更新します。アイテムがしきい値より長くオンラインに残ると発火します。
POSThttps://piqline.com/api/v1/tools/upsertSignalRule
種類: アクション。スコープ: act。
| パラメーター | 型 | 必須 | 説明 |
|---|---|---|---|
ruleId | string | いいえ | |
thresholdDays | integer | いいえ | |
staleGraceDays | integer | いいえ | |
itemTypes | array<post | video | article | listing | job_offer> | いいえ | |
enabled | boolean | いいえ |
curl -s https://piqline.com/api/v1/tools/upsertSignalRule \
-H "Authorization: Bearer $PIQLINE_API_KEY" \
-H "Content-Type: application/json" \
-d '{}'const response = await fetch("https://piqline.com/api/v1/tools/upsertSignalRule", {
method: "POST",
headers: {
Authorization: "Bearer " + process.env.PIQLINE_API_KEY,
"Content-Type": "application/json",
},
body: JSON.stringify({}),
});
const { output } = await response.json();import os
import requests
response = requests.post(
"https://piqline.com/api/v1/tools/upsertSignalRule",
headers={"Authorization": "Bearer " + os.environ["PIQLINE_API_KEY"]},
json={},
)
output = response.json()["output"]upsertQuestionRule#
定期質問を作成または更新します。ワークスペースのソースに届く新しいアイテムごとに、Jev に投げかける平易な文です。確率のしきい値がシグナルを決めます。
POSThttps://piqline.com/api/v1/tools/upsertQuestionRule
種類: アクション。スコープ: act。
| パラメーター | 型 | 必須 | 説明 |
|---|---|---|---|
ruleId | string | いいえ | |
question | string | はい | |
minProbability | number | いいえ | |
itemTypes | array<post | video | article | listing | job_offer> | いいえ | |
enabled | boolean | いいえ |
curl -s https://piqline.com/api/v1/tools/upsertQuestionRule \
-H "Authorization: Bearer $PIQLINE_API_KEY" \
-H "Content-Type: application/json" \
-d '{"question":"texte"}'const response = await fetch("https://piqline.com/api/v1/tools/upsertQuestionRule", {
method: "POST",
headers: {
Authorization: "Bearer " + process.env.PIQLINE_API_KEY,
"Content-Type": "application/json",
},
body: JSON.stringify({
"question": "texte"
}),
});
const { output } = await response.json();import os
import requests
response = requests.post(
"https://piqline.com/api/v1/tools/upsertQuestionRule",
headers={"Authorization": "Bearer " + os.environ["PIQLINE_API_KEY"]},
json={
"question": "texte",
},
)
output = response.json()["output"]startInvestigation#
このワークスペースのバックグラウンド Edge 調査をキューに入れます(オーナーまたは管理者)。
POSThttps://piqline.com/api/v1/tools/startInvestigation
種類: アクション。スコープ: act。
| パラメーター | 型 | 必須 | 説明 |
|---|---|---|---|
intent | string | はい | Need in one sentence, from sujets / zones / langues already noted |
perimeter | object | いいえ | 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"}'const response = await fetch("https://piqline.com/api/v1/tools/startInvestigation", {
method: "POST",
headers: {
Authorization: "Bearer " + process.env.PIQLINE_API_KEY,
"Content-Type": "application/json",
},
body: JSON.stringify({
"intent": "texte"
}),
});
const { output } = await response.json();import os
import requests
response = requests.post(
"https://piqline.com/api/v1/tools/startInvestigation",
headers={"Authorization": "Bearer " + os.environ["PIQLINE_API_KEY"]},
json={
"intent": "texte",
},
)
output = response.json()["output"]startHunt#
ハントを開始します。検証可能な条件を満たす人物を探し、各条件を日付付きの公開ソースで裏付けます。機微な条件は拒否され、連絡先は返しません。バックグラウンドで実行され、当月のクレジットを使います。オーナーまたは管理者。
POSThttps://piqline.com/api/v1/tools/startHunt
種類: アクション。スコープ: act。
| パラメーター | 型 | 必須 | 説明 |
|---|---|---|---|
brief | string | はい | Who to find, in one or two sentences. |
purpose | string | はい | Why these people are sought, in one sentence. Recorded with the hunt. |
criteria | array<object> | はい | |
target | integer | いいえ | 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"}]}'const response = await fetch("https://piqline.com/api/v1/tools/startHunt", {
method: "POST",
headers: {
Authorization: "Bearer " + process.env.PIQLINE_API_KEY,
"Content-Type": "application/json",
},
body: JSON.stringify({
"brief": "texte",
"purpose": "texte",
"criteria": [
{
"label": "texte"
}
]
}),
});
const { output } = await response.json();import os
import requests
response = requests.post(
"https://piqline.com/api/v1/tools/startHunt",
headers={"Authorization": "Bearer " + os.environ["PIQLINE_API_KEY"]},
json={
"brief": "texte",
"purpose": "texte",
"criteria": [
{
"label": "texte",
},
],
},
)
output = response.json()["output"]buildAdAudit#
すでに収集した 1〜6 社の広告主のキャンペーンを、N か月分さかのぼって監査します。ワークスペースのテーブル(広告主、月、新規広告、停止、ライブラリ、国、読み取ったニーズ、ランプアップ)と、出典付き要約の数値を返します。クレジットは使いません。
POSThttps://piqline.com/api/v1/tools/buildAdAudit
種類: 書き込み。スコープ: write。
| パラメーター | 型 | 必須 | 説明 |
|---|---|---|---|
advertisers | array<string> | はい | Names of the advertisers, as in the collections. |
months | integer | いいえ | |
name | string | いいえ | 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"]}'const response = await fetch("https://piqline.com/api/v1/tools/buildAdAudit", {
method: "POST",
headers: {
Authorization: "Bearer " + process.env.PIQLINE_API_KEY,
"Content-Type": "application/json",
},
body: JSON.stringify({
"advertisers": [
"texte"
]
}),
});
const { output } = await response.json();import os
import requests
response = requests.post(
"https://piqline.com/api/v1/tools/buildAdAudit",
headers={"Authorization": "Bearer " + os.environ["PIQLINE_API_KEY"]},
json={
"advertisers": [
"texte",
],
},
)
output = response.json()["output"]findCreatorSponsors#
あるニッチで YouTube クリエイターに報酬を支払っているのは誰か。最近の動画を検索し、各動画からスポンサーを推定して、ワークスペースのテーブル「Sponsors · niche」を作成します。クレジットを使います。チャットでは確認が必要で、オーナーまたは管理者。
POSThttps://piqline.com/api/v1/tools/findCreatorSponsors
種類: アクション。スコープ: act, write, explore。
| パラメーター | 型 | 必須 | 説明 |
|---|---|---|---|
niche | string | はい | Words of the niche, as a creator would title a video (« compléments alimentaires »). |
videos | integer | いいえ | |
period | this_week | this_month | this_year | いいえ | |
country | string | いいえ | YouTube region, FR by default. |
follow | boolean | いいえ | 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"}'const response = await fetch("https://piqline.com/api/v1/tools/findCreatorSponsors", {
method: "POST",
headers: {
Authorization: "Bearer " + process.env.PIQLINE_API_KEY,
"Content-Type": "application/json",
},
body: JSON.stringify({
"niche": "texte"
}),
});
const { output } = await response.json();import os
import requests
response = requests.post(
"https://piqline.com/api/v1/tools/findCreatorSponsors",
headers={"Authorization": "Bearer " + os.environ["PIQLINE_API_KEY"]},
json={
"niche": "texte",
},
)
output = response.json()["output"]importAdHistory#
広告主コレクションの Google 履歴をインポートします。最大 20 ページ(2021 年以降の約 800 件の広告)で、過去のキャンペーンの日付を特定します。クレジットを使います。チャットでは確認が必要で、オーナーまたは管理者。
POSThttps://piqline.com/api/v1/tools/importAdHistory
種類: アクション。スコープ: act, write, explore。
| パラメーター | 型 | 必須 | 説明 |
|---|---|---|---|
collection | string | はい | 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"}'const response = await fetch("https://piqline.com/api/v1/tools/importAdHistory", {
method: "POST",
headers: {
Authorization: "Bearer " + process.env.PIQLINE_API_KEY,
"Content-Type": "application/json",
},
body: JSON.stringify({
"collection": "texte"
}),
});
const { output } = await response.json();import os
import requests
response = requests.post(
"https://piqline.com/api/v1/tools/importAdHistory",
headers={"Authorization": "Bearer " + os.environ["PIQLINE_API_KEY"]},
json={
"collection": "texte",
},
)
output = response.json()["output"]startAdCollection#
広告主(名前またはドメイン)またはキーワードの広告収集を開始します。Meta、TikTok、Google、LinkedIn を読み取り、すべての広告を同じ形式にそろえ、切り口、オファー、オーディエンス、トーンを読み取ります。クレジットを使います。チャットでは確認が必要で、オーナーまたは管理者。
POSThttps://piqline.com/api/v1/tools/startAdCollection
種類: アクション。スコープ: act, write, explore。
| パラメーター | 型 | 必須 | 説明 |
|---|---|---|---|
query | string | はい | Nom ou domaine de l'annonceur (kind advertiser), ou mot-clé (kind keyword). |
kind | advertiser | keyword | いいえ | |
libraries | array<meta | tiktok | google | linkedin> | いいえ | Bibliothèques à lire. Google ne cherche pas par mot-clé. |
country | string | いいえ | 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. |
depth | apercu | large | いいえ | apercu : une page par bibliothèque. large : jusqu'à quatre pages (plus long). |
cadence | manuel | 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"}'const response = await fetch("https://piqline.com/api/v1/tools/startAdCollection", {
method: "POST",
headers: {
Authorization: "Bearer " + process.env.PIQLINE_API_KEY,
"Content-Type": "application/json",
},
body: JSON.stringify({
"query": "levée de fonds"
}),
});
const { output } = await response.json();import os
import requests
response = requests.post(
"https://piqline.com/api/v1/tools/startAdCollection",
headers={"Authorization": "Bearer " + os.environ["PIQLINE_API_KEY"]},
json={
"query": "levée de fonds",
},
)
output = response.json()["output"]