Saltar al contenido

Referencia de herramientas

Escritura

Escribir en el workspace. 12 herramientas, con sus parámetros y ejemplos de llamada.

Herramientas del agente Piqline que crean o modifican objetos del workspace. Requieren el scope write.

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.

updateWorkspaceProfile#

Guarda el perfil de necesidades del workspace: objetivos, temas, entidades, idiomas, regiones, nivel, ritmo.

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

Tipo: Escritura. Scopes: write.

ParámetroTipoObligatorioDescripción
needsobjectNo
stagestringNo
onboarding_statusnot_started | in_progress | done | skippedNo
summarystringNo
curl -s https://piqline.com/api/v1/tools/updateWorkspaceProfile \
  -H "Authorization: Bearer $PIQLINE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

followEntity#

Sigue una empresa, una marca o una cuenta pública (nunca una persona privada) para vincular sus elementos y menciones.

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

Tipo: Escritura. Scopes: write.

ParámetroTipoObligatorioDescripción
namestringSí
kindcompany | brand | accountNo
sirenstringNo
domainstringNo
handlesarray<object>No
roleself | competitor | client | target | otherNo
aliasesarray<string>No
curl -s https://piqline.com/api/v1/tools/followEntity \
  -H "Authorization: Bearer $PIQLINE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"texte"}'

unfollowEntity#

Deja de seguir una entidad. Sus vínculos existentes permanecen.

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

Tipo: Eliminación. Scopes: write.

ParámetroTipoObligatorioDescripción
entityIdstringSí
curl -s https://piqline.com/api/v1/tools/unfollowEntity \
  -H "Authorization: Bearer $PIQLINE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"entityId":"5a0e9c1f-2b7d-4e63-8f14-d3c8a6b92e70"}'

saveBookmark#

Guarda un marcador en la bóveda del workspace. Una URL http(s) se pone en cola para lectura, archivado y vectorización.

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

Tipo: Escritura. Scopes: write.

ParámetroTipoObligatorioDescripción
titlestringSí
hrefstringSí
kinditem | source | signal | graph | search | document | board | chatNo
subtitlestringNo
notestringNo
tagsarray<string>No
origindashboard | api | slack | whatsapp | mail | otherNo
originRefstringNo
curl -s https://piqline.com/api/v1/tools/saveBookmark \
  -H "Authorization: Bearer $PIQLINE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"title":"texte","href":"texte"}'

setWatchContract#

Define un contrato de vigilancia sobre una fuente: la página de vigilancia solo muestra entonces los elementos que coinciden. Determinista, sin modelo.

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

Tipo: Escritura. Scopes: write.

ParámetroTipoObligatorioDescripción
sourceIdstringSí
intentstringSíWhat this workspace watches on the source, in the person's words.
includearray<string>NoKeep an item only if it contains at least one of these terms (whole word, any case or accent).
excludearray<string>NoDrop an item containing any of these terms.
eventhiring | funding | launch | expansion | reorg | open_to_work | leaving | interested_comment | …NoBusiness event the item must announce (hiring, funding, launch…), read from its text.
sectorsarray<string>No
curl -s https://piqline.com/api/v1/tools/setWatchContract \
  -H "Authorization: Bearer $PIQLINE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"sourceId":"5a0e9c1f-2b7d-4e63-8f14-d3c8a6b92e70","intent":"texte"}'

removeWatchContract#

Elimina el contrato de vigilancia de una fuente: se vuelven a mostrar todos los elementos.

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

Tipo: Eliminación. Scopes: write.

ParámetroTipoObligatorioDescripción
sourceIdstringSí
curl -s https://piqline.com/api/v1/tools/removeWatchContract \
  -H "Authorization: Bearer $PIQLINE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"sourceId":"5a0e9c1f-2b7d-4e63-8f14-d3c8a6b92e70"}'

initReaderInterview#

Guarda las dos respuestas de la entrevista de lectura (lo esencial o el detalle, intención principal) en el perfil de lectura.

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

Tipo: Escritura. Scopes: write.

