Aller au contenu

Guides

Agents

Faire répondre un agent Piqline : un tour, un état, une conversation.

Un agent est l’assistant du dashboard, appelé par HTTP : il lit votre demande, choisit ses outils, les exécute et répond en citant ses sources. Il utilise le même moteur que le chat. Il ne dispose que des outils que votre clé pourrait appeler elle-même.

Les agents#

AgentRôle
piqlinePipeline du workspace : corpus, veille, boards, tables et bookmarks.
facebookMarketplace et groupes publics, en direct via Scrape Creators.
linkedinRecrutement, veille et opportunités à partir des posts publics.
upworkOffres Upwork lues, notées et rédigées depuis votre base de connaissances.
onboardingConfiguration guidée du workspace : besoin, sources, tableau d’accueil, alertes. Réservé aux owners et admins.

La clé doit porter le scope agents. GEThttps://piqline.com/api/v1/agents liste les agents et, pour chacun, les outils que votre clé peut appeler.

Lancer un tour#

HTTP
POST https://piqline.com/api/v1/agents/{agent}
Content-Type: application/json
ChampTypeRôle
inputtexte, 20 000 caractères au plusVotre message.
messagestableauLa conversation précédente, telle que l’appel précédent l’a renvoyée.
modeltexteIdentifiant d’un modèle proposé par l’assistant. Un identifiant inconnu est remplacé par le modèle par défaut.
reasoninglow, medium ou highEffort de raisonnement, pour les modèles qui le permettent.
streambooléentrue : réponse en flux (voir plus bas).

Il faut au moins input ou messages.

curl -s https://piqline.com/api/v1/agents/piqline \
  -H "Authorization: Bearer $PIQLINE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"input":"Quelles sources sont en erreur, et depuis quand ?"}'

La réponse :

ChampSens
agentl’agent interrogé
statuscompleted, requires_input ou requires_approval (voir plus bas)
textla réponse de l’agent
tool_callsles outils appelés pendant le tour : tool, state, input et output ou error
pendingce qui attend votre réponse : kind (input ou approval), tool, input et, pour une approbation, approval_id
messagesla conversation complète, à renvoyer au prochain appel
cost_usdle coût des appels de modèle du tour, en dollars américains

Poursuivre une conversation#

Renvoyez le tableau messages de la réponse précédente, et ajoutez votre nouveau message dans input :

Shell
# Premier tour : on garde la réponse.
curl -s https://piqline.com/api/v1/agents/piqline \
  -H "Authorization: Bearer $PIQLINE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"input":"Quelles sources sont en erreur ?"}' > tour1.json

# Deuxième tour : on renvoie la conversation.
jq '{messages: .messages, input: "Et depuis quand ?"}' tour1.json \
  | curl -s https://piqline.com/api/v1/agents/piqline \
      -H "Authorization: Bearer $PIQLINE_API_KEY" \
      -H "Content-Type: application/json" \
      -d @-

Quand l’agent s’arrête#

  • completed. L’agent a répondu. text contient sa réponse.
  • requires_input. L’agent pose une question ou propose une carte, par exemple choisir parmi plusieurs sources. pending la décrit. Répondez en texte dans input, en renvoyant messages.
  • requires_approval. L’agent propose une action, par exemple s’abonner à une source, sans l’exécuter. Pour l’exécuter, appelez vous-même l’outil indiqué dans pending[].tool avec pending[].input, par POSThttps://piqline.com/api/v1/tools/{nom}, avec une clé qui porte le scope act.

Réponse en flux#

Avec "stream": true, la réponse est le flux « UI message stream » de l’AI SDK, en Server-Sent Events : celui du chat du dashboard. Un client useChat de l’AI SDK le lit tel quel. Avec curl, ajoutez -N pour le voir arriver.

Coûts et délais#

Un tour consomme des crédits modèle (cost_usd) et, selon les outils appelés, des crédits fournisseurs. Un tour dure de quelques secondes à plusieurs dizaines de secondes. Prévoyez un délai d’attente de 5 minutes côté client.

Chaque clé peut lancer 10 tours par minute par défaut : voir Limites.

Une question sur l’API, ou une erreur dans cette page ? Écrivez-nous.