Saltar al contenido

Referencia de herramientas

Acciones

Actuar sobre fuentes y reglas. 12 herramientas, con sus parámetros y ejemplos de llamada.

Herramientas de acción del agente Piqline. En el chat, cada una pide confirmación. Por la API, una llamada directa con el scope act cuenta como confirmación: llama a estas herramientas solo después de que la persona afectada lo haya aceptado.

Cada llamada es una petición POST con la clave en Authorization: Bearer. El cuerpo JSON es la entrada de la herramienta, y la respuesta tiene la forma { "tool": "nom", "output": … }. Los ejemplos solo incluyen los parámetros obligatorios. Las descripciones de los parámetros son las que leen los agentes.

subscribeSource#

Se suscribe a una fuente nueva. Inicia una recogida real (trabajos de lectura, cuotas de plataforma).

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

Tipo: Acción. Scopes: act.

ParámetroTipoObligatorioDescripción
platforminstagram | tiktok | youtube | twitter | x | threads | linkedin | reddit | …Sí
targetstringNoHandle, URL, mot-clé Marketplace, ou communauté. Une recherche LinkedIn peut s’appuyer sur query.
titlestringNo
facebookKindpage | group | marketplaceNoFacebook : page publique, groupe public, ou recherche Marketplace.
tiktokKindprofile | liveNoTikTok only. live = /v1/tiktok/user/live probe, not profile posts.
linkedinKindcompany | searchNoLinkedIn only. search = recurring public-post search on query.
locationstringNoMarketplace : ville ou zone.
latnumberNo
lngnumberNo
radiusKmnumberNo
minPricenumberNo
maxPricenumberNo
sortBystringNo
conditionstringNo
dateListedstringNo
categoryIdstringNo
deliverystringNo
availabilitystringNo
datePostedlast-hour | last-day | last-week | last-month | last-yearNoLinkedIn search only. Window of each run, default last-week.
querystringNoMarketplace keyword or LinkedIn search query.
intentstringNoLinkedIn search: the user's ask, kept on the source.
detectionEventhiring | funding | launch | expansion | reorg | open_to_work | leaving | interested_comment | …No
detectionRoundsarray<pre_seed | seed | series_a | series_b | series_c | series_d | bridge | extension | …>No
detectionSectorsarray<string>No
detectionGeosarray<string>No
detectionVocabularyarray<string>No
moreQueriesarray<string>NoLinkedIn 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.
maxPostsintegerNoLinkedIn 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>NoLinkedIn 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 | weeklyNoLinkedIn search only. Run rhythm chosen by the user (hourly, every_6h, daily, weekly). Omit to keep the rhythm suggested by the probe.
investigationobjectNoLot 7: pass the investigation object from probeLinkedinWatch unchanged.
trackItemVariationsbooleanNoMarketplace / 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.
enrichFromUrlbooleanNoListing / 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#

Se suscribe a varias fuentes en una sola llamada y devuelve un resultado por fuente.

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

Tipo: Acción. Scopes: act.

ParámetroTipoObligatorioDescripción
sourcesarray<object>Sí
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#

Deja de seguir una fuente. Los elementos ya recogidos permanecen en el corpus.

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

Tipo: Acción. Scopes: act.

ParámetroTipoObligatorioDescripción
sourceIdstringSí
labelstringNoNom 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#

Define un tablero guardado como página de inicio del workspace.

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

Tipo: Acción. Scopes: act.

ParámetroTipoObligatorioDescripción
dashboardIdstringSí
titlestringNoTitre 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#

Crea o actualiza una regla de señal de persistencia: se activa cuando un elemento permanece en línea más tiempo que el umbral.

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

Tipo: Acción. Scopes: act.

ParámetroTipoObligatorioDescripción
ruleIdstringNo
thresholdDaysintegerNo
staleGraceDaysintegerNo
itemTypesarray<post | video | article | listing | job_offer>No
enabledbooleanNo
curl -s https://piqline.com/api/v1/tools/upsertSignalRule \
  -H "Authorization: Bearer $PIQLINE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