ParámetroTipoObligatorioDescripción
densityessentiel | detailSí
intentread-arrivals | spot-change | watch-entities | compare | measure-coverage | control-sources | analyze-market | prepare-output | …Sí
curl -s https://piqline.com/api/v1/tools/initReaderInterview \
  -H "Authorization: Bearer $PIQLINE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"density":"essentiel","intent":"read-arrivals"}'

applyBoardChange#

Aplica a un tablero cambios que ya fueron aprobados.

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

Tipo: Escritura. Scopes: write.

ParámetroTipoObligatorioDescripción
dashboardIdstringNo
changesarray<object>Sí
curl -s https://piqline.com/api/v1/tools/applyBoardChange \
  -H "Authorization: Bearer $PIQLINE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"changes":[{"id":"5a0e9c1f-2b7d-4e63-8f14-d3c8a6b92e70","kind":"add","widgetId":"5a0e9c1f-2b7d-4e63-8f14-d3c8a6b92e70","reason":"texte","title":"texte"}]}'

buildDashboard#

Construye un tablero directamente, sin pasar por el selector de widgets.

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

Tipo: Escritura. Scopes: write.

ParámetroTipoObligatorioDescripción
specobjectSí
savebooleanNoPersist the board when the user is owner/admin.
curl -s https://piqline.com/api/v1/tools/buildDashboard \
  -H "Authorization: Bearer $PIQLINE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"spec":{"version":1,"title":"texte","description":"texte","period":"1h","widgets":[{"kind":"texte","title":"texte"}]}}'

saveWorkspaceTable#

Crea una tabla del workspace, rellenada con las columnas útiles.

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

Tipo: Escritura. Scopes: write.

ParámetroTipoObligatorioDescripción
namestringSí
commentstringSí
columnsarray<object>Sí
rowsarray<object>Sí
curl -s https://piqline.com/api/v1/tools/saveWorkspaceTable \
  -H "Authorization: Bearer $PIQLINE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"texte","comment":"texte","columns":[{"id":"5a0e9c1f-2b7d-4e63-8f14-d3c8a6b92e70","name":"texte","type":"text"}],"rows":[{}]}'

writeFromWatch#

Redacta un texto a partir de los elementos de las vigilancias del workspace (artículo, publicación de LinkedIn, hilo de X, pie de foto de Instagram, boletín, guion de vídeo, nota de prensa, artículo SEO, correo, resumen), en nueve idiomas, con cada dato citado [n] a su fuente; el texto se une a los borradores. Consume unos pocos créditos.

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

Tipo: Escritura. Scopes: write.

ParámetroTipoObligatorioDescripción
instructionstringSíWhat to write and for whom, in plain words, e.g. « Le post de la semaine sur ce qui a bougé dans la cosmétique ».
examplestringNoOptional sample text whose style to follow.
scopeobjectNoWhich items of the workspace watches to write from: sources, topics, keywords, platforms, item types or item ids, period and depth. Default: the last 7 days, 15 items.
penobjectNoFormat (article, linkedin, x_thread, instagram, newsletter, video_script, press_release, seo_brief, email, summary), goal, tone, framework, length, voice, language (fr, en, es, de, it, pt, nl, he, ar), creativity, variants and options.
savebooleanNoKeep the text in the workspace drafts (default). false: return it only.
curl -s https://piqline.com/api/v1/tools/writeFromWatch \
  -H "Authorization: Bearer $PIQLINE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"instruction":"texte"}'

setTableFeed#

Da vida a una tabla: en cuanto un elemento del corpus cumple la regla, se añade, previa confirmación. status=paused detiene el rellenado.

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

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

ParámetroTipoObligatorioDescripción
schemastringNo
namestringSí
statuslive | pausedNo
promptstringSíThe person's words, unchanged.
summarystringSíWhat you understood, in plain French, one sentence.
sourceIdsarray<string>No
sourceLabelsarray<string>No
querystringNo
platformstringNo
itemTypepost | video | article | listing | job_offerNo
alreadyMatchingintegerNoHow many items searchItems found just now.
curl -s https://piqline.com/api/v1/tools/setTableFeed \
  -H "Authorization: Bearer $PIQLINE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"texte","prompt":"texte","summary":"texte"}'

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