Skip to main content
Tester en direct — Essayez ces endpoints dans la documentation interactive Scalar.

​
Vue d’ensemble

Bob est l’assistant IA de Finkare. Via l’API Agent, vous pouvez interagir avec Bob en langage naturel pour :
  • Consulter l’état des dossiers de recouvrement
  • Analyser les situations et obtenir des recommandations
  • Déclencher des actions (pause, accélération, modification de cascade)
  • Obtenir des statistiques et des synthèses
Bob dispose d’outils internes (list_invoices, get_company_dashboard, etc.) et respecte les contraintes anti-harcèlement à chaque action.
Les endpoints Agent sont en v2 (/api/v2/agent/).

​
Chat avec Bob

Envoie un message à Bob et reçoit sa réponse. Scope requis : agent:chat
​
message
string
required
Message en langage naturel. Exemple : Combien de factures impayées ai-je en ce moment ?
​
conversationId
string
ID de conversation pour continuer un échange existant (UUID)
​
context
object
Contexte additionnel (page courante, locale, etc.)
curl -X POST https://api.finkare.io/api/v2/agent/chat \
  -H "X-API-Key: fk_live_xxx" \
  -H "Content-Type: application/json" \
  -d '{
    "message": "Quelles sont les factures impayées de Dupont & Fils ?",
    "context": { "locale": "fr" }
  }'

{
  "success": true,
  "data": {
    "text": "Dupont & Fils SARL a 2 factures impayées pour un total de 2 350,00 € :\n\n1. **FAC-2026-001** — 1 500,00 € (échue depuis le 31/03/2026, en recouvrement)\n2. **FAC-2026-015** — 850,00 € (échue depuis le 28/02/2026, relance SMS envoyée)\n\nSouhaitez-vous que je mette en pause l'une de ces factures ou que j'accélère la relance ?",
    "toolsCalled": ["list_invoices", "get_debtor_details"],
    "conversationId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  "requestId": "req_bob_01",
  "timestamp": "2026-04-08T10:05:00Z"
}
​
data.text
string
Réponse de Bob en langage naturel (formatée en Markdown)
​
data.toolsCalled
array
Outils internes utilisés par Bob pour générer la réponse
​
data.conversationId
string
ID de conversation à réutiliser pour poursuivre l’échange

​
Exemples de messages

MessageCe que fait Bob
Combien de factures impayées ai-je ?Consulte le dashboard et retourne les statistiques
Mets en pause le recouvrement de FAC-2026-001Déclenche une pause sur le workflow
Quel est le score de solvabilité de Dupont ?Consulte le scoring IA
Envoie un SMS de rappel à Moreau IndustriesPlanifie un SMS (si les contraintes anti-harcèlement le permettent)
Résumé de la semaineSynthèse des actions, paiements et événements

​
Lister les conversations

Scope requis : agent:chat
​
limit
number
default:"20"
Nombre de résultats (max 100)
​
offset
number
default:"0"
Offset pour pagination
curl -H "X-API-Key: fk_live_xxx" \
  "https://api.finkare.io/api/v2/agent/conversations?limit=10"

{
  "success": true,
  "data": [
    {
      "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "lastMessage": "Dupont & Fils SARL a 2 factures impayées...",
      "messageCount": 4,
      "createdAt": "2026-04-08T10:00:00Z",
      "updatedAt": "2026-04-08T10:05:00Z"
    }
  ],
  "pagination": {
    "limit": 10,
    "offset": 0,
    "total": 1
  }
}

​
Détails d’une conversation

Scope requis : agent:chat
​
id
string
required
ID de la conversation (UUID)
curl -H "X-API-Key: fk_live_xxx" \
  https://api.finkare.io/api/v2/agent/conversations/a1b2c3d4-e5f6-7890-abcd-ef1234567890

​
Codes d’erreur possibles

CodeHTTPDescription
VAL_001400Message manquant ou conversationId invalide
AUTH_004403Scope agent:chat requis
SVC_001503Service IA temporairement indisponible
RATE_001429Rate limit dépassé