도구 레퍼런스
실행
소스와 규칙에 대한 실행. 도구 12개와 매개변수, 호출 예제.
Piqline 에이전트의 실행 도구입니다. 채팅에서는 각 도구가 확인을 요청합니다. API에서는 act 스코프로 직접 호출하는 것이 확인으로 간주됩니다. 해당하는 사람이 동의한 후에만 이 도구를 호출하십시오.
각 호출은 Authorization: Bearer에 키를 넣은 POST 요청입니다. 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#
한 번의 호출로 여러 소스를 구독하고 소스별 결과를 반환합니다.
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"]