upsertQuestionRule#

Crea o actualiza una pregunta permanente: una frase en lenguaje natural que Jev plantea a cada elemento nuevo de las fuentes del workspace. El umbral de probabilidad genera la señal.

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

Tipo: Acción. Scopes: act.

ParámetroTipoObligatorioDescripción
ruleIdstringNo
questionstringSí
minProbabilitynumberNo
itemTypesarray<post | video | article | listing | job_offer>No
enabledbooleanNo
curl -s https://piqline.com/api/v1/tools/upsertQuestionRule \
  -H "Authorization: Bearer $PIQLINE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"question":"texte"}'

startInvestigation#

Pone en cola una investigación de Edge en segundo plano para este workspace (propietario o administrador).

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

Tipo: Acción. Scopes: act.

ParámetroTipoObligatorioDescripción
intentstringSíNeed in one sentence, from sujets / zones / langues already noted
perimeterobjectNoOptional 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#

Inicia una búsqueda: encontrar personas que cumplen criterios verificables, cada criterio probado por una fuente pública fechada. Los criterios sensibles se rechazan y no se devuelve ningún dato de contacto. Se ejecuta en segundo plano y consume los créditos del mes; propietario o administrador.

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

Tipo: Acción. Scopes: act.

ParámetroTipoObligatorioDescripción
briefstringSíWho to find, in one or two sentences.
purposestringSíWhy these people are sought, in one sentence. Recorded with the hunt.
criteriaarray<object>Sí
targetintegerNoHow 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#

Auditoría retroactiva de las campañas de 1 a 6 anunciantes ya recogidos, a lo largo de N meses: una tabla del workspace (anunciante, mes, anuncios nuevos, paradas, bibliotecas, países, necesidades leídas, aumento de ritmo) y las cifras de un resumen citado. Sin créditos.

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

Tipo: Escritura. Scopes: write.

ParámetroTipoObligatorioDescripción
advertisersarray<string>SíNames of the advertisers, as in the collections.
monthsintegerNo
namestringNoTable 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#

Quién paga a los creadores de YouTube en un nicho: búsqueda de vídeos recientes, patrocinadores deducidos de cada vídeo, una tabla del workspace «Patrocinadores · nicho». Consume créditos; confirmación en el chat, propietario o administrador.

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

Tipo: Acción. Scopes: act, write, explore.

ParámetroTipoObligatorioDescripción
nichestringSíWords of the niche, as a creator would title a video (« compléments alimentaires »).
videosintegerNo
periodthis_week | this_month | this_yearNo
countrystringNoYouTube region, FR by default.
followbooleanNotrue: 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#

Importa el historial de Google de una colección de anunciante: hasta 20 páginas (unos 800 anuncios desde 2021) para fechar campañas pasadas. Consume créditos; confirmación en el chat, propietario o administrador.

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

Tipo: Acción. Scopes: act, write, explore.

ParámetroTipoObligatorioDescripción
collectionstringSí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#

Inicia una recogida de anuncios sobre un anunciante (nombre o dominio) o una palabra clave: lee Meta, TikTok, Google y LinkedIn, pone cada anuncio en el mismo formato y luego lee el ángulo, la oferta, la audiencia y el tono. Consume créditos; confirmación en el chat, propietario o administrador.

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

Tipo: Acción. Scopes: act, write, explore.

ParámetroTipoObligatorioDescripción
querystringSíNom ou domaine de l'annonceur (kind advertiser), ou mot-clé (kind keyword).
kindadvertiser | keywordNo
librariesarray<meta | tiktok | google | linkedin>NoBibliothèques à lire. Google ne cherche pas par mot-clé.
countrystringNoCode 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 | largeNoapercu : une page par bibliothèque. large : jusqu'à quatre pages (plus long).
cadencemanuel | quotidien | hebdomadaireNomanuel : à 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"}'

¿Tienes una pregunta sobre la API o has encontrado un error en esta página? Escríbenos.