Comment afficher ce centre d'aide dans mon application ?

Trois routes publiques, sans authentification : GET /v1/help (rubriques et questions avec leur réponse courte), GET /v1/help/articles/{id} (un article) et GET /v1/help/export (tout le centre d'aide, pour un assistant). Le nom du produit y est déjà rempli. L'assistant d'aide, lui, répond sur POST /v1/help/ask, avec une clé ou une session.

Route	Contenu
GET /v1/help	Les rubriques dans l'ordre d'affichage, et pour chacune ses questions avec leur réponse courte.
GET /v1/help/articles/{id}	Un article : question, réponse courte, détail en Markdown, mots-clés.
GET /v1/help/export	Tous les articles complets, pour indexer chacun comme une unité autonome.

Ajoutez ?client=mobile depuis une application mobile : les articles qui n'y ont pas leur place ne sont pas servis, et leur lecture directe répond 404.

Pour un assistant

Chaque article répond à une seule question et se suffit à lui-même : indexez-le en entier, et citez sa réponse courte en tête.

L'assistant d'aide, prêt à l'emploi

Plutôt que d'indexer vous-même : POST /v1/help/ask avec {"question": "…", "history": [{"question": "…", "answer": "…"}]} rend answer (Markdown restreint), found, sources (identifiant, titre, lien), documents et clients. L'assistant porte le nom annoncé par GET /v1/help (assistant.name) — absent, il n'est pas disponible.

Les données de la société : documents et clients

Par défaut, l'assistant peut chercher dans les devis, les factures et les clients de la société pour répondre : le réglage settings.assistant_data est allumé d'office, pour toutes les sociétés. Il ne lit que la société de l'appelant, et jamais plus que lui : sans invoices:read, ni factures ni clients ; sans quotes:read, pas de devis. Il ne modifie rien.

La société peut l'éteindre à tout moment (settings.assistant_data à false). La réponse vient alors du centre d'aide seul, et documents et clients sont des tableaux vides : l'assistant ne voit aucune donnée du compte.

• documents : les devis et factures cités — kind (invoice ou quote), id, number, label, client, date, due_date, total_without_vat, total_with_vat, balance, status, status_label, url. Montants en centimes.
• clients : les clients cités — id, name, kind, city, url.

url est la page de l'élément dans l'application, bâtie par le serveur : utilisez-la telle quelle.

Ce sont les éléments réellement trouvés par les recherches de cette question, jamais ce que le modèle affirme : affichez-les en fiches, chacune étant un lien vers url. Six au plus de chaque.

Pour ce que doit un client, l'assistant cherche dans les documents : un client présent sur des factures sans fiche au carnet est retrouvé quand même. Il ne calcule ni le chiffre d'affaires ni la TVA : il renvoie au tableau de bord.

Cette route exige une clé d'API ou une session (permission profile:read) : chaque question se paie, et le nombre de questions est limité par société et par jour (429 help_quota_exceeded).

Pourquoi public

Ces textes ne contiennent aucune donnée de société : ils aident avant même la connexion.

Mis à jour le 1 octobre 2026.