Saltar al contenido

Referencia de herramientas

Corpus

Leer el corpus y el workspace. 22 herramientas, con sus parámetros y ejemplos de llamada.

Herramientas del agente Piqline. Leen lo que el workspace ya ha recogido: no consumen créditos y no escriben nada.

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.

getCoverageStats#

Volúmenes y estado de la recogida: totales, desglose por plataforma y por tipo, series de ingesta en la ventana de análisis (1h, 24h, 7d o 30d).

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

Tipo: Lectura. Scopes: read.

ParámetroTipoObligatorioDescripción
period1h | 24h | 7d | 30dNoAnalysis window
curl -s https://piqline.com/api/v1/tools/getCoverageStats \
  -H "Authorization: Bearer $PIQLINE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

listSources#

Fuentes que sigue el workspace, con número de elementos, estado y última lectura.

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

Tipo: Lectura. Scopes: read.

Esta herramienta no tiene parámetros: envía un cuerpo vacío, {}.

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

searchItems#

Busca elementos (publicaciones, vídeos, artículos, anuncios, ofertas) con filtros: texto, plataforma, tipo, fuente. Sin filtro, devuelve los más recientes (40 como máximo).

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

Tipo: Lectura. Scopes: read.

ParámetroTipoObligatorioDescripción
querystringNoFree-text match on title and body
platformstringNo
itemTypepost | video | article | listing | job_offerNo
sourceIdstringNo
limitintegerNo
curl -s https://piqline.com/api/v1/tools/searchItems \
  -H "Authorization: Bearer $PIQLINE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

getItem#

Detalle de un elemento: texto, transcripción, OCR, temas detectados, elementos de sentido cercano y sus fechas de observación.

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

Tipo: Lectura. Scopes: read.

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

Búsqueda por sentido en documentos largos (PDF leídos por el Motor): los pasajes más cercanos a una pregunta, con el elemento, la página y el título de la sección.

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

Tipo: Lectura. Scopes: read.

ParámetroTipoObligatorioDescripción
querystringSíQuestion or phrase to look for
itemIdstringNoLimit to one document
limitintegerNo
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#

Comprueba que un pasaje aparece palabra por palabra en un elemento y devuelve un número de cita; si no, el pasaje más cercano. Base del modo Citas del chat.

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

Tipo: Lectura. Scopes: read.

ParámetroTipoObligatorioDescripción
itemIdstringSíItem id from searchItems or getItem
quotestringSí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#

Dibuja la respuesta como un diagrama SVG (línea de tiempo, matriz, flujo, árbol…): colores por rol del tema, SVG saneado antes de mostrarse. Base del modo Diagrama del chat.

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

Tipo: Lectura. Scopes: read.

ParámetroTipoObligatorioDescripción
typearchitecture | flowchart | sequence | state | timeline | swimlane | quadrant | tree | …SíVisual type chosen for the layout
titlestringSíShort name of the subject, in the user's language
descriptionstringSíOne sentence on what the diagram shows, for screen readers and the caption
svgstringSí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#

Compila un canvas (un archivo TSX que solo importa el SDK piqline/canvas) y devuelve código listo para mostrar, o el error que hay que corregir. Base de los modos Canvas e Informe del chat.

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

Tipo: Lectura. Scopes: read.

ParámetroTipoObligatorioDescripción
titlestringSíShort title shown above the canvas, in French
sourcestringSí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#

Temas detectados con su cuota de voz, e historias (el mismo asunto visto en varias fuentes).

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

Tipo: Lectura. Scopes: read.

ParámetroTipoObligatorioDescripción
period1h | 24h | 7d | 30dNoAnalysis window
curl -s https://piqline.com/api/v1/tools/getTopics \
  -H "Authorization: Bearer $PIQLINE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

getSignals#

Señales abiertas, activadas por las reglas de persistencia del workspace, con su antelación y su estado.

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

Tipo: Lectura. Scopes: read.

Esta herramienta no tiene parámetros: envía un cuerpo vacío, {}.

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

listWorkspaceTables#

Tablas ya creadas en el workspace: nombre, comentario, número de columnas y filas, y si la tabla se rellena sola.

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

Tipo: Lectura. Scopes: read.

Esta herramienta no tiene parámetros: envía un cuerpo vacío, {}.

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

getWorkspaceTable#

Una tabla del workspace en JSON: esquema, columnas y filas. Sirve de base o de fuente para un sitio, una aplicación o un agente (scope read).

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

Tipo: Lectura. Scopes: read.

ParámetroTipoObligatorioDescripción
schemastringNoSchema, default public.
namestringSí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#

Marcadores y carpetas de la bóveda del workspace: título, tipo, carpeta, estado, admisión. Filtro opcional por palabra, estado o tipo.

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

Tipo: Lectura. Scopes: read.

ParámetroTipoObligatorioDescripción
querystringNoOptional filter on title, note or tags.
statusinbox | reading | doneNo
kinditem | source | signal | graph | search | document | board | chatNo
curl -s https://piqline.com/api/v1/tools/listBookmarks \
  -H "Authorization: Bearer $PIQLINE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

listEntities#

Entidades seguidas (empresas, marcas, cuentas públicas) y elementos vinculados en el período.

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

Tipo: Lectura. Scopes: read.

ParámetroTipoObligatorioDescripción
period7d | 30d | 90dNo
curl -s https://piqline.com/api/v1/tools/listEntities \
  -H "Authorization: Bearer $PIQLINE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

listWatchContracts#

Contratos de vigilancia definidos sobre las fuentes: intención, términos conservados y excluidos, evento.

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

Tipo: Lectura. Scopes: read.

Esta herramienta no tiene parámetros: envía un cuerpo vacío, {}.

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

checkInvestigation#

Estado de la última investigación de Edge, o de una concreta: pendiente, en curso, terminada con sus candidatos, o fallida.

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

Tipo: Lectura. Scopes: read.

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

Estado de la última búsqueda, o de una concreta: etapa, personas encontradas con el veredicto del código y el tuyo, y, para cada criterio, su estado y su prueba pública fechada (URL, fecha, extracto). Nunca datos de contacto.

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

Tipo: Lectura. Scopes: read.

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

Propone un conjunto coherente de fuentes que seguir para un objetivo. No crea nada.

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

Tipo: Lectura. Scopes: read.

ParámetroTipoObligatorioDescripción
namestringSí
rationalestringSíWhy this pack answers the goal
candidatesarray<object>Sí
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#

Widgets que pueden ir en un tablero de este workspace, ordenados para la persona, con sus motivos.

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

Tipo: Lectura. Scopes: read.

ParámetroTipoObligatorioDescripción
period7d | 30d | 90dNoWindow 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#

Ficha publicitaria de un anunciante a partir de las colecciones del workspace: anuncios, los activos, fechas, bibliotecas, países, necesidades leídas, anuncios nuevos por mes y aumentos de ritmo, últimos anuncios, señales. Nunca una persona. Sin créditos.

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

Tipo: Lectura. Scopes: read.

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

Señales publicitarias del workspace, calculadas cada hora: campaña iniciada o detenida, aumento de ritmo, nuevo país, nueva plataforma, contratación pagada, promoción, lanzamiento, nuevo anunciante. Sin créditos.

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

Tipo: Lectura. Scopes: read.

ParámetroTipoObligatorioDescripción
kindad_campaign_started | ad_campaign_stopped | ad_ramp_up | ad_new_country | ad_new_platform | ad_hiring | ad_promotion | ad_launch | …Noad_hiring for paid recruitment campaigns, ad_campaign_started for new campaigns, etc.
activeOnlybooleanNo
limitintegerNo
curl -s https://piqline.com/api/v1/tools/listAdSignals \
  -H "Authorization: Bearer $PIQLINE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

listCollectedAds#

Colecciones de anuncios del workspace (Meta, TikTok, Google, LinkedIn), ya leídas: la lista o, con el nombre de una colección, sus desgloses (ángulos, ofertas, tonos, formatos), su ritmo, sus anuncios más longevos y sus anuncios filtrados por biblioteca, estado, ángulo o palabra. Sin créditos.

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

Tipo: Lectura. Scopes: read.

ParámetroTipoObligatorioDescripción
collectionstringNoName of a collection (exact, start or fragment).
librarymeta | tiktok | google | linkedinNo
statuslive | newNolive: active or shown within 14 days. new: first seen at the last pass.
anglepromotion | lancement | marque | preuve_sociale | education | recrutement | evenement | lead | …No
querystringNoWord to find in the advertiser, title, text, button or transcript.
limitintegerNo
curl -s https://piqline.com/api/v1/tools/listCollectedAds \
  -H "Authorization: Bearer $PIQLINE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

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