FR (Français)EN (English)ES (Español)
Nous contacter

API

Points d'entrée

Un point d'entrée par geste de l'espace d'administration : son adresse, ce qu'il exige, et ce qu'il rend. La liste est dérivée du code, elle ne peut pas décrire une version d'hier.

305 points d'entrée · 103 en lecture · 161 en écriture · 41 en suppression

305 sur 305

knowledge

  • /api/v1/search_by_meaningGET · POSTreadLecture. Cherche par le SENS et non par le mot, dans ce que l'agence a écrit : notes, réunions (compte rendu et transcription), décisions, tâches, conversations, skills, contenus de publication et texte des fichiers partagés. À préférer à search_everything pour une idée, une paraphrase ou « ce qu'on a dit sur… » (« le client mécontent du planning » retrouve « il trouve qu'on traîne ») ; search_everything reste meilleur pour un nom, un numéro ou un mot exact. Rend une ligne par source, sous son meilleur passage (excerpt), classée par similarité de 0 à 1 : le résultat est APPROCHÉ, une similarité dit qu'un passage est proche de la question, pas qu'il y répond, et se vérifie en lisant la source. client_id restreint à une fiche, null à ce qui est interne à l'agence. Ce qui vient d'être écrit n'y apparaît qu'après un quart d'heure au plus. Seules les sources que l'appelant peut lire sont rendues.
    Paramètres
    • query string · obligatoire : Ce qu'on cherche, dit avec ses propres mots : une idée, une question, une paraphrase (« le client trouve qu'on est en retard »). De 3 à 500 caractères.
    • client_id string|null : Une fiche client : ne chercher que dans ce qui la concerne. null : seulement dans ce qui est interne à l'agence (sans fiche). Absent : partout.
    • kinds string[] : Ne chercher que dans ces natures (absent ou vide : toutes). file désigne le texte des fichiers partagés qui en portent un (PDF à couche de texte, formats textuels).Valeurs
      notemeetingdecisiontaskconversationskillcontentfile
    • limit integer : Combien de lignes rendre au plus (20 par défaut et au maximum).
    • offset integer : Combien de lignes sauter, pour aller chercher la suite de la liste.
    Rend object[]
    Chaque ligne porte
    • kind string · toujours présentValeurs
      taskcontentconversationnotedecisionmeetingfileskill
    • id string · toujours présent
    • similarity number · toujours présent
    • excerpt string · toujours présent
    • matched_chunks number · toujours présent
    • title string · toujours présent
    • client_id null|string · toujours présent
    • client_name null|string · toujours présent
    Lien vers ce point d'entrée

work-context

  • /api/v1/get_work_contextGET · POSTreadLecture. À appeler en premier avant de travailler sur un client (client_id), ou sur l'agence elle-même (null : ce qui n'est rattaché à aucune fiche). Rend en un appel un digest borné : l'identité de la fiche (contacts, données sur mesure), les décisions en vigueur (celles de la fiche et celles de l'agence, à respecter), les tâches ouvertes par échéance, les rendez-vous des deux semaines à venir, les dernières réunions avec leur résumé, les notes (publiées ou non), les conversations, les devis, les questionnaires, les contenus à publier, les skills qui s'appliquent et les derniers fichiers. Chaque ligne de « items » porte sa section, sa nature, un extrait, sa date, son état et son adresse ; « sections » dit pour chacune combien il y en a en tout et, quand elle est coupée, l'outil qui la liste en entier. Les sections d'un module fermé sont absentes.
    Paramètres
    • client_id string|null · obligatoire : Identifiant de la fiche client, tel que rendu par list_clients. null : le contexte interne de l'agence, c'est-à-dire ce qui n'est rattaché à aucune fiche.
    Rend object
    Champs
    • scope string · toujours présentValeurs
      clientagency
    • generated_at string · toujours présent
    • client null|object · toujours présent
      • id string · toujours présent
      • name string · toujours présent
      • company null|string · toujours présent
      • kind string · toujours présent
      • status string · toujours présent
      • email null|string · toujours présent
      • phone null|string · toujours présent
      • city null|string · toujours présent
      • country null|string · toujours présent
      • locale string · toujours présent
      • memo null|string · toujours présent
      • referrer null|string · toujours présent
      • contacts object[] · toujours présent
        • name null|string · toujours présent
        • email null|string · toujours présent
      • custom object[] · toujours présent
        • key string · toujours présent
        • label string · toujours présent
        • value string · toujours présent
    • sections object[] · toujours présent
      • section string · toujours présentValeurs
        decisionstasksupcomingmeetingsnotesconversationsquotesresponsescontentsskillsfiles
      • kind string · toujours présentValeurs
        taskcontentconversationnotedecisionquotemeetingfileskilleventresponse
      • total number · toujours présent
      • shown number · toujours présent
      • more null|string · toujours présent
    • items object[] · toujours présent
      • kind string · toujours présentValeurs
        taskcontentconversationnotedecisionquotemeetingfileskilleventresponse
      • id string · toujours présent
      • title string · toujours présent
      • excerpt string
      • at string
      • status string
      • link string
    Lien vers ce point d'entrée
  • /api/v1/list_recent_activityGET · POSTreadLecture. Pour savoir ce qui s'est passé depuis la dernière fois : ce qui a été créé ou modifié depuis « since », en un seul fil, le plus récent en tête. Tâches (statut changé, champs touchés, commentaires), notes (publiées ou retouchées), décisions (prises, remplacées, abandonnées), réunions, conversations (nouveaux messages), contenus, devis, questionnaires (complétés), fichiers et skills (nouvelles versions). Une ligne par chose : sa nature, ce qui lui est arrivé (« change ») et le détail quand il se dit, le moment, la fiche et l'auteur quand la base le sait, et son adresse. client_id restreint à une fiche (null : l'interne seul), kinds à certaines natures ; se parcourt par limit et offset sur ses deux cents lignes les plus récentes, au-delà resserrer since.
    Paramètres
    • since string · obligatoire : Depuis quand, instant ISO 8601 (« 2026-10-27T09:00:00Z » ou avec son décalage) : ce qui a été créé ou modifié à cet instant ou après.
    • client_id string|null : Identifiant de la fiche client (list_clients) : son activité seule. null : ce qui n'est rattaché à aucune fiche. Absent : tout.
    • kinds string[] : Ne garde que ces natures. Absent : toutes celles dont le module est ouvert.Valeurs
      tasknotedecisionmeetingconversationcontentquoteresponsefileskill
    • limit integer : Combien de lignes rendre au plus (50 par défaut et au maximum).
    • offset integer : Combien de lignes sauter, pour aller chercher la suite de la liste.
    Rend object[]
    Chaque ligne porte
    • kind string · toujours présentValeurs
      taskcontentconversationnotedecisionquotemeetingfileskillresponse
    • id string · toujours présent
    • title string · toujours présent
    • change string · toujours présentValeurs
      createdstatus_changedcommentedmessagepublishedcompletednew_versionsupersededabandonedupdated
    • detail null|string · toujours présent
    • at string · toujours présent
    • client_id null|string · toujours présent
    • client_name null|string · toujours présent
    • actor null|string · toujours présent
    Lien vers ce point d'entrée

account

  • /api/v1/get_accountGET · POSTreadLecture. Réglages du compte au nom duquel la clé MCP agit : nom affiché, adresse, langue.

    Aucun paramètre.

    Rend object
    Champs
    • full_name null|string · toujours présent
    • avatar_url null|string · toujours présent
    • locale string · toujours présent
    • email null|string · toujours présent
    • provider_avatar_url null|string · toujours présent
    Lien vers ce point d'entrée
  • /api/v1/update_accountPOSTwriteÉcriture. Modifie le nom affiché et la langue du compte au nom duquel la clé MCP agit.
    Paramètres
    • full_name string · obligatoire : Nom affiché du compte, 80 caractères au plus. Vide : le nom est retiré.
    Rend object
    Champs
    • full_name null|string · toujours présent
    • avatar_url null|string · toujours présent
    • locale string · toujours présent
    • email null|string · toujours présent
    • provider_avatar_url null|string · toujours présent
    Lien vers ce point d'entrée
  • /api/v1/upload_account_avatarPOSTwriteÉcriture. Remplace l'avatar du compte. L'image est attendue en data URL complète, ce qui la rend peu commode depuis un assistant.
    Paramètres
    • dataUrl string · obligatoire : La photo en data URL (data:image/jpeg;base64,...) : PNG, JPEG ou WebP, 512 Ko au plus.
    Rend object
    Champs
    • full_name null|string · toujours présent
    • avatar_url null|string · toujours présent
    • locale string · toujours présent
    • email null|string · toujours présent
    • provider_avatar_url null|string · toujours présent
    Lien vers ce point d'entrée
  • /api/v1/remove_account_avatarPOSTwriteÉcriture. Retire l'avatar du compte et rétablit l'initiale.

    Aucun paramètre.

    Rend object
    Champs
    • full_name null|string · toujours présent
    • avatar_url null|string · toujours présent
    • locale string · toujours présent
    • email null|string · toujours présent
    • provider_avatar_url null|string · toujours présent
    Lien vers ce point d'entrée

work-settings

  • /api/v1/get_work_settingsGET · POSTreadLecture. Horaires de travail du compte au nom duquel la clé MCP agit : jours travaillés (ISO, 1 = lundi), début et fin de la journée, durée par défaut d'une tâche calée sur une heure. Ce sont eux qui bornent les heures proposées à une tâche ; sans réglage, du lundi au vendredi, de 9 h à 18 h, trente minutes.

    Aucun paramètre.

    Rend object
    Champs
    • work_days string[] · toujours présentValeurs
      1234567
    • work_start string · toujours présent
    • work_end string · toujours présent
    • task_minutes number · toujours présent
    Lien vers ce point d'entrée
  • /api/v1/update_work_settingsPOSTwriteÉcriture. Règle les horaires de travail du compte : chaque champ est facultatif et ce qui n'est pas envoyé reste en place. La journée doit finir après avoir commencé, et une tâche dure de 5 minutes à 8 heures.
    Paramètres
    • work_days integer[] : Jours ISO travaillés, du lundi (1) au dimanche (7) ; remplace la liste précédente. Absent : inchangé.
    • work_start string : Heure de début de la journée de travail, HH:MM. Absente : inchangée.
    • work_end string : Heure de fin de la journée de travail, HH:MM, après le début. Absente : inchangée.
    • task_minutes integer : Durée d'une tâche calée à une heure sans durée choisie, en minutes (5 à 480).
    Rend object
    Champs
    • work_days string[] · toujours présentValeurs
      1234567
    • work_start string · toujours présent
    • work_end string · toujours présent
    • task_minutes number · toujours présent
    Lien vers ce point d'entrée

nav-preferences

  • /api/v1/get_nav_preferencesGET · POSTreadLecture. Navigation de l'espace admin telle que le compte au nom duquel la clé agit l'a rangée : l'ordre de ses sections (barre latérale et menu du téléphone), les quatre sections de la barre basse du téléphone et le geste de son bouton central (task, conversation, search ou assistant). null veut dire qu'il n'a rien réglé et que l'ordre par défaut s'applique.

    Aucun paramètre.

    Rend object
    Champs
    • nav_order string[]|null · toujours présentValeurs
      whatsappagencydecisionstasksmeetingsnotesskillsfilescalendarmessagesclientssocialmediaquestionnairesintegrationsmodules
    • bottom_nav string[]|null · toujours présentValeurs
      whatsappagencydecisionstasksmeetingsnotesskillsfilescalendarmessagesclientssocialmediaquestionnairesintegrationsmodules
    • bottom_nav_action string|null · toujours présentValeurs
      taskconversationsearchassistant
    Lien vers ce point d'entrée
  • /api/v1/update_nav_preferencesPOSTwriteÉcriture. Range la navigation de l'espace admin du compte : chaque champ est facultatif, ce qui n'est pas envoyé reste en place, et null rend le réglage par défaut. Les sections se nomment par leur clé (tasks, calendar, messages, notes, clients, social, media, meetings, questionnaires, decisions, skills, agency, integrations, modules) ; celles que nav_order omet se rangent après les autres, et bottom_nav en prend exactement quatre, toutes différentes.
    Paramètres
    • nav_order string[]|null : Sections du menu dans l'ordre voulu, de haut en bas ; les absentes suivent. null rend l'ordre par défaut.Valeurs
      taskscalendarmessageswhatsappnotesfilesclientssocialmediameetingsquestionnairesdecisionsskillsagencyintegrationsmodules
    • bottom_nav string[]|null : Les quatre sections de la barre basse du téléphone, de gauche à droite, différentes ; null rend le défaut.Valeurs
      taskscalendarmessageswhatsappnotesfilesclientssocialmediameetingsquestionnairesdecisionsskillsagencyintegrationsmodules
    • bottom_nav_action string|null : Geste du disque central de la barre basse (task par défaut, conversation, search, assistant) ; null rend le défaut.Valeurs
      taskconversationsearchassistant
    Rend object
    Champs
    • nav_order string[]|null · toujours présentValeurs
      whatsappagencydecisionstasksmeetingsnotesskillsfilescalendarmessagesclientssocialmediaquestionnairesintegrationsmodules
    • bottom_nav string[]|null · toujours présentValeurs
      whatsappagencydecisionstasksmeetingsnotesskillsfilescalendarmessagesclientssocialmediaquestionnairesintegrationsmodules
    • bottom_nav_action string|null · toujours présentValeurs
      taskconversationsearchassistant
    Lien vers ce point d'entrée

agencies

  • /api/v1/list_my_agenciesGET · POSTreadLecture. Les agences auxquelles appartient le compte au nom duquel la clé agit, et laquelle il regarde. Presque toujours une seule.

    Aucun paramètre.

    Rend object[]
    Chaque ligne porte
    • id string · toujours présent
    • name string · toujours présent
    • role string · toujours présentValeurs
      owneradminmember
    • active boolean · toujours présent
    Lien vers ce point d'entrée
  • /api/v1/get_agency_setupGET · POSTreadLecture. Où en est l'installation de l'agence : a-t-elle une fiche société, une marque posée, un premier client, un premier devis, un second membre, et quel client ouvrir pour écrire ce devis. Utile pour savoir quoi proposer à quelqu'un qui vient d'arriver.

    Aucun paramètre.

    Rend object
    Champs
    • hasClient boolean · toujours présent
    • hasCompany boolean · toujours présent
    • hasBrand boolean · toujours présent
    • hasTeammate boolean · toujours présent
    • hasQuote boolean · toujours présent
    • quoteClientId null|string · toujours présent
    Lien vers ce point d'entrée
  • /api/v1/create_agencyPOSTwriteÉcriture. Crée une agence et en fait le compte propriétaire. Geste rare : il ouvre un espace neuf, vide, et n'a de sens que pour quelqu'un qui n'en a pas encore. Ne donne accès à rien d'existant.
    Paramètres
    • name string · obligatoire : Nom de la nouvelle agence, 200 caractères au plus.
    Rend object
    Champs
    • agency_id string · toujours présent
    Lien vers ce point d'entrée
  • /api/v1/set_active_agencyPOSTwriteÉcriture. Change l'agence que le compte regarde. Tout ce que les autres outils lisent et écrivent en découle : c'est un changement de contexte, pas un réglage d'affichage.
    Paramètres
    • agency_id string · obligatoire : Agence à rendre active, parmi celles que rend list_my_agencies.
    Rend object
    Champs
    • agency_id string · toujours présent
    Lien vers ce point d'entrée

agency-modules

  • /api/v1/get_agency_modulesGET · POSTreadLecture. Les modules que l'agence a ouverts parmi Publications (social), Studio (media), Réunions (meetings) et Questionnaires (questionnaires). Un module fermé n'apparaît ni dans la navigation, ni dans les fiches clients, ni dans l'espace des clients : avant de proposer une réunion, un contenu de publication ou un questionnaire, vérifier que son module est ouvert. Un module ouvert peut encore être fermé pour un client précis : voir getClientModules.

    Aucun paramètre.

    Rend object
    Champs
    • enabled string[] · toujours présentValeurs
      whatsappmeetingsskillscalendarsocialmediaquestionnaires
    Lien vers ce point d'entrée
  • /api/v1/set_agency_modulePOSTwriteÉcriture. Ouvre ou ferme un module pour toute l'agence. Fermer ne supprime aucune donnée : l'écran disparaît de la navigation, des fiches clients et de l'espace des clients, et rouvrir le module rend tout tel quel.
    Paramètres
    • module string · obligatoire : Le module : social (Publications), media (Studio), meetings (Réunions), questionnaires (Questionnaires), whatsapp (WhatsApp Business).Valeurs
      calendarsocialmediameetingsquestionnairesskillswhatsapp
    • enabled boolean · obligatoire : Vrai pour ouvrir le module, faux pour le fermer.
    Rend object
    Champs
    • enabled string[] · toujours présentValeurs
      whatsappmeetingsskillscalendarsocialmediaquestionnaires
    Lien vers ce point d'entrée

client-modules

  • /api/v1/get_client_modulesGET · POSTreadLecture. Les modules d'une fiche client : « enabled », ceux qui valent pour ce client (l'agence les a ouverts et personne ne les lui a fermés) ; « closed », ceux qu'on a fermés pour lui seul. Seuls Publications (social) et Questionnaires (questionnaires) se ferment par client. Avant de proposer un contenu de publication ou un questionnaire pour un client, vérifier que son module figure dans « enabled ».
    Paramètres
    • client_id string · obligatoire : L'identifiant de la fiche client.
    Rend object
    Champs
    • enabled string[] · toujours présentValeurs
      whatsappmeetingsskillscalendarsocialmediaquestionnaires
    • closed string[] · toujours présentValeurs
      socialquestionnaires
    Lien vers ce point d'entrée
  • /api/v1/set_client_modulePOSTwriteÉcriture. Ferme un module pour un seul client, ou le lui rend. Fermer ne supprime aucune donnée : l'onglet quitte la fiche et l'écran quitte l'espace du client, et rendre le module rend tout tel quel. Rendre un module que l'agence n'a pas ouvert ne l'ouvre pas : c'est setAgencyModule, pour toute l'agence.
    Paramètres
    • client_id string · obligatoire : L'identifiant de la fiche client.
    • module string · obligatoire : Le module : social (Publications) ou questionnaires (Questionnaires).Valeurs
      socialquestionnaires
    • enabled boolean · obligatoire : Vrai pour rendre le module à ce client (il suit alors l'agence), faux pour le lui fermer.
    Rend object
    Champs
    • enabled string[] · toujours présentValeurs
      whatsappmeetingsskillscalendarsocialmediaquestionnaires
    • closed string[] · toujours présentValeurs
      socialquestionnaires
    Lien vers ce point d'entrée

admin-locale

  • /api/v1/set_admin_localePOSTwriteÉcriture. Change la langue dans laquelle le compte lit l'espace admin.
    Paramètres
    • locale string · obligatoire : Langue retenue : fr, en ou es.Valeurs
      frenes
    Rend object
    Champs
    • locale string · toujours présentValeurs
      frenes
    Lien vers ce point d'entrée

notifications

  • /api/v1/list_notificationsGET · POSTreadLecture. Dernières notifications du compte au nom duquel la clé MCP agit, de la plus récente à la plus ancienne : lues et non lues, ou les non lues seules avec unread_only.
    Paramètres
    • unread_only boolean : Vrai : les notifications non lues seules, pour savoir ce qui attend encore.
    • limit integer : Combien de lignes rendre au plus (50 par défaut et au maximum).
    • offset integer : Combien de lignes sauter, pour aller chercher la suite de la liste.
    Rend object[]
    Chaque ligne porte
    • id string · toujours présent
    • type string · toujours présentValeurs
      mentiontask_assignedtask_commenttask_statusticket_openedticket_messagecomment_reactionclient_file_addedcredential_activitynote_commentbooking_createdmeeting_startingquestionnaire_answeredclient_form_submittedquote_commentquote_signedbill_addedbill_duesocial_assignedsocial_to_approvesocial_reviewed
    • read boolean · toujours présent
    • created_at string · toujours présent
    • title string · toujours présent
    • body string · toujours présent
    • href null|string · toujours présent
    Lien vers ce point d'entrée
  • /api/v1/count_unread_notificationsGET · POSTreadLecture. Nombre de notifications non lues, sans en rendre le contenu.

    Aucun paramètre.

    Rend number
    Lien vers ce point d'entrée
  • /api/v1/mark_notification_readPOSTwriteÉcriture. Marque une notification comme lue. Rien ne disparaît du tiroir, seule la pastille s'éteint.
    Paramètres
    • id string · obligatoire : Identifiant de la notification, tel que rendu par list_notifications.
    Rend void
    Lien vers ce point d'entrée
  • /api/v1/mark_all_notifications_readPOSTwriteÉcriture. Éteint toutes les pastilles d'un geste, sans rien retirer du tiroir.

    Aucun paramètre.

    Rend void
    Lien vers ce point d'entrée
  • /api/v1/delete_notificationPOSTdestructiveSuppression définitive, irréversible. Retire définitivement une notification du tiroir. Le fait annoncé (la tâche, le devis, le message) reste où il est : seul l'avis disparaît.
    Paramètres
    • id string · obligatoire : Identifiant de la notification, tel que rendu par list_notifications.
    Rend void
    Lien vers ce point d'entrée
  • /api/v1/delete_read_notificationsPOSTdestructiveSuppression définitive, irréversible. Retire définitivement du tiroir toutes les notifications déjà lues, et elles seules. Rend le nombre de lignes retirées.

    Aucun paramètre.

    Rend number
    Lien vers ce point d'entrée
  • /api/v1/list_notification_settingsGET · POSTreadLecture. Réglages de notification du compte : un bloc par type recevable, avec l'état de chaque canal.

    Aucun paramètre.

    Rend object[]
    Chaque ligne porte
    • type string · toujours présentValeurs
      mentiontask_assignedtask_commenttask_statusticket_openedticket_messagecomment_reactionclient_file_addedcredential_activitynote_commentbooking_createdmeeting_startingquestionnaire_answeredclient_form_submittedquote_commentquote_signedbill_addedbill_duesocial_assignedsocial_to_approvesocial_reviewed
    • label string · toujours présent
    • description string · toujours présent
    • channels object · toujours présent
      • in_app boolean · toujours présent
      • email boolean · toujours présent
      • push boolean · toujours présent
    Lien vers ce point d'entrée
  • /api/v1/set_notification_channelPOSTwriteÉcriture. Coche ou décoche un canal de notification pour un type donné, et rend les réglages relus.
    Paramètres
    • type string · obligatoire : Évènement à régler, parmi ceux que list_notification_settings rend pour ce compte ; un autre est refusé.Valeurs
      mentiontask_assignedtask_commenttask_statusticket_openedticket_messagecomment_reactionclient_file_addedcredential_activitynote_commentbooking_createdmeeting_startingquestionnaire_answeredclient_form_submittedquote_commentquote_signedbill_addedbill_duesocial_assignedsocial_to_approvesocial_reviewed
    • channel string · obligatoire : Canal à régler : in_app (le tiroir de l'application), email ou push.Valeurs
      in_appemailpush
    • enabled boolean · obligatoire : true ouvre ce canal pour cet évènement, false le coupe. Les deux autres canaux restent tels quels.
    Rend object[]
    Chaque ligne porte
    • type string · toujours présentValeurs
      mentiontask_assignedtask_commenttask_statusticket_openedticket_messagecomment_reactionclient_file_addedcredential_activitynote_commentbooking_createdmeeting_startingquestionnaire_answeredclient_form_submittedquote_commentquote_signedbill_addedbill_duesocial_assignedsocial_to_approvesocial_reviewed
    • label string · toujours présent
    • description string · toujours présent
    • channels object · toujours présent
      • in_app boolean · toujours présent
      • email boolean · toujours présent
      • push boolean · toujours présent
    Lien vers ce point d'entrée
  • /api/v1/set_notification_channel_for_all_typesPOSTwriteÉcriture. Ouvre ou coupe un canal de notification sur tous les types recevables d'un coup, et rend les réglages relus. Les deux autres canaux restent où ils étaient.
    Paramètres
    • channel string · obligatoire : Canal à régler : in_app (le tiroir de l'application), email ou push.Valeurs
      in_appemailpush
    • enabled boolean · obligatoire : true ouvre ce canal sur tous les évènements que le compte peut recevoir, false l'y coupe. Les deux autres canaux restent tels quels.
    Rend object[]
    Chaque ligne porte
    • type string · toujours présentValeurs
      mentiontask_assignedtask_commenttask_statusticket_openedticket_messagecomment_reactionclient_file_addedcredential_activitynote_commentbooking_createdmeeting_startingquestionnaire_answeredclient_form_submittedquote_commentquote_signedbill_addedbill_duesocial_assignedsocial_to_approvesocial_reviewed
    • label string · toujours présent
    • description string · toujours présent
    • channels object · toujours présent
      • in_app boolean · toujours présent
      • email boolean · toujours présent
      • push boolean · toujours présent
    Lien vers ce point d'entrée

push

  • /api/v1/list_push_devicesGET · POSTreadLecture. Appareils abonnés aux notifications push pour le compte au nom duquel la clé MCP agit, du plus récemment ajouté au plus ancien.

    Aucun paramètre.

    Rend object[]
    Chaque ligne porte
    • id string · toujours présent
    • endpoint string · toujours présent
    • user_agent null|string · toujours présent
    • created_at string · toujours présent
    • last_used_at null|string · toujours présent
    Lien vers ce point d'entrée
  • /api/v1/save_push_subscriptionPOSTwriteÉcriture. Enregistre l'abonnement push d'un appareil, ou le met à jour s'il existe déjà. Les valeurs viennent du navigateur : rien d'utile à fabriquer à la main.
    Paramètres
    • endpoint string · obligatoire : URL que le service de push du navigateur donne pour joindre cet appareil ; un endpoint connu se met à jour.
    • p256dh string · obligatoire : Clé publique de l'appareil (keys.p256dh de l'abonnement), en base64url.
    • auth string · obligatoire : Secret d'authentification de l'appareil (keys.auth de l'abonnement), en base64url.
    • user_agent string|null : User-Agent du navigateur, pour nommer l'appareil dans la liste ; jamais interprété.
    Rend object[]
    Chaque ligne porte
    • id string · toujours présent
    • endpoint string · toujours présent
    • user_agent null|string · toujours présent
    • created_at string · toujours présent
    • last_used_at null|string · toujours présent
    Lien vers ce point d'entrée
  • /api/v1/remove_push_subscriptionPOSTdestructiveSuppression définitive, irréversible. Retire l'abonnement push d'un appareil, qui cesse de sonner. Sans recours : il faudra le réautoriser depuis l'appareil lui-même.
    Paramètres
    • endpoint string · obligatoire : Endpoint de l'abonnement à retirer, l'URL que la liste des appareils rend pour lui.
    Rend object[]
    Chaque ligne porte
    • id string · toujours présent
    • endpoint string · toujours présent
    • user_agent null|string · toujours présent
    • created_at string · toujours présent
    • last_used_at null|string · toujours présent
    Lien vers ce point d'entrée

admin-invitations

  • /api/v1/list_adminsGET · POSTreadLecture. Administrateurs de l'agence : qui a accès à l'espace admin.

    Aucun paramètre.

    Rend object[]
    Chaque ligne porte
    • user_id string · toujours présent
    • email null|string · toujours présent
    • role string · toujours présentValeurs
      owneradminmember
    • granted_at string · toujours présent
    • is_self boolean · toujours présent
    Lien vers ce point d'entrée
  • /api/v1/list_admin_invitationsGET · POSTreadLecture. Invitations d'administrateur en cours, avec leur état et leur échéance.

    Aucun paramètre.

    Rend object[]
    Chaque ligne porte
    • expires_at string · toujours présent
    • accepted_at null|string · toujours présent
    • revoked_at null|string · toujours présent
    • id string · toujours présent
    • email string · toujours présent
    • invited_by null|string · toujours présent
    • created_at string · toujours présent
    • accepted_by null|string · toujours présent
    • invited_by_email null|string · toujours présent
    Lien vers ce point d'entrée

clients

  • /api/v1/list_clientsGET · POSTreadLecture. Fiches clients, de la plus récemment modifiée à la plus ancienne, avec leur statut commercial. Pour retrouver un client, passer search (nom, société, e-mail, téléphone, ville, SIRET, TVA) plutôt que de parcourir la liste ; status et kind la restreignent aussi.
    Paramètres
    • search string : Ne garde que les lignes dont le nom, la société, l'e-mail, le téléphone, la ville, le SIRET ou le numéro de TVA contient ce texte, sans tenir compte de la casse (les accents, eux, comptent).
    • status string[] : Ne garde que les fiches à l'un de ces statuts commerciaux.Valeurs
      leadfirst-callform-sentauditsecond-callquote-draftquote-sentsignedbuildliveinactivelost
    • kind string : Professionnels (business) ou particuliers (individual) seulement.Valeurs
      businessindividual
    • limit integer : Combien de lignes rendre au plus (1000 par défaut et au maximum).
    • offset integer : Combien de lignes sauter, pour aller chercher la suite de la liste.
    Rend object[]
    Chaque ligne porte
    • id string · toujours présent
    • name string · toujours présent
    • kind string · toujours présentValeurs
      businessindividual
    • company null|string · toujours présent
    • country string · toujours présent
    • siret null|string · toujours présent
    • vat_number null|string · toujours présent
    • email null|string · toujours présent
    • phone null|string · toujours présent
    • address_line1 null|string · toujours présent
    • address_line2 null|string · toujours présent
    • postal_code null|string · toujours présent
    • city null|string · toujours présent
    • notes null|string · toujours présent
    • locale string · toujours présent
    • status string · toujours présentValeurs
      leadfirst-callform-sentauditsecond-callquote-draftquote-sentsignedbuildliveinactivelost
    • referrer_id null|string · toujours présent
    • created_at string · toujours présent
    • updated_at string · toujours présent
    Lien vers ce point d'entrée
  • /api/v1/get_clientGET · POSTreadLecture. Fiche client complète : identité, apporteur d'affaires, devis émis avec leurs signatures, formulaires de découverte reçus, et les données sur mesure de l'agence (`custom`), chacune avec son nom, sa clé, sa nature et la valeur de cette fiche.
    Paramètres
    • id string · obligatoire : Identifiant du client, tel que rendu par list_clients.
    Rend object
    Champs
    • client object · toujours présent
      • id string · toujours présent
      • name string · toujours présent
      • kind string · toujours présentValeurs
        businessindividual
      • company null|string · toujours présent
      • country string · toujours présent
      • siret null|string · toujours présent
      • vat_number null|string · toujours présent
      • email null|string · toujours présent
      • phone null|string · toujours présent
      • address_line1 null|string · toujours présent
      • address_line2 null|string · toujours présent
      • postal_code null|string · toujours présent
      • city null|string · toujours présent
      • notes null|string · toujours présent
      • locale string · toujours présent
      • status string · toujours présentValeurs
        leadfirst-callform-sentauditsecond-callquote-draftquote-sentsignedbuildliveinactivelost
      • referrer_id null|string · toujours présent
      • created_at string · toujours présent
      • updated_at string · toujours présent
    • referrer null|object · toujours présent
      • id string · toujours présent
      • name string · toujours présent
    • quotes object[] · toujours présent
      • comments object · toujours présent
        • total number · toujours présent
        • fromClient number · toujours présent
      • signature null|object · toujours présent
        • signed_at string · toujours présent
        • signer_name string · toujours présent
      • id string · toujours présent
      • number string · toujours présent
      • title string · toujours présent
      • slug string · toujours présent
      • locale string · toujours présent
      • created_at string · toujours présent
      • updated_at string · toujours présent
    • forms object[] · toujours présent
      • id string · toujours présent
      • client_id string · toujours présent
      • client_name null|string · toujours présent
      • questionnaire_id null|string · toujours présent
      • questionnaire_title string · toujours présent
      • email null|string · toujours présent
      • locale string · toujours présent
      • token string · toujours présent
      • sent_at null|string · toujours présent
      • opened_at null|string · toujours présent
      • completed_at null|string · toujours présent
      • updated_at string · toujours présent
      • answered number · toujours présent
      • total number · toujours présent
    • custom object[] · toujours présent
      • field_id string · toujours présent
      • key string · toujours présent
      • label string · toujours présent
      • type string · toujours présentValeurs
        numberbooleanemailphonedatetextlong_texturlselect
      • options string[] · toujours présent
      • hint null|string · toujours présent
      • value null|string · toujours présent
    Lien vers ce point d'entrée
  • /api/v1/upsert_clientPOSTwriteÉcriture. Crée une fiche client, ou met à jour celle dont l'identifiant est fourni. Sans identifiant, une fiche est créée.
    Paramètres
    • id string : Identifiant du client à modifier, tel que rendu par list_clients. Absent : une fiche est créée. Modifier réécrit toute la fiche.
    • name string · obligatoire : Nom de la fiche client, 200 caractères au plus.
    • kind string : business (professionnel) ou individual (particulier, sans société, SIRET ni TVA). Absent : inchangé, business à la création.Valeurs
      businessindividual
    • company string : Raison sociale de la société. Vide ou absente : aucune. Ignorée pour un particulier.
    • country string : Pays, en code ISO 3166-1 alpha-2 (FR, BE, ES...). Absent : FR.
    • siret string : SIRET à 14 chiffres, vérifié et retenu en France seulement. Vide ou absent : aucun.
    • vat_number string : Numéro de TVA intracommunautaire (FR12345678901...). Vide ou absent : aucun.
    • email string : Adresse e-mail du contact. Vide ou absente : aucune.
    • phone string : Téléphone, de 8 à 30 caractères (chiffres, espaces, +, -, parenthèses). Vide ou absent : aucun.
    • address_line1 string : Première ligne d'adresse (numéro et voie). Vide ou absente : aucune.
    • address_line2 string : Complément d'adresse (bâtiment, étage). Vide ou absent : aucun.
    • postal_code string : Code postal. Vide ou absent : aucun.
    • city string : Ville. Vide ou absente : aucune.
    • notes string : Notes internes de l'équipe, jamais montrées au client, 2000 caractères au plus.
    • locale string : Langue de l'espace client et des e-mails de la fiche. Absente : fr.Valeurs
      frenes
    • status string : Étape du parcours commercial (lead, first-call... live, inactive, lost). Absente : lead, en modification aussi.Valeurs
      leadfirst-callform-sentauditsecond-callquote-draftquote-sentsignedbuildliveinactivelost
    • referrer_id string|null : Identifiant de l'apporteur d'affaires, tel que rendu par list_referrers. null, vide ou absent : sans apporteur.
    Rend object
    Champs
    • address_line1 null|string · toujours présent
    • address_line2 null|string · toujours présent
    • city null|string · toujours présent
    • company null|string · toujours présent
    • country string · toujours présent
    • created_at string · toujours présent
    • created_by null|string · toujours présent
    • email null|string · toujours présent
    • id string · toujours présent
    • name string · toujours présent
    • notes null|string · toujours présent
    • phone null|string · toujours présent
    • postal_code null|string · toujours présent
    • siret null|string · toujours présent
    • updated_at string · toujours présent
    • vat_number null|string · toujours présent
    • locale string · toujours présent
    • kind string · toujours présentValeurs
      businessindividual
    • status string · toujours présentValeurs
      leadfirst-callform-sentauditsecond-callquote-draftquote-sentsignedbuildliveinactivelost
    • referrer_id null|string · toujours présent
    Lien vers ce point d'entrée
  • /api/v1/set_client_statusPOSTwriteÉcriture. Déplace un client sur le parcours commercial, de « lead » à « live », ou l'en sort : « inactive » pour une relation en sommeil, « lost » pour une affaire perdue.
    Paramètres
    • id string · obligatoire : Identifiant du client, tel que rendu par list_clients.
    • status string · obligatoire : Nouvelle étape du parcours commercial (lead, first-call... live, inactive, lost). Le reste de la fiche ne change pas.Valeurs
      leadfirst-callform-sentauditsecond-callquote-draftquote-sentsignedbuildliveinactivelost
    Rend object
    Champs
    • id string · toujours présent
    • status string · toujours présentValeurs
      leadfirst-callform-sentauditsecond-callquote-draftquote-sentsignedbuildliveinactivelost
    Lien vers ce point d'entrée
  • /api/v1/delete_clientPOSTdestructiveSuppression définitive, irréversible. Supprime définitivement une fiche client. Irréversible : demander confirmation avant d'appeler.
    Paramètres
    • id string · obligatoire : Identifiant du client, tel que rendu par list_clients.
    Rend object
    Champs
    • ok boolean · toujours présent
    Lien vers ce point d'entrée

tasks

  • /api/v1/list_client_membersGET · POSTreadLecture. Personnes rattachées aux espaces clients, à qui une tâche peut être assignée.

    Aucun paramètre.

    Rend object[]
    Chaque ligne porte
    • user_id string · toujours présent
    • email null|string · toujours présent
    • name null|string · toujours présent
    • avatar_url null|string · toujours présent
    • client_id string · toujours présent
    Lien vers ce point d'entrée
  • /api/v1/list_tasksGET · POSTreadLecture. Tâches de l'équipe, éventuellement restreintes à une fiche client, à une réunion, aux sous-tâches d'une tâche (parent_id), à un texte (search), un statut, une priorité, un assigné, une étiquette ou une plage d'échéances, échéances les plus proches en tête et tâches sans date en queue. Chaque tâche dit sa tâche principale (« parent ») et ses sous-tâches (« subtasks »). Se parcourt par tranches avec limit et offset, seul moyen d'atteindre la fin d'une longue liste, que le plafond de réponse coupe.
    Paramètres
    • client_id string : Ne rend que les tâches de cette fiche client (list_clients). Absent : toutes les fiches.
    • meeting_id string : Ne rend que les tâches issues de cette réunion (list_meetings). Absent : sans filtre.
    • parent_id string : Ne rend que les sous-tâches de cette tâche principale (list_tasks). Absent : sans filtre.
    • search string : Ne garde que les lignes dont le titre ou la description contient ce texte, sans tenir compte de la casse (les accents, eux, comptent).
    • status string[] : Ne garde que les tâches à l'un de ces statuts (par exemple todo et doing pour ce qui reste à faire).Valeurs
      proposedbacklogtododoingdone
    • priority string[] : Ne garde que les tâches à l'une de ces priorités.Valeurs
      lowmediumhighurgent
    • assignee_id string : Ne garde que les tâches confiées à ce membre de l'équipe (user_id de list_task_members).
    • tag string : Ne garde que les tâches portant cette étiquette, sans tenir compte de la casse.
    • due_after string : Ne garde que les tâches dont l'échéance tombe ce jour-là ou après (AAAA-MM-JJ). Écarte les tâches sans échéance.
    • due_before string : Ne garde que les tâches dont l'échéance tombe ce jour-là ou avant (AAAA-MM-JJ). Écarte les tâches sans échéance.
    • limit integer : Combien de lignes rendre au plus (500 par défaut et au maximum).
    • offset integer : Combien de lignes sauter, pour aller chercher la suite de la liste.
    Rend object[]
    Chaque ligne porte
    • id string · toujours présent
    • title string · toujours présent
    • description null|string · toujours présent
    • status string · toujours présentValeurs
      proposedbacklogtododoingdone
    • priority string|null · toujours présentValeurs
      lowmediumhighurgent
    • visibility string · toujours présentValeurs
      publicteamprivate
    • created_by null|string · toujours présent
    • client_id null|string · toujours présent
    • client_name null|string · toujours présent
    • meeting_id null|string · toujours présent
    • meeting_title null|string · toujours présent
    • start_on null|string · toujours présent
    • due_on null|string · toujours présent
    • start_time null|string · toujours présent
    • due_time null|string · toujours présent
    • recurrence null|object · toujours présent
      • every number · toujours présent
      • unit string · toujours présentValeurs
        dayweekmonthyear
    • completed_at null|string · toujours présent
    • created_at string · toujours présent
    • updated_at string · toujours présent
    • assignee_ids string[] · toujours présent
    • client_assignee_ids string[] · toujours présent
    • follower_ids string[] · toujours présent
    • tags string[] · toujours présent
    • depends_on object[] · toujours présent
      • id string · toujours présent
      • title null|string · toujours présent
      • status string|null · toujours présentValeurs
        proposedbacklogtododoingdone
    • blocks object[] · toujours présent
      • id string · toujours présent
      • title null|string · toujours présent
      • status string|null · toujours présentValeurs
        proposedbacklogtododoingdone
    • parent null|object · toujours présent
      • id string · toujours présent
      • title null|string · toujours présent
      • status string|null · toujours présentValeurs
        proposedbacklogtododoingdone
    • subtask_position null|number · toujours présent
    • subtasks object[] · toujours présent
      • id string · toujours présent
      • title null|string · toujours présent
      • status string|null · toujours présentValeurs
        proposedbacklogtododoingdone
    • comment_count number · toujours présent
    • snoozed_until null|string · toujours présent
    • snoozed_at null|string · toujours présent
    • claude null|object
      • session_url string · toujours présent
      • started_at string · toujours présent
      • ended_at null|string · toujours présent
      • requested_by null|string · toujours présent
    Lien vers ce point d'entrée
  • /api/v1/get_taskGET · POSTreadLecture. Une tâche et ses rattachements, dont sa tâche principale (« parent ») si c'est une sous-tâche, et ses sous-tâches (« subtasks ») avec leur statut.
    Paramètres
    • id string · obligatoire : Identifiant de la tâche, tel que rendu par list_tasks.
    Rend null|object
    Lien vers ce point d'entrée
  • /api/v1/create_taskPOSTwriteÉcriture. Crée une tâche. Sa visibilité décide qui la voit : l'équipe et le client, l'équipe seule, ou son auteur et ceux à qui elle est confiée. Une règle « recurrence » ({ every, unit : day | week | month | year }) la fait se répéter : la suivante naît quand on la termine, à l'échéance décalée d'un pas, et exige donc une échéance. « depends_on_ids » dit les tâches qu'elle attend : elle est signalée bloquée tant que l'une d'elles n'est pas terminée. « parent_id » en fait la sous-tâche d'une tâche principale : un seul niveau, une sous-tâche n'en a pas, et la tâche principale ne se termine pas toute seule quand ses sous-tâches le sont. « start_time » et « due_time » (« HH:MM », heure de l'équipe) précisent l'heure du début et de l'échéance, chacune avec son jour : une durée s'écrit comme une échéance le même jour, à l'heure du début plus la durée. Créée avec une heure de début, une tâche de l'appelant entre d'office dans son agenda Google s'il en a choisi un (set_task_calendar_default).
    Paramètres
    • title string · obligatoire : Titre de la tâche, de 1 à 300 caractères (espaces de bord retirés).
    • description string|null : Description en Markdown, 20 000 caractères au plus ; une mention s'écrit « [@Nom](mention:identifiant de compte) ». null ou vide l'efface.
    • status string : Statut : proposed (proposition), backlog, todo, doing ou done. « todo » à la création si absent.Valeurs
      proposedbacklogtododoingdone
    • priority string|null : Priorité : low, medium, high ou urgent. null : sans priorité.Valeurs
      lowmediumhighurgent
    • visibility string : Qui voit la tâche : public (équipe et client), team (équipe seule), private (auteur et assignés, posé par l'auteur seul). « public » à la création.Valeurs
      publicteamprivate
    • client_id string|null : Fiche client de la tâche, telle que rendue par list_clients. null la détache de toute fiche.
    • meeting_id string|null : Réunion d'où vient la tâche, telle que rendue par list_meetings. null la détache.
    • start_on string|null : Jour de début, AAAA-MM-JJ, au plus tard l'échéance. null le retire, et son heure avec lui.
    • due_on string|null : Échéance, AAAA-MM-JJ. null la retire, et son heure avec elle ; une tâche récurrente en exige une.
    • start_time string|null : Heure de début « HH:MM », heure de l'équipe ; suppose un jour de début. null la retire.
    • due_time string|null : Heure d'échéance « HH:MM », heure de l'équipe ; suppose une échéance, et le même jour ne précède pas le début. null la retire.
    • assignee_ids string[] : Membres de l'équipe assignés (voir list_task_members), 20 au plus. La liste remplace la précédente, [] désassigne tout le monde.
    • client_assignee_ids string[] : Contacts du client de la tâche assignés (voir list_client_members), 20 au plus. La liste remplace la précédente.
    • tags string[] : Étiquettes libres (voir list_task_tags pour celles déjà employées), doublons et vides retirés. La liste remplace la précédente.
    • depends_on_ids string[] : Tâches que celle-ci attend (identifiants rendus par list_tasks). La liste remplace la précédente, [] la libère.
    • parent_id string|null : Tâche principale dont celle-ci est une sous-tâche (list_tasks), sur un seul niveau. null en refait une tâche principale.
    • recurrence object|null : Règle de répétition : la suivante naît quand celle-ci passe à done, à l'échéance décalée d'un pas. null la fait cesser.
      • every integer · obligatoire : Pas de la répétition, de 1 à 99 : « tous les {every} {unit} ».
      • unit string · obligatoire : Unité du pas : day (jour), week (semaine), month (mois) ou year (année).Valeurs
        dayweekmonthyear
    Rend object
    Champs
    • id string · toujours présent
    • title string · toujours présent
    • description null|string · toujours présent
    • status string · toujours présentValeurs
      proposedbacklogtododoingdone
    • priority string|null · toujours présentValeurs
      lowmediumhighurgent
    • visibility string · toujours présentValeurs
      publicteamprivate
    • created_by null|string · toujours présent
    • client_id null|string · toujours présent
    • client_name null|string · toujours présent
    • meeting_id null|string · toujours présent
    • meeting_title null|string · toujours présent
    • start_on null|string · toujours présent
    • due_on null|string · toujours présent
    • start_time null|string · toujours présent
    • due_time null|string · toujours présent
    • recurrence null|object · toujours présent
      • every number · toujours présent
      • unit string · toujours présentValeurs
        dayweekmonthyear
    • completed_at null|string · toujours présent
    • created_at string · toujours présent
    • updated_at string · toujours présent
    • assignee_ids string[] · toujours présent
    • client_assignee_ids string[] · toujours présent
    • follower_ids string[] · toujours présent
    • tags string[] · toujours présent
    • depends_on object[] · toujours présent
      • id string · toujours présent
      • title null|string · toujours présent
      • status string|null · toujours présentValeurs
        proposedbacklogtododoingdone
    • blocks object[] · toujours présent
      • id string · toujours présent
      • title null|string · toujours présent
      • status string|null · toujours présentValeurs
        proposedbacklogtododoingdone
    • parent null|object · toujours présent
      • id string · toujours présent
      • title null|string · toujours présent
      • status string|null · toujours présentValeurs
        proposedbacklogtododoingdone
    • subtask_position null|number · toujours présent
    • subtasks object[] · toujours présent
      • id string · toujours présent
      • title null|string · toujours présent
      • status string|null · toujours présentValeurs
        proposedbacklogtododoingdone
    • comment_count number · toujours présent
    • snoozed_until null|string · toujours présent
    • snoozed_at null|string · toujours présent
    • claude null|object
      • session_url string · toujours présent
      • started_at string · toujours présent
      • ended_at null|string · toujours présent
      • requested_by null|string · toujours présent
    Lien vers ce point d'entrée
  • /api/v1/preview_taskGET · POSTreadLecture. Prépare une tâche sans la créer : prend exactement l'entrée de create_task et rend la tâche telle qu'elle serait créée, chaque identifiant nommé (client, réunion, tâche principale, dépendances, assignés), « unresolved » listant ceux qui ne désignent rien de visible, ou le refus que create_task opposerait. Rien n'est écrit et personne n'est prévenu. Dans un client qui affiche les MCP Apps, le résultat s'ouvre en carte : la personne y relit la tâche, corrige le titre, la description, la priorité ou l'échéance, et la crée d'un bouton. Ne rappelle pas create_task après un aperçu, sauf si la personne te le demande.
    Paramètres
    • title string · obligatoire : Titre de la tâche, de 1 à 300 caractères (espaces de bord retirés).
    • description string|null : Description en Markdown, 20 000 caractères au plus ; une mention s'écrit « [@Nom](mention:identifiant de compte) ». null ou vide l'efface.
    • status string : Statut : proposed (proposition), backlog, todo, doing ou done. « todo » à la création si absent.Valeurs
      proposedbacklogtododoingdone
    • priority string|null : Priorité : low, medium, high ou urgent. null : sans priorité.Valeurs
      lowmediumhighurgent
    • visibility string : Qui voit la tâche : public (équipe et client), team (équipe seule), private (auteur et assignés, posé par l'auteur seul). « public » à la création.Valeurs
      publicteamprivate
    • client_id string|null : Fiche client de la tâche, telle que rendue par list_clients. null la détache de toute fiche.
    • meeting_id string|null : Réunion d'où vient la tâche, telle que rendue par list_meetings. null la détache.
    • start_on string|null : Jour de début, AAAA-MM-JJ, au plus tard l'échéance. null le retire, et son heure avec lui.
    • due_on string|null : Échéance, AAAA-MM-JJ. null la retire, et son heure avec elle ; une tâche récurrente en exige une.
    • start_time string|null : Heure de début « HH:MM », heure de l'équipe ; suppose un jour de début. null la retire.
    • due_time string|null : Heure d'échéance « HH:MM », heure de l'équipe ; suppose une échéance, et le même jour ne précède pas le début. null la retire.
    • assignee_ids string[] : Membres de l'équipe assignés (voir list_task_members), 20 au plus. La liste remplace la précédente, [] désassigne tout le monde.
    • client_assignee_ids string[] : Contacts du client de la tâche assignés (voir list_client_members), 20 au plus. La liste remplace la précédente.
    • tags string[] : Étiquettes libres (voir list_task_tags pour celles déjà employées), doublons et vides retirés. La liste remplace la précédente.
    • depends_on_ids string[] : Tâches que celle-ci attend (identifiants rendus par list_tasks). La liste remplace la précédente, [] la libère.
    • parent_id string|null : Tâche principale dont celle-ci est une sous-tâche (list_tasks), sur un seul niveau. null en refait une tâche principale.
    • recurrence object|null : Règle de répétition : la suivante naît quand celle-ci passe à done, à l'échéance décalée d'un pas. null la fait cesser.
      • every integer · obligatoire : Pas de la répétition, de 1 à 99 : « tous les {every} {unit} ».
      • unit string · obligatoire : Unité du pas : day (jour), week (semaine), month (mois) ou year (année).Valeurs
        dayweekmonthyear
    Rend object
    Champs
    • input object · toujours présent
      • title string · toujours présent
      • description null|string
      • status stringValeurs
        proposedbacklogtododoingdone
      • priority string|nullValeurs
        lowmediumhighurgent
      • visibility stringValeurs
        publicteamprivate
      • client_id null|string
      • meeting_id null|string
      • start_on null|string
      • due_on null|string
      • start_time null|string
      • due_time null|string
      • assignee_ids string[]
      • client_assignee_ids string[]
      • tags string[]
      • depends_on_ids string[]
      • parent_id null|string
      • recurrence null|object
        • every number · toujours présent
        • unit string · toujours présentValeurs
          dayweekmonthyear
    • client null|object · toujours présent
      • id string · toujours présent
      • name string · toujours présent
    • meeting null|object · toujours présent
      • id string · toujours présent
      • title string · toujours présent
    • parent null|object · toujours présent
      • id string · toujours présent
      • title string · toujours présent
    • depends_on object[] · toujours présent
      • id string · toujours présent
      • title string · toujours présent
    • assignees object[] · toujours présent
      • user_id string · toujours présent
      • name null|string · toujours présent
      • email null|string · toujours présent
    • client_assignees object[] · toujours présent
      • user_id string · toujours présent
      • name null|string · toujours présent
      • email null|string · toujours présent
    • unresolved string[] · toujours présent
    • prepared_at string · toujours présent
    Lien vers ce point d'entrée
  • /api/v1/update_taskPOSTwriteÉcriture. Modifie une tâche : titre, statut, priorité, échéance, répétition, étiquettes, assignation, dépendances. Passer une tâche récurrente en « done » fait naître sa prochaine occurrence ; la rouvrir la reprend si personne n'y a touché. Donner un statut à une proposition (« proposed ») le donne aussi à ses sous-tâches encore proposées, « doing » devenant « todo » pour elles. Une répétition posée sur une tâche sans échéance est refusée, comme une dépendance qui ferait tourner la chaîne en rond. « depends_on_ids » remplace la liste entière : [] libère la tâche. « parent_id » la range sous une tâche principale, null en refait une tâche principale ; une tâche qui a déjà des sous-tâches ne peut pas en devenir une, et une sous-tâche ne peut pas en recevoir. « start_time » et « due_time » (« HH:MM ») précisent l'heure d'un bout qui a son jour, null la retire, et retirer le jour emporte l'heure ; le même jour, la fin ne précède pas le début. Le titre et les heures se reportent sur les événements Google qui reflètent la tâche (set_task_calendar_event), chez chacun de ceux qui l'y ont posée ; une heure de début qui arrive la pose d'office dans l'agenda choisi par l'appelant.
    Paramètres
    • title string : Titre de la tâche, de 1 à 300 caractères (espaces de bord retirés). Absent : laissé tel quel.
    • description string|null : Description en Markdown, 20 000 caractères au plus ; une mention s'écrit « [@Nom](mention:identifiant de compte) ». null ou vide l'efface.
    • status string : Statut : proposed (proposition), backlog, todo, doing ou done. « todo » à la création si absent.Valeurs
      proposedbacklogtododoingdone
    • priority string|null : Priorité : low, medium, high ou urgent. null : sans priorité.Valeurs
      lowmediumhighurgent
    • visibility string : Qui voit la tâche : public (équipe et client), team (équipe seule), private (auteur et assignés, posé par l'auteur seul). « public » à la création.Valeurs
      publicteamprivate
    • client_id string|null : Fiche client de la tâche, telle que rendue par list_clients. null la détache de toute fiche.
    • meeting_id string|null : Réunion d'où vient la tâche, telle que rendue par list_meetings. null la détache.
    • start_on string|null : Jour de début, AAAA-MM-JJ, au plus tard l'échéance. null le retire, et son heure avec lui.
    • due_on string|null : Échéance, AAAA-MM-JJ. null la retire, et son heure avec elle ; une tâche récurrente en exige une.
    • start_time string|null : Heure de début « HH:MM », heure de l'équipe ; suppose un jour de début. null la retire.
    • due_time string|null : Heure d'échéance « HH:MM », heure de l'équipe ; suppose une échéance, et le même jour ne précède pas le début. null la retire.
    • assignee_ids string[] : Membres de l'équipe assignés (voir list_task_members), 20 au plus. La liste remplace la précédente, [] désassigne tout le monde.
    • client_assignee_ids string[] : Contacts du client de la tâche assignés (voir list_client_members), 20 au plus. La liste remplace la précédente.
    • tags string[] : Étiquettes libres (voir list_task_tags pour celles déjà employées), doublons et vides retirés. La liste remplace la précédente.
    • depends_on_ids string[] : Tâches que celle-ci attend (identifiants rendus par list_tasks). La liste remplace la précédente, [] la libère.
    • parent_id string|null : Tâche principale dont celle-ci est une sous-tâche (list_tasks), sur un seul niveau. null en refait une tâche principale.
    • recurrence object|null : Règle de répétition : la suivante naît quand celle-ci passe à done, à l'échéance décalée d'un pas. null la fait cesser.
      • every integer · obligatoire : Pas de la répétition, de 1 à 99 : « tous les {every} {unit} ».
      • unit string · obligatoire : Unité du pas : day (jour), week (semaine), month (mois) ou year (année).Valeurs
        dayweekmonthyear
    • id string · obligatoire : Identifiant de la tâche à modifier, tel que rendu par list_tasks.
    Rend object
    Champs
    • id string · toujours présent
    • title string · toujours présent
    • description null|string · toujours présent
    • status string · toujours présentValeurs
      proposedbacklogtododoingdone
    • priority string|null · toujours présentValeurs
      lowmediumhighurgent
    • visibility string · toujours présentValeurs
      publicteamprivate
    • created_by null|string · toujours présent
    • client_id null|string · toujours présent
    • client_name null|string · toujours présent
    • meeting_id null|string · toujours présent
    • meeting_title null|string · toujours présent
    • start_on null|string · toujours présent
    • due_on null|string · toujours présent
    • start_time null|string · toujours présent
    • due_time null|string · toujours présent
    • recurrence null|object · toujours présent
      • every number · toujours présent
      • unit string · toujours présentValeurs
        dayweekmonthyear
    • completed_at null|string · toujours présent
    • created_at string · toujours présent
    • updated_at string · toujours présent
    • assignee_ids string[] · toujours présent
    • client_assignee_ids string[] · toujours présent
    • follower_ids string[] · toujours présent
    • tags string[] · toujours présent
    • depends_on object[] · toujours présent
      • id string · toujours présent
      • title null|string · toujours présent
      • status string|null · toujours présentValeurs
        proposedbacklogtododoingdone
    • blocks object[] · toujours présent
      • id string · toujours présent
      • title null|string · toujours présent
      • status string|null · toujours présentValeurs
        proposedbacklogtododoingdone
    • parent null|object · toujours présent
      • id string · toujours présent
      • title null|string · toujours présent
      • status string|null · toujours présentValeurs
        proposedbacklogtododoingdone
    • subtask_position null|number · toujours présent
    • subtasks object[] · toujours présent
      • id string · toujours présent
      • title null|string · toujours présent
      • status string|null · toujours présentValeurs
        proposedbacklogtododoingdone
    • comment_count number · toujours présent
    • snoozed_until null|string · toujours présent
    • snoozed_at null|string · toujours présent
    • claude null|object
      • session_url string · toujours présent
      • started_at string · toujours présent
      • ended_at null|string · toujours présent
      • requested_by null|string · toujours présent
    Lien vers ce point d'entrée
  • /api/v1/reorder_subtasksPOSTwriteÉcriture. Range les sous-tâches d'une tâche dans l'ordre voulu : « subtask_ids » est la liste complète de ses sous-tâches, dans l'ordre où elles doivent se lire, la première en tête. Refuse si la liste n'est pas exactement celle de la tâche. Une sous-tâche ajoutée ensuite se pose en dernier, et une sous-tâche rangée sous une autre tâche y arrive en dernier. Rend la tâche, ses sous-tâches dans leur nouvel ordre.
    Paramètres
    • parent_id string · obligatoire : Tâche principale dont on range les sous-tâches, telle que rendue par list_tasks.
    • subtask_ids string[] · obligatoire : Toutes ses sous-tâches, chacune une fois, dans l'ordre de lecture voulu : la première se lit en tête.
    Rend object
    Champs
    • id string · toujours présent
    • title string · toujours présent
    • description null|string · toujours présent
    • status string · toujours présentValeurs
      proposedbacklogtododoingdone
    • priority string|null · toujours présentValeurs
      lowmediumhighurgent
    • visibility string · toujours présentValeurs
      publicteamprivate
    • created_by null|string · toujours présent
    • client_id null|string · toujours présent
    • client_name null|string · toujours présent
    • meeting_id null|string · toujours présent
    • meeting_title null|string · toujours présent
    • start_on null|string · toujours présent
    • due_on null|string · toujours présent
    • start_time null|string · toujours présent
    • due_time null|string · toujours présent
    • recurrence null|object · toujours présent
      • every number · toujours présent
      • unit string · toujours présentValeurs
        dayweekmonthyear
    • completed_at null|string · toujours présent
    • created_at string · toujours présent
    • updated_at string · toujours présent
    • assignee_ids string[] · toujours présent
    • client_assignee_ids string[] · toujours présent
    • follower_ids string[] · toujours présent
    • tags string[] · toujours présent
    • depends_on object[] · toujours présent
      • id string · toujours présent
      • title null|string · toujours présent
      • status string|null · toujours présentValeurs
        proposedbacklogtododoingdone
    • blocks object[] · toujours présent
      • id string · toujours présent
      • title null|string · toujours présent
      • status string|null · toujours présentValeurs
        proposedbacklogtododoingdone
    • parent null|object · toujours présent
      • id string · toujours présent
      • title null|string · toujours présent
      • status string|null · toujours présentValeurs
        proposedbacklogtododoingdone
    • subtask_position null|number · toujours présent
    • subtasks object[] · toujours présent
      • id string · toujours présent
      • title null|string · toujours présent
      • status string|null · toujours présentValeurs
        proposedbacklogtododoingdone
    • comment_count number · toujours présent
    • snoozed_until null|string · toujours présent
    • snoozed_at null|string · toujours présent
    • claude null|object
      • session_url string · toujours présent
      • started_at string · toujours présent
      • ended_at null|string · toujours présent
      • requested_by null|string · toujours présent
    Lien vers ce point d'entrée
  • /api/v1/add_task_followersPOSTwriteÉcriture. Abonne des membres de l'équipe à une tâche, sans la leur confier : ils seront prévenus de son fil et de ses changements de statut. Sans « user_ids », abonne la personne au nom de qui l'outil agit (« je suis cette tâche »). C'est le geste à employer quand quelqu'un reprend la tâche d'un collègue : on assigne qui la fait, on abonne celui qui veut savoir où elle en est. L'auteur d'une tâche la suit d'office, et qui écrit dans son fil aussi. Refuse un compte hors de l'équipe, et sur une tâche privée quiconque n'en est ni l'auteur ni un assigné. Rend la tâche, ses abonnés dans « follower_ids ».
    Paramètres
    • task_id string · obligatoire : Identifiant de la tâche, tel que rendu par list_tasks.
    • user_ids string[] : Membres de l'équipe concernés (voir list_task_members). Absent : la personne au nom de qui l'outil agit.
    Rend object
    Champs
    • id string · toujours présent
    • title string · toujours présent
    • description null|string · toujours présent
    • status string · toujours présentValeurs
      proposedbacklogtododoingdone
    • priority string|null · toujours présentValeurs
      lowmediumhighurgent
    • visibility string · toujours présentValeurs
      publicteamprivate
    • created_by null|string · toujours présent
    • client_id null|string · toujours présent
    • client_name null|string · toujours présent
    • meeting_id null|string · toujours présent
    • meeting_title null|string · toujours présent
    • start_on null|string · toujours présent
    • due_on null|string · toujours présent
    • start_time null|string · toujours présent
    • due_time null|string · toujours présent
    • recurrence null|object · toujours présent
      • every number · toujours présent
      • unit string · toujours présentValeurs
        dayweekmonthyear
    • completed_at null|string · toujours présent
    • created_at string · toujours présent
    • updated_at string · toujours présent
    • assignee_ids string[] · toujours présent
    • client_assignee_ids string[] · toujours présent
    • follower_ids string[] · toujours présent
    • tags string[] · toujours présent
    • depends_on object[] · toujours présent
      • id string · toujours présent
      • title null|string · toujours présent
      • status string|null · toujours présentValeurs
        proposedbacklogtododoingdone
    • blocks object[] · toujours présent
      • id string · toujours présent
      • title null|string · toujours présent
      • status string|null · toujours présentValeurs
        proposedbacklogtododoingdone
    • parent null|object · toujours présent
      • id string · toujours présent
      • title null|string · toujours présent
      • status string|null · toujours présentValeurs
        proposedbacklogtododoingdone
    • subtask_position null|number · toujours présent
    • subtasks object[] · toujours présent
      • id string · toujours présent
      • title null|string · toujours présent
      • status string|null · toujours présentValeurs
        proposedbacklogtododoingdone
    • comment_count number · toujours présent
    • snoozed_until null|string · toujours présent
    • snoozed_at null|string · toujours présent
    • claude null|object
      • session_url string · toujours présent
      • started_at string · toujours présent
      • ended_at null|string · toujours présent
      • requested_by null|string · toujours présent
    Lien vers ce point d'entrée
  • /api/v1/remove_task_followersPOSTwriteÉcriture. Désabonne des membres de l'équipe d'une tâche : ils ne seront plus prévenus de son fil ni de ses changements de statut, sauf à la porter ou à y être nommés. Sans « user_ids », désabonne la personne au nom de qui l'outil agit, auteur compris. Rend la tâche.
    Paramètres
    • task_id string · obligatoire : Identifiant de la tâche, tel que rendu par list_tasks.
    • user_ids string[] : Membres de l'équipe concernés (voir list_task_members). Absent : la personne au nom de qui l'outil agit.
    Rend object
    Champs
    • id string · toujours présent
    • title string · toujours présent
    • description null|string · toujours présent
    • status string · toujours présentValeurs
      proposedbacklogtododoingdone
    • priority string|null · toujours présentValeurs
      lowmediumhighurgent
    • visibility string · toujours présentValeurs
      publicteamprivate
    • created_by null|string · toujours présent
    • client_id null|string · toujours présent
    • client_name null|string · toujours présent
    • meeting_id null|string · toujours présent
    • meeting_title null|string · toujours présent
    • start_on null|string · toujours présent
    • due_on null|string · toujours présent
    • start_time null|string · toujours présent
    • due_time null|string · toujours présent
    • recurrence null|object · toujours présent
      • every number · toujours présent
      • unit string · toujours présentValeurs
        dayweekmonthyear
    • completed_at null|string · toujours présent
    • created_at string · toujours présent
    • updated_at string · toujours présent
    • assignee_ids string[] · toujours présent
    • client_assignee_ids string[] · toujours présent
    • follower_ids string[] · toujours présent
    • tags string[] · toujours présent
    • depends_on object[] · toujours présent
      • id string · toujours présent
      • title null|string · toujours présent
      • status string|null · toujours présentValeurs
        proposedbacklogtododoingdone
    • blocks object[] · toujours présent
      • id string · toujours présent
      • title null|string · toujours présent
      • status string|null · toujours présentValeurs
        proposedbacklogtododoingdone
    • parent null|object · toujours présent
      • id string · toujours présent
      • title null|string · toujours présent
      • status string|null · toujours présentValeurs
        proposedbacklogtododoingdone
    • subtask_position null|number · toujours présent
    • subtasks object[] · toujours présent
      • id string · toujours présent
      • title null|string · toujours présent
      • status string|null · toujours présentValeurs
        proposedbacklogtododoingdone
    • comment_count number · toujours présent
    • snoozed_until null|string · toujours présent
    • snoozed_at null|string · toujours présent
    • claude null|object
      • session_url string · toujours présent
      • started_at string · toujours présent
      • ended_at null|string · toujours présent
      • requested_by null|string · toujours présent
    Lien vers ce point d'entrée
  • /api/v1/delete_taskPOSTdestructiveSuppression définitive, irréversible. Supprime définitivement une tâche. Ses sous-tâches ne sont pas supprimées : elles deviennent des tâches principales. Seule exception, une proposition (statut « proposed ») emporte ses sous-tâches encore proposées : c'est la même décision.
    Paramètres
    • id string · obligatoire : Identifiant de la tâche, tel que rendu par list_tasks.
    Rend object
    Champs
    • ok boolean · toujours présent
    Lien vers ce point d'entrée
  • /api/v1/list_task_tagsGET · POSTreadLecture. Étiquettes de tâches déjà employées, avec le nombre de tâches qui les portent.

    Aucun paramètre.

    Rend object[]
    Chaque ligne porte
    • tag string · toujours présent
    • count number · toujours présent
    • color string|nullValeurs
      bluevioletgreenyelloworangered
    Lien vers ce point d'entrée
  • /api/v1/list_task_membersGET · POSTreadLecture. Membres de l'équipe à qui une tâche peut être assignée.

    Aucun paramètre.

    Rend object
    Champs
    • current_user_id string · toujours présent
    • members object[] · toujours présent
      • user_id string · toujours présent
      • email null|string · toujours présent
      • name null|string · toujours présent
      • avatar_url null|string · toujours présent
    Lien vers ce point d'entrée

client-users

  • /api/v1/get_client_accessGET · POSTreadLecture. Qui peut ouvrir l'espace d'un client, et qui y a été invité sans avoir accepté.
    Paramètres
    • client_id string : Identifiant du client, tel que rendu par list_clients. Requis côté agence ; un compte client est ramené à sa propre fiche.
    Rend object
    Champs
    • users object[] · toujours présent
      • id string · toujours présent
      • user_id string · toujours présent
      • email null|string · toujours présent
      • name null|string · toujours présent
      • avatar_url null|string · toujours présent
      • created_at string · toujours présent
      • app_installed boolean · toujours présent
      • push_enabled boolean · toujours présent
    • invitations object[] · toujours présent
      • expires_at string · toujours présent
      • accepted_at null|string · toujours présent
      • revoked_at null|string · toujours présent
      • id string · toujours présent
      • client_id string · toujours présent
      • email string · toujours présent
      • invited_by null|string · toujours présent
      • created_at string · toujours présent
      • accepted_by null|string · toujours présent
    Lien vers ce point d'entrée
  • /api/v1/invite_client_userPOSTwriteÉcriture. Invite une adresse à ouvrir l'espace d'un client. L'invitation part par courrier électronique. La langue, si elle est passée, se pose sur la fiche : l'e-mail, l'espace et les prochains devis de ce client la reprennent.
    Paramètres
    • client_id string : Identifiant du client, tel que rendu par list_clients. Requis côté agence ; un compte client est ramené à sa propre fiche.
    • email string · obligatoire : Adresse e-mail invitée. Une invitation encore en attente pour cette adresse est remplacée par la nouvelle.
    • locale string : Langue du client (fr, en ou es), enregistrée sur sa fiche et reprise par l'e-mail et l'espace. Absente : celle de la fiche.Valeurs
      frenes
    Rend object
    Champs
    • invitation object · toujours présent
      • expires_at string · toujours présent
      • accepted_at null|string · toujours présent
      • revoked_at null|string · toujours présent
      • id string · toujours présent
      • client_id string · toujours présent
      • email string · toujours présent
      • invited_by null|string · toujours présent
      • created_at string · toujours présent
      • accepted_by null|string · toujours présent
    • url string · toujours présent
    • delivery string · toujours présentValeurs
      sentnot_configuredfailed
    Lien vers ce point d'entrée
  • /api/v1/revoke_client_invitationPOSTwriteÉcriture. Annule une invitation d'espace client qui n'a pas encore été acceptée.
    Paramètres
    • id string · obligatoire : Identifiant de l'invitation (revoke_client_invitation) ou de l'accès (remove_client_user), tel que rendu par get_client_access.
    Rend object
    Champs
    • expires_at string · toujours présent
    • accepted_at null|string · toujours présent
    • revoked_at null|string · toujours présent
    • id string · toujours présent
    • client_id string · toujours présent
    • email string · toujours présent
    • invited_by null|string · toujours présent
    • created_at string · toujours présent
    • accepted_by null|string · toujours présent
    Lien vers ce point d'entrée
  • /api/v1/remove_client_userPOSTdestructiveSuppression définitive, irréversible. Retire à une personne son accès à l'espace d'un client.
    Paramètres
    • id string · obligatoire : Identifiant de l'invitation (revoke_client_invitation) ou de l'accès (remove_client_user), tel que rendu par get_client_access.
    Rend object
    Champs
    • id string · toujours présent
    Lien vers ce point d'entrée

custom-fields

  • /api/v1/list_custom_fieldsGET · POSTreadLecture. Catalogue des données sur mesure des fiches clients : pour chaque champ, sa clé, son intitulé, sa nature (texte, nombre, date, oui/non, adresse web, e-mail, téléphone, menu à choix) et le nombre de fiches renseignées.

    Aucun paramètre.

    Rend object[]
    Chaque ligne porte
    • id string · toujours présent
    • key string · toujours présent
    • label string · toujours présent
    • type string · toujours présentValeurs
      numberbooleanemailphonedatetextlong_texturlselect
    • options string[] · toujours présent
    • hint null|string · toujours présent
    • clientCount number · toujours présent
    Lien vers ce point d'entrée
  • /api/v1/list_client_custom_dataGET · POSTreadLecture. Toutes les fiches clients et leurs données sur mesure, en un appel : le catalogue d'abord, puis chaque client avec ses valeurs rangées par clé de champ. C'est la lecture à préférer pour comparer les clients entre eux ou repérer ce qui manque ; une fiche sans aucune valeur y figure avec un objet vide.
    Paramètres
    • limit integer : Combien de lignes rendre au plus (1000 par défaut et au maximum).
    • offset integer : Combien de lignes sauter, pour aller chercher la suite de la liste.
    Rend object
    Champs
    • fields object[] · toujours présent
      • key string · toujours présent
      • label string · toujours présent
      • type string · toujours présentValeurs
        numberbooleanemailphonedatetextlong_texturlselect
      • options string[] · toujours présent
      • hint null|string · toujours présent
    • clients object[] · toujours présent
      • id string · toujours présent
      • name string · toujours présent
      • data Record<string, string> · toujours présent
    Lien vers ce point d'entrée
  • /api/v1/create_custom_fieldPOSTwriteÉcriture. Ajoute une donnée sur mesure au vocabulaire de l'agence. Elle apparaît aussitôt, vide, sur toutes les fiches. La clé de machine se dérive de l'intitulé, elle ne se choisit pas. Un champ « select » exige ses options ; aucun autre n'en accepte.
    Paramètres
    • label string · obligatoire : Intitulé du champ, de 1 à 120 caractères, espaces superflus retirés ; la clé de machine en dérive à la création.
    • type string · obligatoire : Nature du champ : text, long_text, number, url, email, phone, date, boolean ou select (menu à options).Valeurs
      textlong_textnumberurlemailphonedatebooleanselect
    • options string[] : Options du menu, 40 au plus, doublons retirés : exigées pour select, refusées sinon. Absent vaut aucune option.
    • hint string : Phrase d'aide affichée avec le champ sur les fiches, 300 caractères au plus. Absent ou vide : pas d'aide.
    Rend object
    Champs
    • id string · toujours présent
    • key string · toujours présent
    • label string · toujours présent
    • type string · toujours présentValeurs
      numberbooleanemailphonedatetextlong_texturlselect
    • options string[] · toujours présent
    • hint null|string · toujours présent
    • clientCount number · toujours présent
    Lien vers ce point d'entrée
  • /api/v1/update_custom_fieldPOSTwriteÉcriture. Modifie une donnée sur mesure : intitulé, nature, options, aide. La clé de machine ne change jamais. Attention, changer la nature d'un champ ou retirer une option efface les réponses que la nouvelle définition ne sait plus relire, sur toutes les fiches : demander confirmation avant d'appeler.
    Paramètres
    • id string · obligatoire : Identifiant du champ, tel que rendu par list_custom_fields.
    • label string · obligatoire : Intitulé du champ, de 1 à 120 caractères, espaces superflus retirés ; la clé de machine en dérive à la création.
    • type string · obligatoire : Nature du champ : text, long_text, number, url, email, phone, date, boolean ou select (menu à options).Valeurs
      textlong_textnumberurlemailphonedatebooleanselect
    • options string[] : Options du menu, 40 au plus, doublons retirés : exigées pour select, refusées sinon. Absent vaut aucune option.
    • hint string : Phrase d'aide affichée avec le champ sur les fiches, 300 caractères au plus. Absent ou vide : pas d'aide.
    Rend object
    Champs
    • id string · toujours présent
    • key string · toujours présent
    • label string · toujours présent
    • type string · toujours présentValeurs
      numberbooleanemailphonedatetextlong_texturlselect
    • options string[] · toujours présent
    • hint null|string · toujours présent
    • clientCount number · toujours présent
    Lien vers ce point d'entrée
  • /api/v1/delete_custom_fieldPOSTdestructiveSuppression définitive, irréversible. Retire une donnée sur mesure du vocabulaire, et avec elle les réponses de toutes les fiches. Irréversible : demander confirmation avant d'appeler.
    Paramètres
    • id string · obligatoire : Identifiant du champ, tel que rendu par list_custom_fields.
    Rend object
    Champs
    • ok boolean · toujours présent
    Lien vers ce point d'entrée
  • /api/v1/set_client_custom_valuePOSTwriteÉcriture. Renseigne une donnée sur mesure pour une fiche client. La valeur est relue selon la nature du champ et enregistrée sous forme canonique (nombre à point décimal, date « AAAA-MM-JJ », « true » ou « false », option écrite comme dans le catalogue). Une valeur vide efface la réponse.
    Paramètres
    • client_id string · obligatoire : Identifiant de la fiche client, tel que rendu par list_clients.
    • field_id string · obligatoire : Identifiant du champ, tel que rendu par list_custom_fields.
    • value string · obligatoire : Valeur saisie, relue selon la nature du champ (nombre, date AAAA-MM-JJ, true ou false, oui ou non, option du menu). Vide : efface la réponse.
    Rend object
    Champs
    • field_id string · toujours présent
    • value null|string · toujours présent
    Lien vers ce point d'entrée

referrers

  • /api/v1/list_referrersGET · POSTreadLecture. Catalogue des apporteurs d'affaires.

    Aucun paramètre.

    Rend object[]
    Chaque ligne porte
    • id string · toujours présent
    • name string · toujours présent
    • clientCount number · toujours présent
    Lien vers ce point d'entrée
  • /api/v1/create_referrerPOSTwriteÉcriture. Ajoute un apporteur d'affaires au catalogue.
    Paramètres
    • name string · obligatoire : Nom de l'apporteur, 120 caractères au plus. Un nom déjà au catalogue rend l'apporteur existant.
    Rend object
    Champs
    • id string · toujours présent
    • name string · toujours présent
    • clientCount number · toujours présent
    Lien vers ce point d'entrée
  • /api/v1/rename_referrerPOSTwriteÉcriture. Renomme un apporteur d'affaires.
    Paramètres
    • id string · obligatoire : Identifiant de l'apporteur, tel que rendu par list_referrers.
    • name string · obligatoire : Nouveau nom, 120 caractères au plus, qu'aucun autre apporteur ne porte déjà.
    Rend object
    Champs
    • id string · toujours présent
    • name string · toujours présent
    • clientCount number · toujours présent
    Lien vers ce point d'entrée
  • /api/v1/delete_referrerPOSTdestructiveSuppression définitive, irréversible. Retire un apporteur d'affaires du catalogue.
    Paramètres
    • id string · obligatoire : Identifiant de l'apporteur, tel que rendu par list_referrers.
    Rend object
    Champs
    • ok boolean · toujours présent
    Lien vers ce point d'entrée

quotes

  • /api/v1/create_quotePOSTwriteÉcriture. Crée un devis rattaché à une fiche client, dans sa première version. Sans langue précisée, celle du client s'applique.
    Paramètres
    • client_id string · obligatoire : Identifiant de la fiche client, tel que rendu par list_clients.
    • title string · obligatoire : Titre du devis, affiché au client.
    • locale string : Langue du devis remis au client. Absente : celle de la fiche client.Valeurs
      frenes
    Rend object
    Champs
    • id string · toujours présent
    • slug string · toujours présent
    Lien vers ce point d'entrée
  • /api/v1/get_quote_for_editGET · POSTreadLecture. Devis complet tel que l'éditeur le voit : versions, prestations, totaux, régime de TVA.
    Paramètres
    • id string · obligatoire : Identifiant du devis, tel que rendu par get_client ou create_quote.
    Rend object
    Champs
    • quote object · toujours présent
      • id string · toujours présent
      • title string · toujours présent
      • slug string · toujours présent
      • locale string · toujours présent
      • number string · toujours présent
      • validity_days number · toujours présent
      • regime string · toujours présentValeurs
        FR_20UE_AUTOLIQHORS_UEEXONERE
      • vat_exemption_note null|string · toujours présent
      • current_version_id null|string · toujours présent
      • client object · toujours présent
        • id string · toujours présent
        • name string · toujours présent
        • company null|string · toujours présent
        • country string · toujours présent
        • siret null|string · toujours présent
        • vat_number null|string · toujours présent
        • email null|string · toujours présent
        • phone null|string · toujours présent
        • address_line1 null|string · toujours présent
        • address_line2 null|string · toujours présent
        • postal_code null|string · toujours présent
        • city null|string · toujours présent
    • clientKind string|null · toujours présentValeurs
      businessindividual
    • company null|object · toujours présent
      • name string · toujours présent
      • legal_name null|string · toujours présent
      • siret null|string · toujours présent
      • vat_number null|string · toujours présent
      • country null|string · toujours présent
      • address null|string · toujours présent
      • contact_email null|string · toujours présent
      • phone null|string · toujours présent
      • bank_name null|string · toujours présent
      • iban null|string · toujours présent
      • bic null|string · toujours présent
    • versions object[] · toujours présent
      • id string · toujours présent
      • version_number number · toujours présent
      • created_at string · toujours présent
    • currentVersion null|object · toujours présent
      • created_at string · toujours présent
      • created_by null|string · toujours présent
      • description_md null|string · toujours présent
      • id string · toujours présent
      • note_md null|string · toujours présent
      • quote_id string · toujours présent
      • version_number number · toujours présent
    • currentLines object[] · toujours présent
      • id string · toujours présent
      • position number · toujours présent
      • name string · toujours présent
      • description_md null|string · toujours présent
      • price_ht number · toujours présent
      • kind string · toujours présentValeurs
        fixedmonthlycommission
      • togglable boolean · toujours présent
      • default_selected boolean · toujours présent
    • draft object · toujours présent
      • description_md string · toujours présent
      • note_md string · toujours présent
      • lines object[] · toujours présent
        • id string · toujours présent
        • name string · toujours présent
        • description_md string · toujours présent
        • price_ht number · toujours présent
        • kind string · toujours présentValeurs
          fixedmonthlycommission
        • togglable boolean · toujours présent
        • default_selected boolean · toujours présent
        • min_monthly null|number · toujours présent
      • updated_at null|string · toujours présent
    • signature null|object · toujours présent
      • version_number number · toujours présent
      • version_id string · toujours présent
      • selected_line_ids string[] · toujours présent
      • signer_name string · toujours présent
      • signer_role null|string · toujours présent
      • signer_email string · toujours présent
      • signed_at string · toujours présent
      • document_hash string · toujours présent
      • ip null|string · toujours présent
      • user_agent null|string · toujours présent
      • locale string · toujours présent
      • otp_verified_at null|string · toujours présent
      • signature_image null|string · toujours présent
      • typed_name null|string · toujours présent
    • lastSigned null|object · toujours présent
      • version_number number · toujours présent
      • signed_at string · toujours présent
    Lien vers ce point d'entrée
  • /api/v1/update_quote_metaPOSTwriteÉcriture. Modifie l'en-tête d'un devis : titre, langue, durée de validité.
    Paramètres
    • id string · obligatoire : Identifiant du devis, tel que rendu par get_client ou create_quote.
    • title string · obligatoire : Titre du devis, affiché au client.
    • locale string · obligatoire : Langue du devis remis au client : textes et mentions de la page publique.Valeurs
      frenes
    • validity_days integer · obligatoire : Durée de validité, en jours à compter de la publication de la version (1 à 365).
    • regime string · obligatoire : Régime de TVA : FR_20 (20 %), UE_AUTOLIQ (autoliquidation, n° de TVA du client requis), HORS_UE ou EXONERE.Valeurs
      FR_20UE_AUTOLIQHORS_UEEXONERE
    • vat_exemption_note string : Mention d'exonération imprimée sous le total, retenue seulement en régime EXONERE ; ignorée sinon.
    Rend object
    Champs
    • ok boolean · toujours présent
    Lien vers ce point d'entrée
  • /api/v1/save_quote_draftPOSTwriteÉcriture. Enregistre le brouillon de la version en cours, sans la publier ni créer de version nouvelle. Ce qui n'est pas nommé reste tel quel : omettre description_md ou note_md les conserve, un texte vide les efface. Les prestations, elles, remplacent toujours la liste entière.
    Paramètres
    • quote_id string · obligatoire : Identifiant du devis, tel que rendu par get_client ou create_quote.
    • description_md string : Texte de contexte en tête du devis, en Markdown. Absent : laissé tel quel ; vide : effacé.
    • note_md string : Notes en pied du devis, en Markdown. Absent : laissées telles quelles ; vide : effacées.
    • lines object[] · obligatoire : Prestations du brouillon, dans l'ordre d'affichage. Remplace toute la liste, 200 au plus.
      • name string · obligatoire : Intitulé de la prestation, tel que le client le lit. Peut rester vide dans un brouillon.
      • description_md string : Détail de la prestation, en Markdown. Absent ou vide : la ligne n'a que son intitulé.
      • price_ht number · obligatoire : Prix en euros HT (par mois pour monthly). Pour commission, c'est le taux en pourcentage : 10 pour 10 %.
      • kind string · obligatoire : Nature de la ligne : fixed (frais unique), monthly (coût mensuel), commission (pourcentage, hors des totaux en euros).Valeurs
        fixedmonthlycommission
      • togglable boolean · obligatoire : Vrai si le client peut cocher ou décocher la prestation sur le devis, faux si elle est imposée.
      • default_selected boolean · obligatoire : Vrai si la prestation est cochée à l'ouverture du devis, et donc comptée dans les totaux.
      • min_monthly number|null : Minimum mensuel en euros HT d'une ligne commission. Ignoré pour les autres natures ; null ou absent : aucun minimum.
      • id string · obligatoire : Identifiant stable de la ligne dans le brouillon, celui que rend get_quote_for_edit ; une ligne nouvelle en prend un neuf.
    • last_editor string · obligatoire : Nom libre de l'onglet ou de l'outil qui écrit : la synchro temps réel ne lui renvoie pas sa propre écriture.
    Rend object
    Champs
    • ok boolean · toujours présent
    Lien vers ce point d'entrée
  • /api/v1/save_new_quote_versionPOSTwriteÉcriture. Fige une nouvelle version du devis. C'est elle que le client verra à l'adresse publique. Ce qui n'est pas nommé est repris du brouillon : omettre description_md ou note_md publie les textes en cours, un texte vide publie du vide.
    Paramètres
    • quote_id string · obligatoire : Identifiant du devis, tel que rendu par get_client ou create_quote.
    • description_md string : Texte de contexte en tête du devis, en Markdown. Absent : repris du brouillon ; vide : publié vide.
    • note_md string : Notes en pied du devis, en Markdown. Absent : reprises du brouillon ; vide : publiées vides.
    • lines object[] · obligatoire : Prestations de la version, dans l'ordre d'affichage. La liste entière, 200 au plus.
      • name string · obligatoire : Intitulé de la prestation, tel que le client le lit.
      • description_md string : Détail de la prestation, en Markdown. Absent ou vide : la ligne n'a que son intitulé.
      • price_ht number · obligatoire : Prix en euros HT (par mois pour monthly). Pour commission, c'est le taux en pourcentage : 10 pour 10 %.
      • kind string · obligatoire : Nature de la ligne : fixed (frais unique), monthly (coût mensuel), commission (pourcentage, hors des totaux en euros).Valeurs
        fixedmonthlycommission
      • togglable boolean · obligatoire : Vrai si le client peut cocher ou décocher la prestation sur le devis, faux si elle est imposée.
      • default_selected boolean · obligatoire : Vrai si la prestation est cochée à l'ouverture du devis, et donc comptée dans les totaux.
      • min_monthly number|null : Minimum mensuel en euros HT d'une ligne commission. Ignoré pour les autres natures ; null ou absent : aucun minimum.
    Rend object
    Champs
    • version_id string · toujours présent
    • version_number number · toujours présent
    Lien vers ce point d'entrée
  • /api/v1/restore_quote_versionPOSTwriteÉcriture. Remet le brouillon du devis sur le contenu d'une version déjà publiée : description, notes et prestations. Rien n'est publié et aucune version n'est retirée, le client continue de lire celle qu'il lisait ; il faut publier ensuite pour lui remettre ce contenu, qui deviendra une version de plus. Le brouillon en cours est remplacé, et ce qu'il portait de non publié est perdu.
    Paramètres
    • quote_id string · obligatoire : Identifiant du devis, tel que rendu par get_client ou create_quote.
    • version_id string · obligatoire : Identifiant d'une version publiée de ce devis, parmi celles que rend get_quote_for_edit.
    • last_editor string : Nom de l'onglet d'éditeur qui demande la remise. Absent : tous les éditeurs ouverts reçoivent le contenu remis.
    Rend object
    Champs
    • description_md string · toujours présent
    • note_md string · toujours présent
    • lines object[] · toujours présent
      • id string · toujours présent
      • name string · toujours présent
      • description_md string · toujours présent
      • price_ht number · toujours présent
      • kind string · toujours présentValeurs
        fixedmonthlycommission
      • togglable boolean · toujours présent
      • default_selected boolean · toujours présent
      • min_monthly null|number · toujours présent
    • version_number number · toujours présent
    Lien vers ce point d'entrée

quote-comments

  • /api/v1/add_quote_comment_as_adminPOSTwriteÉcriture. Écrit dans le fil de commentaires d'une version de devis, au nom de l'agence. Le fil est visible du client.
    Paramètres
    • slug string · obligatoire : Slug du devis, celui de son adresse publique /q/<slug>, rendu par get_quote_for_edit.
    • version integer · obligatoire : Numéro de la version commentée (1, 2, 3...), pas son identifiant.
    • body string · obligatoire : Texte du commentaire, signé du nom du compte qui écrit et visible du client.
    • parent_id string|null : Commentaire auquel on répond, sur la même version. Absent ou null : ouvre un fil nouveau.
    • anchor object|null : Épingle le commentaire sur une partie du devis. Ignorée pour une réponse, qui suit le fil de sa racine ; absente : commentaire général.
      • type string · obligatoire : Partie épinglée : line (une prestation), context (texte de tête), notes ou totals.Valeurs
        linecontextnotestotals
      • line_id string|null : Identifiant de la prestation de cette version, requis avec le type line et interdit avec les autres.
      • excerpt string|null : Passage cité du devis, affiché avec le commentaire. Absent : aucune citation.
    Rend object
    Champs
    • id string · toujours présent
    • parent_id null|string · toujours présent
    • author_name string · toujours présent
    • is_admin boolean · toujours présent
    • body string · toujours présent
    • created_at string · toujours présent
    • anchor_type string|null · toujours présentValeurs
      noteslinetotalscontext
    • anchor_line_id null|string · toujours présent
    • anchor_excerpt null|string · toujours présent
    Lien vers ce point d'entrée

task-snoozes

  • /api/v1/set_task_snoozePOSTwriteÉcriture. Met une tâche en pause pour l'appelant seul, comme le « snooze » de Gmail : elle quitte sa liste jusqu'à « until » (un instant ISO avec son décalage), puis y revient marquée « à relancer ». null la reprend, et efface cette marque. Les collègues continuent de la voir, rien ne change à la tâche elle-même. Une échéance qui arrive pendant la pause la réveille ; une tâche déjà due ou en retard se met en pause comme une autre et reste rangée jusqu'à « until ». La pause se réveille aussi dès que quelqu'un d'autre écrit dans le fil de la tâche. Les lectures de tâches rendent la pause de l'appelant dans « snoozed_until ».
    Paramètres
    • task_id string · obligatoire : Identifiant de la tâche, tel que rendu par list_tasks.
    • until string|null · obligatoire : Fin de la pause, instant ISO 8601 avec son décalage (2026-11-03T09:00:00+01:00). null reprend la tâche tout de suite.
    Rend object
    Champs
    • task_id string · toujours présent
    • snoozed_until null|string · toujours présent
    • snoozed_at null|string · toujours présent
    Lien vers ce point d'entrée

task-activity

  • /api/v1/list_task_activityGET · POSTreadLecture. Journal d'une tâche, du plus récent au plus ancien : qui l'a créée, qui a changé son statut, son urgence, ses dates, son client, sa visibilité, sa répétition, son titre ou sa description, qui l'a confiée à qui, quelles étiquettes ont été posées ou retirées. « actor_side » vaut « system » quand personne n'est derrière le geste (Noki : une proposition tirée d'une réunion, la suite d'une tâche récurrente), « client » pour un contact de la fiche. Les retouches rapprochées d'un même champ par la même personne sont fondues en une ligne. Les valeurs sont des codes (statut, urgence, visibilité), des jours « AAAA-MM-JJ » éventuellement suivis d'une heure, des noms ou une règle « 2 week » ; la description n'y laisse qu'une empreinte.
    Paramètres
    • task_id string · obligatoire : Identifiant de la tâche, tel que rendu par list_tasks.
    • limit integer : Combien de lignes rendre au plus (200 par défaut et au maximum).
    • offset integer : Combien de lignes sauter, pour aller chercher la suite de la liste.
    Rend object[]
    Chaque ligne porte
    • id string · toujours présent
    • actor_id null|string · toujours présent
    • actor_name null|string · toujours présent
    • actor_side string · toujours présentValeurs
      clientteamsystem
    • kind string · toujours présentValeurs
      createdfieldassignee_addedassignee_removedclient_assignee_addedclient_assignee_removedtag_addedtag_removed
    • field string|null · toujours présentValeurs
      clienttitlestatusdescriptionparentpriorityvisibilityrecurrencestartdue
    • old_value null|string · toujours présent
    • new_value null|string · toujours présent
    • target_id null|string · toujours présent
    • created_at string · toujours présent
    Lien vers ce point d'entrée

task-comments

  • /api/v1/list_task_commentsGET · POSTreadLecture. Fil d'une tâche, du plus ancien message au plus récent. « shared_with_client » dit, message par message, si le client le lit ou s'il est resté interne à l'équipe.
    Paramètres
    • task_id string · obligatoire : Identifiant de la tâche, tel que rendu par list_tasks.
    • limit integer : Combien de lignes rendre au plus (300 par défaut et au maximum).
    • offset integer : Combien de lignes sauter, pour aller chercher la suite de la liste.
    Rend object[]
    Chaque ligne porte
    • parent_id null|string · toujours présent
    • anchor_exact null|string · toujours présent
    • anchor_prefix null|string · toujours présent
    • anchor_suffix null|string · toujours présent
    • resolved_at null|string · toujours présent
    • resolved_by null|string · toujours présent
    • resolved_by_name null|string · toujours présent
    • id string · toujours présent
    • author_id null|string · toujours présent
    • author_name string · toujours présent
    • author_avatar_url null|string · toujours présent
    • author_side string · toujours présentValeurs
      clientteam
    • body string · toujours présent
    • created_at string · toujours présent
    • edited_at null|string · toujours présent
    • shared_with_client stringValeurs
      falsetrue
    Lien vers ce point d'entrée
  • /api/v1/add_task_commentPOSTwriteÉcriture. Écrit un message dans le fil d'une tâche, au nom du compte connecté. Interne par défaut : seule l'équipe le lit. Sur une tâche publique rattachée à une fiche, « shared_with_client: true » ouvre un fil que le client lit aussi ; ne le poser que pour ce qui lui est réellement adressé, un message parti chez lui ne se rattrape pas. Une réponse (« parent_id ») suit le fil auquel elle répond et ignore ce champ. Une mention s'écrit « [@Nom](mention:identifiant de compte) » et ne prévient que quelqu'un qui lira le message : un contact du client nommé dans un message interne retombe en texte simple. « anchor » attache le message à un passage de la description, en reprenant le texte exact du passage et ce qui l'entoure.
    Paramètres
    • task_id string · obligatoire : Identifiant de la tâche, tel que rendu par list_tasks.
    • body string · obligatoire : Texte du message ; une mention s'écrit « [@Nom](mention:identifiant de compte) ».
    • parent_id string|null : Message auquel celui-ci répond, tel que rendu par la lecture du fil. Absent ou null : ouvre un nouveau fil.
    • anchor object|null : Passage du document sur lequel le message est posé. Absent ou null : le message ne vise aucun passage.
      • exact string · obligatoire : Texte exact du passage visé, tel qu'il se lit dans le document, 300 caractères au plus.
      • prefix string · = "" : Texte qui précède immédiatement le passage, pour le distinguer d'une autre occurrence. Vide par défaut.
      • suffix string · = "" : Texte qui suit immédiatement le passage, même usage que prefix. Vide par défaut.
    • shared_with_client boolean · = false : Vrai pour ouvrir un fil que le client lit aussi, sur une tâche publique rattachée à une fiche. Faux par défaut ; ignoré d'une réponse.
    Rend object
    Champs
    • parent_id null|string · toujours présent
    • anchor_exact null|string · toujours présent
    • anchor_prefix null|string · toujours présent
    • anchor_suffix null|string · toujours présent
    • resolved_at null|string · toujours présent
    • resolved_by null|string · toujours présent
    • resolved_by_name null|string · toujours présent
    • id string · toujours présent
    • author_id null|string · toujours présent
    • author_name string · toujours présent
    • author_avatar_url null|string · toujours présent
    • author_side string · toujours présentValeurs
      clientteam
    • body string · toujours présent
    • created_at string · toujours présent
    • edited_at null|string · toujours présent
    • shared_with_client stringValeurs
      falsetrue
    Lien vers ce point d'entrée
  • /api/v1/resolve_task_commentPOSTwriteÉcriture. Clôt la question posée par un fil de tâche (resolved: true) ou la rouvre (false). Se pose sur le premier message d'un fil, jamais sur une réponse, et ne notifie personne.
    Paramètres
    • comment_id string · obligatoire : Premier message du fil, tel que rendu par list_task_comments ; jamais une réponse.
    • resolved boolean · obligatoire : Vrai pour clore la question du fil, faux pour la rouvrir.
    Rend object
    Champs
    • parent_id null|string · toujours présent
    • anchor_exact null|string · toujours présent
    • anchor_prefix null|string · toujours présent
    • anchor_suffix null|string · toujours présent
    • resolved_at null|string · toujours présent
    • resolved_by null|string · toujours présent
    • resolved_by_name null|string · toujours présent
    • id string · toujours présent
    • author_id null|string · toujours présent
    • author_name string · toujours présent
    • author_avatar_url null|string · toujours présent
    • author_side string · toujours présentValeurs
      clientteam
    • body string · toujours présent
    • created_at string · toujours présent
    • edited_at null|string · toujours présent
    • shared_with_client stringValeurs
      falsetrue
    Lien vers ce point d'entrée
  • /api/v1/update_task_commentPOSTwriteÉcriture. Corrige un message du fil d'une tâche, écrit par le compte au nom duquel la clé MCP agit. Un message écrit par quelqu'un d'autre est refusé, par le moteur lui-même. Le fil affichera « modifié » à côté de sa date. Les mentions se réécrivent comme à l'envoi, et une personne que la correction vient de nommer en est prévenue. « shared_with_client » change en plus le public du fil, sur son premier message seulement et tant que personne n'y a répondu (refusé sinon) : true l'adresse au client, qui en est prévenu comme d'un message neuf, false le replie en interne, sans reprendre ce qu'il a déjà pu lire. Absent, le public ne bouge pas. Comme à l'envoi, rien n'est adressé au client sur une tâche qui ne lui est pas ouverte.
    Paramètres
    • task_id string · obligatoire : Identifiant de la tâche, tel que rendu par list_tasks.
    • comment_id string · obligatoire : Identifiant du message, tel que rendu par list_task_comments.
    • body string · obligatoire : Nouveau texte du message, qui remplace l'ancien ; les mentions s'écrivent comme à l'envoi.
    • shared_with_client boolean : Nouveau public du fil, sur son premier message tant que personne n'y a répondu : vrai pour le client. Absent : inchangé.
    Rend object
    Champs
    • parent_id null|string · toujours présent
    • anchor_exact null|string · toujours présent
    • anchor_prefix null|string · toujours présent
    • anchor_suffix null|string · toujours présent
    • resolved_at null|string · toujours présent
    • resolved_by null|string · toujours présent
    • resolved_by_name null|string · toujours présent
    • id string · toujours présent
    • author_id null|string · toujours présent
    • author_name string · toujours présent
    • author_avatar_url null|string · toujours présent
    • author_side string · toujours présentValeurs
      clientteam
    • body string · toujours présent
    • created_at string · toujours présent
    • edited_at null|string · toujours présent
    • shared_with_client stringValeurs
      falsetrue
    Lien vers ce point d'entrée
  • /api/v1/delete_task_commentPOSTdestructiveSuppression définitive, irréversible. Supprime définitivement un message du fil d'une tâche, écrit par le compte au nom duquel la clé MCP agit. Refusé pour un message auquel on a répondu : il se corrige, il ne se supprime plus.
    Paramètres
    • task_id string · obligatoire : Identifiant de la tâche, tel que rendu par list_tasks.
    • comment_id string · obligatoire : Identifiant du message, tel que rendu par list_task_comments.
    Rend object
    Champs
    • id string · toujours présent
    Lien vers ce point d'entrée

comment-reactions

  • /api/v1/list_comment_reactionsGET · POSTreadLecture. Réactions (emojis) posées sur les messages d'un fil : celui d'une tâche, d'une note (ou du rapport qui la publie) ou d'une conversation. Rend « reactions », un objet dont chaque clé est l'identifiant d'un message et chaque valeur la liste de ses réactions : le code de l'emoji, combien de personnes l'ont posé, « mine » si le compte connecté en fait partie, et le nom des autres. Un message sans réaction n'y figure pas.
    Paramètres
    • target string · obligatoire : Le fil visé : « task » (fil d'une tâche, thread_id = id de la tâche), « note » (fil d'une note ou de son rapport, thread_id = id de la note), « ticket » (conversation, thread_id = id de la conversation).Valeurs
      tasknoteticket
    • thread_id string · obligatoire : Identifiant de la tâche, de la note ou de la conversation.
    Rend object
    Champs
    • reactions Record<string, object[]> · toujours présent
      • emoji string · toujours présent
      • count number · toujours présent
      • mine boolean · toujours présent
      • others string[] · toujours présent
    Lien vers ce point d'entrée
  • /api/v1/toggle_comment_reactionPOSTwriteÉcriture. Pose une réaction sur un message d'un fil (tâche, note ou conversation), au nom du compte connecté, ou la retire s'il l'avait déjà posée. Une réaction posée prévient l'auteur du message (dans sa cloche par défaut), jamais le reste du fil ; la retirer ne prévient personne. Rend les réactions du fil après le geste, dans la forme de list_comment_reactions.
    Paramètres
    • target string · obligatoire : Le fil visé : « task » (fil d'une tâche, thread_id = id de la tâche), « note » (fil d'une note ou de son rapport, thread_id = id de la note), « ticket » (conversation, thread_id = id de la conversation).Valeurs
      tasknoteticket
    • thread_id string · obligatoire : Identifiant de la tâche, de la note ou de la conversation.
    • comment_id string · obligatoire : Identifiant du message, tel que rendu par la lecture du fil.
    • emoji string · obligatoire : La réaction : thumbs_up 👍, heart ❤️, check ✅, eyes 👀, party 🎉, laugh 😂.Valeurs
      thumbs_upheartcheckeyespartylaugh
    Rend object
    Champs
    • reactions Record<string, object[]> · toujours présent
      • emoji string · toujours présent
      • count number · toujours présent
      • mine boolean · toujours présent
      • others string[] · toujours présent
    Lien vers ce point d'entrée

task-views

  • /api/v1/list_task_viewsGET · POSTreadLecture. Vues enregistrées de la liste des tâches du compte au nom duquel la clé MCP agit, et laquelle s'ouvre par défaut.

    Aucun paramètre.

    Rend object
    Champs
    • views object[] · toujours présent
      • id string · toujours présent
      • name string · toujours présent
      • state object · toujours présent
        • filters object · toujours présent
          • search string · toujours présent
          • status string · toujours présentValeurs
            proposedbacklogtododoingdoneallopen
          • clientId null|string · toujours présent
          • assigneeId null|string · toujours présent
          • followerId null|string · toujours présent
          • visibility string · toujours présentValeurs
            publicteamprivateall
          • tags string[] · toujours présent
          • due string · toujours présentValeurs
            weekalloverduetodaynone
          • also object
            • client string[]
            • status string[]
            • visibility string[]
            • tags string[]
            • due string[]
            • assignee string[]
            • follower string[]
          • exclude string[]Valeurs
            clientstatusvisibilitytagsdueassigneefollower
        • sort string · toujours présentValeurs
          prioritystart-ascstart-descdue-ascdue-desccreated-desccompleted-desc
        • grouping string · toujours présentValeurs
          clientcompletedstatusprioritystartdueassigneenonetag
        • layout string · toujours présentValeurs
          calendarlistboard
        • subtasks string · toujours présentValeurs
          collapsednested
    • default_view_id null|string · toujours présent
    Lien vers ce point d'entrée
  • /api/v1/create_task_viewPOSTwriteÉcriture. Enregistre un jeu de filtres, de tri, de regroupement et d'affichage (liste ou tableau) sous un nom, et peut en faire la vue ouverte par défaut.
    Paramètres
    • name string · obligatoire : Nom de la vue, de 1 à 60 caractères, espaces superflus retirés.
    • state object · obligatoire : Réglages enregistrés : filtres, tri, regroupement et affichage.
      • filters object · = {} : Filtres de la barre, tous facultatifs : un filtre absent ne filtre pas.
        • search string · = "" : Recherche dans le titre, la description, le client, la réunion et les étiquettes, sans casse. Vide : sans filtre.
        • status string · = "open" : Statut exigé : open (tout sauf done et proposed, par défaut), all, ou un statut de tâche (proposed, backlog, todo, doing, done).Valeurs
          openallproposedbacklogtododoingdone
        • clientId string|null · = null : Ne garde que les tâches de cette fiche client (list_clients). null : sans filtre.
        • assigneeId string|null · = null : Ne garde que les tâches assignées à ce compte, de l'équipe (list_task_members) ou chez un client (list_client_members). null : sans filtre.
        • followerId string|null · = null : Ne garde que les tâches que suit ce membre de l'équipe (list_task_members). null : sans filtre.
        • visibility string · = "all" : Visibilité exigée : public, team ou private ; all (par défaut) ne filtre pas.Valeurs
          allpublicteamprivate
        • tags string[] : Étiquettes exigées, toutes à la fois (voir list_task_tags). Vide : sans filtre.
        • due string · = "all" : Portée d'échéance : all (par défaut), overdue (dépassée), today, week (dans les 7 jours) ou none (sans échéance).Valeurs
          alloverduetodayweeknone
        • also object : Valeurs retenues EN PLUS de celle du champ d'origine, par dimension : la ligne passe si elle répond à l'une d'elles (status : une valeur de status ; assignee, follower, client : un identifiant ; visibility, due : une valeur de leur champ). Absent : une seule valeur par dimension.
          • status string[] : Valeurs de status retenues en plus de celle du champ d'origine. Absent : aucune.
          • assignee string[] : Valeurs de assignee retenues en plus de celle du champ d'origine. Absent : aucune.
          • follower string[] : Valeurs de follower retenues en plus de celle du champ d'origine. Absent : aucune.
          • client string[] : Valeurs de client retenues en plus de celle du champ d'origine. Absent : aucune.
          • visibility string[] : Valeurs de visibility retenues en plus de celle du champ d'origine. Absent : aucune.
          • due string[] : Valeurs de due retenues en plus de celle du champ d'origine. Absent : aucune.
        • exclude string[] : Dimensions lues à l'envers : la liste écarte ce qu'elles retiennent (« tout sauf ce client »). Pour les étiquettes : n'en porter aucune. Absent : aucune.Valeurs
          statusassigneefollowerclientvisibilitytagsdue
      • sort string · = "start-asc" : Tri : start-asc (par défaut), start-desc, due-asc, due-desc, priority, created-desc ou completed-desc.Valeurs
        start-ascstart-descdue-ascdue-descprioritycreated-desccompleted-desc
      • grouping string · = "start" : Regroupement : start (par défaut), due, completed, client, assignee, status, priority, tag, ou none (à plat).Valeurs
        startduecompletedclientassigneestatusprioritytagnone
      • layout string · = "list" : Affichage : list (par défaut), board (tableau en colonnes) ou calendar.Valeurs
        listboardcalendar
      • subtasks string · = "collapsed" : Sous-tâches : collapsed (repliées dans leur tâche principale, par défaut) ou nested (rangées sous elle).Valeurs
        collapsednested
    • makeDefault boolean · = false : Vrai pour en faire aussi la vue ouverte par défaut. Faux par défaut.
    Rend object
    Champs
    • id string · toujours présent
    • name string · toujours présent
    • state object · toujours présent
      • filters object · toujours présent
        • search string · toujours présent
        • status string · toujours présentValeurs
          proposedbacklogtododoingdoneallopen
        • clientId null|string · toujours présent
        • assigneeId null|string · toujours présent
        • followerId null|string · toujours présent
        • visibility string · toujours présentValeurs
          publicteamprivateall
        • tags string[] · toujours présent
        • due string · toujours présentValeurs
          weekalloverduetodaynone
        • also object
          • client string[]
          • status string[]
          • visibility string[]
          • tags string[]
          • due string[]
          • assignee string[]
          • follower string[]
        • exclude string[]Valeurs
          clientstatusvisibilitytagsdueassigneefollower
      • sort string · toujours présentValeurs
        prioritystart-ascstart-descdue-ascdue-desccreated-desccompleted-desc
      • grouping string · toujours présentValeurs
        clientcompletedstatusprioritystartdueassigneenonetag
      • layout string · toujours présentValeurs
        calendarlistboard
      • subtasks string · toujours présentValeurs
        collapsednested
    Lien vers ce point d'entrée
  • /api/v1/update_task_viewPOSTwriteÉcriture. Renomme une vue enregistrée, remplace ses réglages, ou les deux.
    Paramètres
    • id string · obligatoire : Identifiant de la vue, tel que rendu par list_task_views.
    • name string : Nouveau nom, de 1 à 60 caractères. Absent : le nom ne change pas.
    • state object : Réglages qui remplacent les précédents en entier. Absent : ils ne changent pas.
      • filters object · = {} : Filtres de la barre, tous facultatifs : un filtre absent ne filtre pas.
        • search string · = "" : Recherche dans le titre, la description, le client, la réunion et les étiquettes, sans casse. Vide : sans filtre.
        • status string · = "open" : Statut exigé : open (tout sauf done et proposed, par défaut), all, ou un statut de tâche (proposed, backlog, todo, doing, done).Valeurs
          openallproposedbacklogtododoingdone
        • clientId string|null · = null : Ne garde que les tâches de cette fiche client (list_clients). null : sans filtre.
        • assigneeId string|null · = null : Ne garde que les tâches assignées à ce compte, de l'équipe (list_task_members) ou chez un client (list_client_members). null : sans filtre.
        • followerId string|null · = null : Ne garde que les tâches que suit ce membre de l'équipe (list_task_members). null : sans filtre.
        • visibility string · = "all" : Visibilité exigée : public, team ou private ; all (par défaut) ne filtre pas.Valeurs
          allpublicteamprivate
        • tags string[] : Étiquettes exigées, toutes à la fois (voir list_task_tags). Vide : sans filtre.
        • due string · = "all" : Portée d'échéance : all (par défaut), overdue (dépassée), today, week (dans les 7 jours) ou none (sans échéance).Valeurs
          alloverduetodayweeknone
        • also object : Valeurs retenues EN PLUS de celle du champ d'origine, par dimension : la ligne passe si elle répond à l'une d'elles (status : une valeur de status ; assignee, follower, client : un identifiant ; visibility, due : une valeur de leur champ). Absent : une seule valeur par dimension.
          • status string[] : Valeurs de status retenues en plus de celle du champ d'origine. Absent : aucune.
          • assignee string[] : Valeurs de assignee retenues en plus de celle du champ d'origine. Absent : aucune.
          • follower string[] : Valeurs de follower retenues en plus de celle du champ d'origine. Absent : aucune.
          • client string[] : Valeurs de client retenues en plus de celle du champ d'origine. Absent : aucune.
          • visibility string[] : Valeurs de visibility retenues en plus de celle du champ d'origine. Absent : aucune.
          • due string[] : Valeurs de due retenues en plus de celle du champ d'origine. Absent : aucune.
        • exclude string[] : Dimensions lues à l'envers : la liste écarte ce qu'elles retiennent (« tout sauf ce client »). Pour les étiquettes : n'en porter aucune. Absent : aucune.Valeurs
          statusassigneefollowerclientvisibilitytagsdue
      • sort string · = "start-asc" : Tri : start-asc (par défaut), start-desc, due-asc, due-desc, priority, created-desc ou completed-desc.Valeurs
        start-ascstart-descdue-ascdue-descprioritycreated-desccompleted-desc
      • grouping string · = "start" : Regroupement : start (par défaut), due, completed, client, assignee, status, priority, tag, ou none (à plat).Valeurs
        startduecompletedclientassigneestatusprioritytagnone
      • layout string · = "list" : Affichage : list (par défaut), board (tableau en colonnes) ou calendar.Valeurs
        listboardcalendar
      • subtasks string · = "collapsed" : Sous-tâches : collapsed (repliées dans leur tâche principale, par défaut) ou nested (rangées sous elle).Valeurs
        collapsednested
    Rend object
    Champs
    • id string · toujours présent
    • name string · toujours présent
    • state object · toujours présent
      • filters object · toujours présent
        • search string · toujours présent
        • status string · toujours présentValeurs
          proposedbacklogtododoingdoneallopen
        • clientId null|string · toujours présent
        • assigneeId null|string · toujours présent
        • followerId null|string · toujours présent
        • visibility string · toujours présentValeurs
          publicteamprivateall
        • tags string[] · toujours présent
        • due string · toujours présentValeurs
          weekalloverduetodaynone
        • also object
          • client string[]
          • status string[]
          • visibility string[]
          • tags string[]
          • due string[]
          • assignee string[]
          • follower string[]
        • exclude string[]Valeurs
          clientstatusvisibilitytagsdueassigneefollower
      • sort string · toujours présentValeurs
        prioritystart-ascstart-descdue-ascdue-desccreated-desccompleted-desc
      • grouping string · toujours présentValeurs
        clientcompletedstatusprioritystartdueassigneenonetag
      • layout string · toujours présentValeurs
        calendarlistboard
      • subtasks string · toujours présentValeurs
        collapsednested
    Lien vers ce point d'entrée
  • /api/v1/delete_task_viewPOSTdestructiveSuppression définitive, irréversible. Supprime une vue enregistrée. Les tâches ne bougent pas.
    Paramètres
    • id string · obligatoire : Identifiant de la vue, tel que rendu par list_task_views.
    Rend object
    Champs
    • ok boolean · toujours présent
    Lien vers ce point d'entrée
  • /api/v1/set_default_task_viewPOSTwriteÉcriture. Désigne la vue qui s'ouvre par défaut sur la liste des tâches, ou n'en désigne plus aucune avec id nul.
    Paramètres
    • id string|null · obligatoire : Vue à ouvrir par défaut (list_task_views). null : plus aucune vue par défaut.
    Rend object
    Champs
    • default_view_id null|string · toujours présent
    Lien vers ce point d'entrée

social

  • /api/v1/list_social_contentsGET · POSTreadLecture. Contenus de publication, des parutions les plus proches aux plus lointaines, avec leurs étiquettes et leurs visuels. Sans client_id, tous ; avec un identifiant, ceux d'une fiche ; avec null, ceux qui ne visent aucune fiche, c'est-à-dire les idées notées avant leur destination. Un contenu porte son texte, son fil et ses visuels : la réponse est vite pleine, et « offset » est le seul moyen d'atteindre la fin de la liste.
    Paramètres
    • client_id string|null : Identifiant de la fiche, tel que rendu par list_clients. Absent : tous les contenus ; null : ceux qui ne visent aucune fiche.
    • search string : Ne garde que les lignes dont le titre ou le texte contient ce texte, sans tenir compte de la casse (les accents, eux, comptent).
    • status string[] : Ne garde que les contenus à l'un de ces statuts (par exemple to_approve pour ce qui attend le client).Valeurs
      drafttododoingto_approveto_improveapprovedscheduledpublished
    • scheduled_after string : Ne garde que les contenus prévus ce jour-là ou après (AAAA-MM-JJ). Écarte les contenus sans date.
    • scheduled_before string : Ne garde que les contenus prévus ce jour-là ou avant (AAAA-MM-JJ). Écarte les contenus sans date.
    • limit integer : Combien de lignes rendre au plus (500 par défaut et au maximum).
    • offset integer : Combien de lignes sauter, pour aller chercher la suite de la liste.
    Rend object[]
    Chaque ligne porte
    • id string · toujours présent
    • client_id null|string · toujours présent
    • client_name null|string · toujours présent
    • title string · toujours présent
    • body null|string · toujours présent
    • tags string[] · toujours présent
    • status string · toujours présentValeurs
      publishedtododoingdraftto_approveto_improveapprovedscheduled
    • scheduled_on null|string · toujours présent
    • scheduled_time null|string · toujours présent
    • published_url null|string · toujours présent
    • published_at null|string · toujours présent
    • assignee_ids string[] · toujours présent
    • media object[] · toujours présent
      Forme 1 (au choix)
      • kind "file" · toujours présent
      • id string · toujours présent
      • file object · toujours présent
        • id string · toujours présent
        • client_id null|string · toujours présent
        • name string · toujours présent
        • mime_type string · toujours présent
        • size_bytes number · toujours présent
        • has_thumb boolean · toujours présent
        • folder_id null|string · toujours présent
        • shared_with_client boolean · toujours présent
        • created_by null|string · toujours présent
        • created_side string · toujours présentValeurs
          clientagency
        • created_at string · toujours présent
      Forme 2 (au choix)
      • kind "link" · toujours présent
      • id string · toujours présent
      • url string · toujours présent
    • comments object[] · toujours présent
      • id string · toujours présent
      • decision string|null · toujours présentValeurs
        approvedrejected
      • comment null|string · toujours présent
      • author_name string · toujours présent
      • author_side string · toujours présentValeurs
        clientagency
      • shared boolean · toujours présent
      • created_at string · toujours présent
    • created_by null|string · toujours présent
    • created_at string · toujours présent
    • updated_at string · toujours présent
    Lien vers ce point d'entrée
  • /api/v1/get_social_contentGET · POSTreadLecture. Un contenu et tout ce qui l'entoure : son texte, ses étiquettes, sa date de parution, ses assignés, ses visuels et les retours du client. Les visuels n'y sont que décrits (nom, type) : pour les VOIR, get_social_content_images.
    Paramètres
    • id string · obligatoire : Identifiant du contenu, tel que rendu par list_social_contents.
    Rend null|object
    Lien vers ce point d'entrée
  • /api/v1/get_social_content_imagesGET · POSTreadLecture. Les visuels d'un contenu, montrés EN IMAGES jointes à la réponse et non par des liens : à appeler pour juger un post sur ce qu'il montre (cadrage, texte incrusté, cohérence du carrousel). Quelques visuels par appel, dans l'ordre du carrousel, réduits à 1 568 px ; une vidéo se montre par sa vignette, un visuel cité par son adresse n'est pas téléchargé. « next_offset » dit où reprendre.
    Paramètres
    • id string · obligatoire : Identifiant du contenu, tel que rendu par list_social_contents.
    • offset integer · = 0 : Rang du premier visuel à montrer, en partant de 0. Pour voir la suite d'un carrousel.
    • limit integer · = 4 : Combien de visuels parcourir au plus (4 par défaut, 6 au maximum).
    Rend object
    Champs
    • content_id string · toujours présent
    • title string · toujours présent
    • total number · toujours présent
    • offset number · toujours présent
    • next_offset null|number · toujours présent
    • note string · toujours présent
    • images object[] · toujours présent
      • kind "inline_image" · toujours présent
      • mime_type string · toujours présent
      • data string · toujours présent
      • position number · toujours présent
      • file_id string · toujours présent
      • name string · toujours présent
      • source string · toujours présentValeurs
        originalthumb
      • width number · toujours présent
      • height number · toujours présent
    • skipped object[] · toujours présent
      • position number · toujours présent
      • name null|string · toujours présent
      • url string
      • reason string · toujours présent
    Lien vers ce point d'entrée
  • /api/v1/create_social_contentPOSTwriteÉcriture. Crée un contenu de publication. Le client est facultatif : une idée de post peut se noter avant sa destination, mais sans lui on ne cite que des visuels qui vivent ailleurs, un fichier déposé appartenant toujours à une fiche. « media » pose le carrousel dans l'ordre voulu : un visuel déposé s'y désigne par « file_id », un visuel cité par « url ». Poser le contenu d'emblée en « to_approve » invite les contacts du client à le relire.
    Paramètres
    • title string · obligatoire : Titre du contenu, 300 caractères au plus.
    • body string|null : Texte du post (la légende), 20 000 caractères au plus. null l'efface.
    • status string : Étape du contenu. Absent à la création : draft. Passer en to_approve invite les contacts du client à le relire.Valeurs
      drafttododoingto_approveto_improveapprovedscheduledpublished
    • tags string[] : Étiquettes au complet (40 caractères chacune, 20 au plus) : la liste remplace la précédente. Voir list_social_tags.
    • client_id string|null : Fiche client où le post paraîtra, telle que rendue par list_clients. null : aucune fiche (une idée notée avant sa destination).
    • scheduled_on string|null : Jour de parution, au format AAAA-MM-JJ. null retire la date.
    • scheduled_time string|null : Heure de parution HH:MM, à l'heure du compte où l'on publie (sans fuseau). Suppose un jour de parution ; null la retire.
    • published_url string|null : Adresse du post une fois en ligne, en http ou https. null la retire.
    • assignee_ids string[] : Comptes de l'équipe assignés, tels que rendus par list_task_members (20 au plus) : la liste remplace la précédente.
    • media object[] : Carrousel dans l'ordre voulu (20 visuels au plus) : chaque visuel est un fichier déposé (file_id) ou une adresse citée (url).
      Forme 1 (au choix)
      • file_id string · obligatoire : Visuel déposé et encore en attente, par l'identifiant que rend la préparation du dépôt (étape de l'écran, absente de l'API).
      Forme 2 (au choix)
      • url string · obligatoire : Adresse d'un visuel cité, hébergé ailleurs, en http ou https. Rien n'est téléchargé.
    Rend object
    Champs
    • id string · toujours présent
    • client_id null|string · toujours présent
    • client_name null|string · toujours présent
    • title string · toujours présent
    • body null|string · toujours présent
    • tags string[] · toujours présent
    • status string · toujours présentValeurs
      publishedtododoingdraftto_approveto_improveapprovedscheduled
    • scheduled_on null|string · toujours présent
    • scheduled_time null|string · toujours présent
    • published_url null|string · toujours présent
    • published_at null|string · toujours présent
    • assignee_ids string[] · toujours présent
    • media object[] · toujours présent
      Forme 1 (au choix)
      • kind "file" · toujours présent
      • id string · toujours présent
      • file object · toujours présent
        • id string · toujours présent
        • client_id null|string · toujours présent
        • name string · toujours présent
        • mime_type string · toujours présent
        • size_bytes number · toujours présent
        • has_thumb boolean · toujours présent
        • folder_id null|string · toujours présent
        • shared_with_client boolean · toujours présent
        • created_by null|string · toujours présent
        • created_side string · toujours présentValeurs
          clientagency
        • created_at string · toujours présent
      Forme 2 (au choix)
      • kind "link" · toujours présent
      • id string · toujours présent
      • url string · toujours présent
    • comments object[] · toujours présent
      • id string · toujours présent
      • decision string|null · toujours présentValeurs
        approvedrejected
      • comment null|string · toujours présent
      • author_name string · toujours présent
      • author_side string · toujours présentValeurs
        clientagency
      • shared boolean · toujours présent
      • created_at string · toujours présent
    • created_by null|string · toujours présent
    • created_at string · toujours présent
    • updated_at string · toujours présent
    Lien vers ce point d'entrée
  • /api/v1/update_social_contentPOSTwriteÉcriture. Modifie un contenu : titre, texte, étiquettes, statut, date et heure de parution, liens, assignation. Le faire passer en « to_approve » invite les contacts du client à le relire ; « approved », « to_improve » et le retour en production restent des états que l'agence pose, la réponse du client passant par son espace.
    Paramètres
    • title string : Titre du contenu, 300 caractères au plus. Absent : laissé tel quel.
    • body string|null : Texte du post (la légende), 20 000 caractères au plus. null l'efface.
    • status string : Étape du contenu. Absent à la création : draft. Passer en to_approve invite les contacts du client à le relire.Valeurs
      drafttododoingto_approveto_improveapprovedscheduledpublished
    • tags string[] : Étiquettes au complet (40 caractères chacune, 20 au plus) : la liste remplace la précédente. Voir list_social_tags.
    • client_id string|null : Fiche client où le post paraîtra, telle que rendue par list_clients. null : aucune fiche (une idée notée avant sa destination).
    • scheduled_on string|null : Jour de parution, au format AAAA-MM-JJ. null retire la date.
    • scheduled_time string|null : Heure de parution HH:MM, à l'heure du compte où l'on publie (sans fuseau). Suppose un jour de parution ; null la retire.
    • published_url string|null : Adresse du post une fois en ligne, en http ou https. null la retire.
    • assignee_ids string[] : Comptes de l'équipe assignés, tels que rendus par list_task_members (20 au plus) : la liste remplace la précédente.
    • id string · obligatoire : Identifiant du contenu, tel que rendu par list_social_contents.
    Rend object
    Champs
    • id string · toujours présent
    • client_id null|string · toujours présent
    • client_name null|string · toujours présent
    • title string · toujours présent
    • body null|string · toujours présent
    • tags string[] · toujours présent
    • status string · toujours présentValeurs
      publishedtododoingdraftto_approveto_improveapprovedscheduled
    • scheduled_on null|string · toujours présent
    • scheduled_time null|string · toujours présent
    • published_url null|string · toujours présent
    • published_at null|string · toujours présent
    • assignee_ids string[] · toujours présent
    • media object[] · toujours présent
      Forme 1 (au choix)
      • kind "file" · toujours présent
      • id string · toujours présent
      • file object · toujours présent
        • id string · toujours présent
        • client_id null|string · toujours présent
        • name string · toujours présent
        • mime_type string · toujours présent
        • size_bytes number · toujours présent
        • has_thumb boolean · toujours présent
        • folder_id null|string · toujours présent
        • shared_with_client boolean · toujours présent
        • created_by null|string · toujours présent
        • created_side string · toujours présentValeurs
          clientagency
        • created_at string · toujours présent
      Forme 2 (au choix)
      • kind "link" · toujours présent
      • id string · toujours présent
      • url string · toujours présent
    • comments object[] · toujours présent
      • id string · toujours présent
      • decision string|null · toujours présentValeurs
        approvedrejected
      • comment null|string · toujours présent
      • author_name string · toujours présent
      • author_side string · toujours présentValeurs
        clientagency
      • shared boolean · toujours présent
      • created_at string · toujours présent
    • created_by null|string · toujours présent
    • created_at string · toujours présent
    • updated_at string · toujours présent
    Lien vers ce point d'entrée
  • /api/v1/delete_social_contentPOSTdestructiveSuppression définitive, irréversible. Supprime définitivement un contenu, avec ses visuels et les retours du client qui l'accompagnent.
    Paramètres
    • id string · obligatoire : Identifiant du contenu, tel que rendu par list_social_contents.
    Rend object
    Champs
    • ok boolean · toujours présent
    Lien vers ce point d'entrée
  • /api/v1/add_social_commentPOSTwriteÉcriture. Écrit un commentaire de l'équipe sous un contenu, à n'importe quelle étape. Il n'emporte aucune décision : valider ou renvoyer un contenu reste le geste du client. Il n'est visible du client que si le contenu l'était déjà au moment où il est écrit ; sous un brouillon, il reste interne, et le contenu soumis plus tard ne le publie pas. Une mention s'écrit « [@Nom](mention:identifiant de compte) » et prévient la personne nommée si elle lira le commentaire : un membre de l'équipe toujours, un contact de la fiche seulement sur un commentaire qui lui est visible. Une autre personne redevient du simple texte.
    Paramètres
    • id string · obligatoire : Identifiant du contenu, tel que rendu par list_social_contents.
    • comment string · obligatoire : Texte du commentaire, non vide, 4000 caractères au plus. Une mention s'écrit [@Nom](mention:identifiant de compte).
    Rend object
    Champs
    • id string · toujours présent
    • client_id null|string · toujours présent
    • client_name null|string · toujours présent
    • title string · toujours présent
    • body null|string · toujours présent
    • tags string[] · toujours présent
    • status string · toujours présentValeurs
      publishedtododoingdraftto_approveto_improveapprovedscheduled
    • scheduled_on null|string · toujours présent
    • scheduled_time null|string · toujours présent
    • published_url null|string · toujours présent
    • published_at null|string · toujours présent
    • assignee_ids string[] · toujours présent
    • media object[] · toujours présent
      Forme 1 (au choix)
      • kind "file" · toujours présent
      • id string · toujours présent
      • file object · toujours présent
        • id string · toujours présent
        • client_id null|string · toujours présent
        • name string · toujours présent
        • mime_type string · toujours présent
        • size_bytes number · toujours présent
        • has_thumb boolean · toujours présent
        • folder_id null|string · toujours présent
        • shared_with_client boolean · toujours présent
        • created_by null|string · toujours présent
        • created_side string · toujours présentValeurs
          clientagency
        • created_at string · toujours présent
      Forme 2 (au choix)
      • kind "link" · toujours présent
      • id string · toujours présent
      • url string · toujours présent
    • comments object[] · toujours présent
      • id string · toujours présent
      • decision string|null · toujours présentValeurs
        approvedrejected
      • comment null|string · toujours présent
      • author_name string · toujours présent
      • author_side string · toujours présentValeurs
        clientagency
      • shared boolean · toujours présent
      • created_at string · toujours présent
    • created_by null|string · toujours présent
    • created_at string · toujours présent
    • updated_at string · toujours présent
    Lien vers ce point d'entrée
  • /api/v1/reorder_social_mediaPOSTwriteÉcriture. Range les visuels d'un contenu dans l'ordre du carrousel : « media_ids » est la liste complète, fichiers déposés et liens cités mêlés, dans l'ordre voulu, et le premier est celui que le réseau montrera sans qu'on clique. Refuse si la liste n'est pas exactement celle du contenu.
    Paramètres
    • id string · obligatoire : Identifiant du contenu, tel que rendu par list_social_contents.
    • media_ids string[] · obligatoire : Identifiants de tous les visuels du contenu (fichiers et liens mêlés, tels que rendus par get_social_content), dans l'ordre voulu.
    Rend object
    Champs
    • id string · toujours présent
    • client_id null|string · toujours présent
    • client_name null|string · toujours présent
    • title string · toujours présent
    • body null|string · toujours présent
    • tags string[] · toujours présent
    • status string · toujours présentValeurs
      publishedtododoingdraftto_approveto_improveapprovedscheduled
    • scheduled_on null|string · toujours présent
    • scheduled_time null|string · toujours présent
    • published_url null|string · toujours présent
    • published_at null|string · toujours présent
    • assignee_ids string[] · toujours présent
    • media object[] · toujours présent
      Forme 1 (au choix)
      • kind "file" · toujours présent
      • id string · toujours présent
      • file object · toujours présent
        • id string · toujours présent
        • client_id null|string · toujours présent
        • name string · toujours présent
        • mime_type string · toujours présent
        • size_bytes number · toujours présent
        • has_thumb boolean · toujours présent
        • folder_id null|string · toujours présent
        • shared_with_client boolean · toujours présent
        • created_by null|string · toujours présent
        • created_side string · toujours présentValeurs
          clientagency
        • created_at string · toujours présent
      Forme 2 (au choix)
      • kind "link" · toujours présent
      • id string · toujours présent
      • url string · toujours présent
    • comments object[] · toujours présent
      • id string · toujours présent
      • decision string|null · toujours présentValeurs
        approvedrejected
      • comment null|string · toujours présent
      • author_name string · toujours présent
      • author_side string · toujours présentValeurs
        clientagency
      • shared boolean · toujours présent
      • created_at string · toujours présent
    • created_by null|string · toujours présent
    • created_at string · toujours présent
    • updated_at string · toujours présent
    Lien vers ce point d'entrée
  • /api/v1/set_social_tag_colorPOSTwriteÉcriture. Donne une couleur à une étiquette de contenu, ou la lui reprend avec « color: null ». Six teintes : blue, violet, green, yellow, orange, red. La couleur appartient au mot et vaut partout où il est posé. Rend le vocabulaire à jour.
    Paramètres
    • tag string · obligatoire : L'étiquette, par son nom (40 caractères au plus). La casse ne compte pas : l'orthographe en usage est retrouvée.
    • color string|null · obligatoire : Teinte de l'étiquette, partout où elle est posée. null lui retire sa couleur.Valeurs
      bluevioletgreenyelloworangered
    Rend object[]
    Chaque ligne porte
    • tag string · toujours présent
    • count number · toujours présent
    • color string|nullValeurs
      bluevioletgreenyelloworangered
    Lien vers ce point d'entrée
  • /api/v1/add_social_tagPOSTwriteÉcriture. Ajoute une étiquette au vocabulaire des contenus sans la poser sur aucun : elle apparaît avec zéro contenu, prête à être choisie (une campagne préparée avant son premier post). Garde l'orthographe d'un mot déjà en usage, et ne fait rien si le mot est déjà déclaré. Rend le vocabulaire à jour.
    Paramètres
    • tag string · obligatoire : L'étiquette, par son nom (40 caractères au plus). La casse ne compte pas : l'orthographe en usage est retrouvée.
    Rend object[]
    Chaque ligne porte
    • tag string · toujours présent
    • count number · toujours présent
    • color string|nullValeurs
      bluevioletgreenyelloworangered
    Lien vers ce point d'entrée
  • /api/v1/delete_social_tagPOSTdestructiveSuppression définitive, irréversible. Retire une étiquette de tous les contenus qui la portent et du vocabulaire, et efface sa couleur. Rien ne se souvient de quels contenus la portaient. Rend le vocabulaire à jour.
    Paramètres
    • tag string · obligatoire : L'étiquette, par son nom (40 caractères au plus). La casse ne compte pas : l'orthographe en usage est retrouvée.
    Rend object[]
    Chaque ligne porte
    • tag string · toujours présent
    • count number · toujours présent
    • color string|nullValeurs
      bluevioletgreenyelloworangered
    Lien vers ce point d'entrée
  • /api/v1/list_social_tagsGET · POSTreadLecture. Le vocabulaire des étiquettes de contenus (le réseau, le format, la campagne) : celles déjà employées, avec le nombre de contenus qui les portent, puis celles ajoutées sans contenu (zéro), chacune avec sa couleur. Il n'y a pas d'autre catalogue.

    Aucun paramètre.

    Rend object[]
    Chaque ligne porte
    • tag string · toujours présent
    • count number · toujours présent
    • color string|nullValeurs
      bluevioletgreenyelloworangered
    Lien vers ce point d'entrée

social-views

  • /api/v1/list_social_viewsGET · POSTreadLecture. Vues enregistrées du calendrier de publication du compte au nom duquel la clé MCP agit, et laquelle s'ouvre par défaut.

    Aucun paramètre.

    Rend object
    Champs
    • views object[] · toujours présent
      • id string · toujours présent
      • name string · toujours présent
      • state object · toujours présent
        • filters object · toujours présent
          • search string · toujours présent
          • status string · toujours présentValeurs
            publishedlivetododoingalldraftto_approveto_improveapprovedscheduled
          • clientId null|string · toujours présent
          • assigneeId null|string · toujours présent
          • tags string[] · toujours présent
          • date string · toujours présentValeurs
            weekalltodaynonelate
          • also object
            • client string[]
            • status string[]
            • date string[]
            • assignee string[]
            • tag string[]
          • exclude string[]Valeurs
            clientstatusdateassigneetag
        • sort string · toujours présentValeurs
          titlestatuscreated-descdate-ascdate-desc
        • grouping string · toujours présentValeurs
          clientstatusdateassigneenonetag
        • layout string · toujours présentValeurs
          calendarlistboard
    • default_view_id null|string · toujours présent
    Lien vers ce point d'entrée
  • /api/v1/create_social_viewPOSTwriteÉcriture. Enregistre un jeu de filtres, de tri, de regroupement et d'affichage (liste, tableau ou calendrier) sous un nom, et peut en faire la vue ouverte par défaut.
    Paramètres
    • name string · obligatoire : Nom de la vue, 60 caractères au plus (espaces superflus retirés).
    • state object · obligatoire : Réglages enregistrés : filtres, tri, regroupement et affichage. Ce qui manque prend sa valeur neutre.
      • filters object · = {} : Les filtres de la barre ; un filtre absent ne filtre rien.
        • search string · = "" : Texte cherché dans le titre, le texte, le client et les étiquettes (200 caractères au plus). Vide : pas de recherche.
        • status string · = "live" : Étape retenue : live (tout ce qui n'est pas encore publié, par défaut), all (tout), ou un statut de contenu précis.Valeurs
          livealldrafttododoingto_approveto_improveapprovedscheduledpublished
        • clientId string|null · = null : Fiche client retenue, telle que rendue par list_clients. null : tous les clients.
        • assigneeId string|null · = null : Compte assigné retenu, tel que rendu par list_task_members. null : sans filtre sur l'assignation.
        • tags string[] : Étiquettes exigées, toutes à la fois (voir list_social_tags). Liste vide : sans filtre sur les étiquettes.
        • date string · = "all" : Portée de la date de parution : all, late (passée et non publiée), today, week (les 7 jours qui viennent), none (sans date).Valeurs
          alllatetodayweeknone
        • also object : Valeurs retenues EN PLUS de celle du champ d'origine, par dimension : la ligne passe si elle répond à l'une d'elles (status : une valeur de status ; client, assignee : un identifiant ; date : une valeur de date). Absent : une seule valeur par dimension.
          • status string[] : Valeurs de status retenues en plus de celle du champ d'origine. Absent : aucune.
          • client string[] : Valeurs de client retenues en plus de celle du champ d'origine. Absent : aucune.
          • assignee string[] : Valeurs de assignee retenues en plus de celle du champ d'origine. Absent : aucune.
          • date string[] : Valeurs de date retenues en plus de celle du champ d'origine. Absent : aucune.
        • exclude string[] : Dimensions lues à l'envers : la liste écarte ce qu'elles retiennent (« tout sauf ce client »). Pour les étiquettes : n'en porter aucune. Absent : aucune.Valeurs
          statusclienttagassigneedate
      • sort string · = "date-asc" : Tri : date-asc (parution la plus proche d'abord, par défaut), date-desc, status, created-desc (plus récents) ou title.Valeurs
        date-ascdate-descstatuscreated-desctitle
      • grouping string · = "date" : Regroupement : status, date (par défaut), client, tag, assignee, ou none pour une liste d'un seul tenant.Valeurs
        statusdateclienttagassigneenone
      • layout string · = "list" : Affichage : list (par défaut), board (tableau en colonnes) ou calendar.Valeurs
        listboardcalendar
    • makeDefault boolean · = false : true en fait aussi la vue qui s'ouvre par défaut. false par défaut.
    Rend object
    Champs
    • id string · toujours présent
    • name string · toujours présent
    • state object · toujours présent
      • filters object · toujours présent
        • search string · toujours présent
        • status string · toujours présentValeurs
          publishedlivetododoingalldraftto_approveto_improveapprovedscheduled
        • clientId null|string · toujours présent
        • assigneeId null|string · toujours présent
        • tags string[] · toujours présent
        • date string · toujours présentValeurs
          weekalltodaynonelate
        • also object
          • client string[]
          • status string[]
          • date string[]
          • assignee string[]
          • tag string[]
        • exclude string[]Valeurs
          clientstatusdateassigneetag
      • sort string · toujours présentValeurs
        titlestatuscreated-descdate-ascdate-desc
      • grouping string · toujours présentValeurs
        clientstatusdateassigneenonetag
      • layout string · toujours présentValeurs
        calendarlistboard
    Lien vers ce point d'entrée
  • /api/v1/update_social_viewPOSTwriteÉcriture. Renomme une vue enregistrée du calendrier de publication, remplace ses réglages, ou les deux.
    Paramètres
    • id string · obligatoire : Identifiant de la vue, tel que rendu par list_social_views.
    • name string : Nouveau nom, 60 caractères au plus. Absent : le nom reste. Il faut au moins name ou state.
    • state object : Nouveaux réglages, qui remplacent les précédents en entier. Absent : les réglages restent.
      • filters object · = {} : Les filtres de la barre ; un filtre absent ne filtre rien.
        • search string · = "" : Texte cherché dans le titre, le texte, le client et les étiquettes (200 caractères au plus). Vide : pas de recherche.
        • status string · = "live" : Étape retenue : live (tout ce qui n'est pas encore publié, par défaut), all (tout), ou un statut de contenu précis.Valeurs
          livealldrafttododoingto_approveto_improveapprovedscheduledpublished
        • clientId string|null · = null : Fiche client retenue, telle que rendue par list_clients. null : tous les clients.
        • assigneeId string|null · = null : Compte assigné retenu, tel que rendu par list_task_members. null : sans filtre sur l'assignation.
        • tags string[] : Étiquettes exigées, toutes à la fois (voir list_social_tags). Liste vide : sans filtre sur les étiquettes.
        • date string · = "all" : Portée de la date de parution : all, late (passée et non publiée), today, week (les 7 jours qui viennent), none (sans date).Valeurs
          alllatetodayweeknone
        • also object : Valeurs retenues EN PLUS de celle du champ d'origine, par dimension : la ligne passe si elle répond à l'une d'elles (status : une valeur de status ; client, assignee : un identifiant ; date : une valeur de date). Absent : une seule valeur par dimension.
          • status string[] : Valeurs de status retenues en plus de celle du champ d'origine. Absent : aucune.
          • client string[] : Valeurs de client retenues en plus de celle du champ d'origine. Absent : aucune.
          • assignee string[] : Valeurs de assignee retenues en plus de celle du champ d'origine. Absent : aucune.
          • date string[] : Valeurs de date retenues en plus de celle du champ d'origine. Absent : aucune.
        • exclude string[] : Dimensions lues à l'envers : la liste écarte ce qu'elles retiennent (« tout sauf ce client »). Pour les étiquettes : n'en porter aucune. Absent : aucune.Valeurs
          statusclienttagassigneedate
      • sort string · = "date-asc" : Tri : date-asc (parution la plus proche d'abord, par défaut), date-desc, status, created-desc (plus récents) ou title.Valeurs
        date-ascdate-descstatuscreated-desctitle
      • grouping string · = "date" : Regroupement : status, date (par défaut), client, tag, assignee, ou none pour une liste d'un seul tenant.Valeurs
        statusdateclienttagassigneenone
      • layout string · = "list" : Affichage : list (par défaut), board (tableau en colonnes) ou calendar.Valeurs
        listboardcalendar
    Rend object
    Champs
    • id string · toujours présent
    • name string · toujours présent
    • state object · toujours présent
      • filters object · toujours présent
        • search string · toujours présent
        • status string · toujours présentValeurs
          publishedlivetododoingalldraftto_approveto_improveapprovedscheduled
        • clientId null|string · toujours présent
        • assigneeId null|string · toujours présent
        • tags string[] · toujours présent
        • date string · toujours présentValeurs
          weekalltodaynonelate
        • also object
          • client string[]
          • status string[]
          • date string[]
          • assignee string[]
          • tag string[]
        • exclude string[]Valeurs
          clientstatusdateassigneetag
      • sort string · toujours présentValeurs
        titlestatuscreated-descdate-ascdate-desc
      • grouping string · toujours présentValeurs
        clientstatusdateassigneenonetag
      • layout string · toujours présentValeurs
        calendarlistboard
    Lien vers ce point d'entrée
  • /api/v1/delete_social_viewPOSTdestructiveSuppression définitive, irréversible. Supprime une vue enregistrée du calendrier. Les contenus ne bougent pas.
    Paramètres
    • id string · obligatoire : Identifiant de la vue, tel que rendu par list_social_views.
    Rend object
    Champs
    • ok boolean · toujours présent
    Lien vers ce point d'entrée
  • /api/v1/set_default_social_viewPOSTwriteÉcriture. Désigne la vue qui s'ouvre par défaut sur le calendrier de publication, ou n'en désigne plus aucune avec id nul.
    Paramètres
    • id string|null · obligatoire : Identifiant de la vue à ouvrir par défaut, tel que rendu par list_social_views. null : plus aucune.
    Rend object
    Champs
    • default_view_id null|string · toujours présent
    Lien vers ce point d'entrée

client-views

  • /api/v1/list_client_viewsGET · POSTreadLecture. Vues enregistrées de la liste des clients du compte au nom duquel la clé MCP agit, et laquelle s'ouvre par défaut.

    Aucun paramètre.

    Rend object
    Champs
    • views object[] · toujours présent
      • id string · toujours présent
      • name string · toujours présent
      • state object · toujours présent
        • filters object · toujours présent
          • search string · toujours présent
          • status string · toujours présentValeurs
            leadfirst-callform-sentauditsecond-callquote-draftquote-sentsignedbuildliveinactivelostallprospectscustomers
          • referrerId null|string · toujours présent
          • also object
            • status string[]
            • referrer string[]
          • exclude string[]Valeurs
            statusreferrer
        • sort string · toujours présentValeurs
          namestatuscreated-descupdated-desc
        • grouping string · toujours présentValeurs
          statusreferrernone
        • layout string · toujours présentValeurs
          listboard
    • default_view_id null|string · toujours présent
    Lien vers ce point d'entrée
  • /api/v1/create_client_viewPOSTwriteÉcriture. Enregistre une lecture de la liste des clients (étape ou phase du parcours, apporteur, recherche, tri, regroupement, liste ou pipeline en colonnes) sous un nom, et peut en faire la vue ouverte par défaut.
    Paramètres
    • name string · obligatoire : Nom de la vue, de 1 à 60 caractères, espaces superflus retirés.
    • state object · obligatoire : Réglages enregistrés : filtres, tri, regroupement et affichage.
      • filters object · = {} : Filtres de la barre, tous facultatifs : un filtre absent ne filtre pas.
        • search string · = "" : Recherche dans le nom, la société, la ville, l'e-mail, le téléphone, le SIRET et la TVA, sans casse. Vide : sans filtre.
        • status string · = "all" : Étape exigée : all (par défaut), prospects, customers, ou une étape du parcours client (voir set_client_status).Valeurs
          allprospectscustomersleadfirst-callform-sentauditsecond-callquote-draftquote-sentsignedbuildliveinactivelost
        • referrerId string|"none"|null · = null : Ne garde que les fiches de cet apporteur (list_referrers), ou none pour celles qui n'en ont pas. null : sans filtre.
        • also object : Valeurs retenues EN PLUS de celle du champ d'origine, par dimension : la ligne passe si elle répond à l'une d'elles (status : une valeur de status ; referrer : un identifiant d'apporteur ou none). Absent : une seule valeur par dimension.
          • status string[] : Valeurs de status retenues en plus de celle du champ d'origine. Absent : aucune.
          • referrer string[] : Valeurs de referrer retenues en plus de celle du champ d'origine. Absent : aucune.
        • exclude string[] : Dimensions lues à l'envers : la liste écarte ce qu'elles retiennent (« tout sauf ce client »). Pour les étiquettes : n'en porter aucune. Absent : aucune.Valeurs
          statusreferrer
      • sort string · = "updated-desc" : Tri : updated-desc (par défaut), name, status ou created-desc.Valeurs
        updated-descnamestatuscreated-desc
      • grouping string · = "none" : Regroupement : none (par défaut), status ou referrer.Valeurs
        nonestatusreferrer
      • layout string · = "list" : Affichage : list (par défaut) ou board (le pipeline en colonnes, regroupé par statut à défaut d'autre chose).Valeurs
        listboard
    • makeDefault boolean · = false : Vrai pour en faire aussi la vue ouverte par défaut. Faux par défaut.
    Rend object
    Champs
    • id string · toujours présent
    • name string · toujours présent
    • state object · toujours présent
      • filters object · toujours présent
        • search string · toujours présent
        • status string · toujours présentValeurs
          leadfirst-callform-sentauditsecond-callquote-draftquote-sentsignedbuildliveinactivelostallprospectscustomers
        • referrerId null|string · toujours présent
        • also object
          • status string[]
          • referrer string[]
        • exclude string[]Valeurs
          statusreferrer
      • sort string · toujours présentValeurs
        namestatuscreated-descupdated-desc
      • grouping string · toujours présentValeurs
        statusreferrernone
      • layout string · toujours présentValeurs
        listboard
    Lien vers ce point d'entrée
  • /api/v1/update_client_viewPOSTwriteÉcriture. Renomme une vue enregistrée de la liste des clients, remplace ses réglages, ou les deux.
    Paramètres
    • id string · obligatoire : Identifiant de la vue, tel que rendu par list_client_views.
    • name string : Nouveau nom, de 1 à 60 caractères. Absent : le nom ne change pas.
    • state object : Réglages qui remplacent les précédents en entier. Absent : ils ne changent pas.
      • filters object · = {} : Filtres de la barre, tous facultatifs : un filtre absent ne filtre pas.
        • search string · = "" : Recherche dans le nom, la société, la ville, l'e-mail, le téléphone, le SIRET et la TVA, sans casse. Vide : sans filtre.
        • status string · = "all" : Étape exigée : all (par défaut), prospects, customers, ou une étape du parcours client (voir set_client_status).Valeurs
          allprospectscustomersleadfirst-callform-sentauditsecond-callquote-draftquote-sentsignedbuildliveinactivelost
        • referrerId string|"none"|null · = null : Ne garde que les fiches de cet apporteur (list_referrers), ou none pour celles qui n'en ont pas. null : sans filtre.
        • also object : Valeurs retenues EN PLUS de celle du champ d'origine, par dimension : la ligne passe si elle répond à l'une d'elles (status : une valeur de status ; referrer : un identifiant d'apporteur ou none). Absent : une seule valeur par dimension.
          • status string[] : Valeurs de status retenues en plus de celle du champ d'origine. Absent : aucune.
          • referrer string[] : Valeurs de referrer retenues en plus de celle du champ d'origine. Absent : aucune.
        • exclude string[] : Dimensions lues à l'envers : la liste écarte ce qu'elles retiennent (« tout sauf ce client »). Pour les étiquettes : n'en porter aucune. Absent : aucune.Valeurs
          statusreferrer
      • sort string · = "updated-desc" : Tri : updated-desc (par défaut), name, status ou created-desc.Valeurs
        updated-descnamestatuscreated-desc
      • grouping string · = "none" : Regroupement : none (par défaut), status ou referrer.Valeurs
        nonestatusreferrer
      • layout string · = "list" : Affichage : list (par défaut) ou board (le pipeline en colonnes, regroupé par statut à défaut d'autre chose).Valeurs
        listboard
    Rend object
    Champs
    • id string · toujours présent
    • name string · toujours présent
    • state object · toujours présent
      • filters object · toujours présent
        • search string · toujours présent
        • status string · toujours présentValeurs
          leadfirst-callform-sentauditsecond-callquote-draftquote-sentsignedbuildliveinactivelostallprospectscustomers
        • referrerId null|string · toujours présent
        • also object
          • status string[]
          • referrer string[]
        • exclude string[]Valeurs
          statusreferrer
      • sort string · toujours présentValeurs
        namestatuscreated-descupdated-desc
      • grouping string · toujours présentValeurs
        statusreferrernone
      • layout string · toujours présentValeurs
        listboard
    Lien vers ce point d'entrée
  • /api/v1/delete_client_viewPOSTdestructiveSuppression définitive, irréversible. Supprime une vue enregistrée de la liste des clients. Les fiches ne bougent pas.
    Paramètres
    • id string · obligatoire : Identifiant de la vue, tel que rendu par list_client_views.
    Rend object
    Champs
    • ok true · toujours présent
    Lien vers ce point d'entrée
  • /api/v1/set_default_client_viewPOSTwriteÉcriture. Désigne la vue qui s'ouvre par défaut sur la liste des clients, ou n'en désigne plus aucune avec id nul.
    Paramètres
    • id string|null · obligatoire : Vue à ouvrir par défaut (list_client_views). null : plus aucune vue par défaut.
    Rend object
    Champs
    • default_view_id null|string · toujours présent
    Lien vers ce point d'entrée

meetings

  • /api/v1/list_meetingsGET · POSTreadLecture. Réunions enregistrées, de la plus récente à la plus ancienne, filtrables par fiche client (client_id), par texte (search, transcript compris) et par dates. Le transcript n'y figure pas, seule sa longueur.
    Paramètres
    • client_id string|null : Une fiche client : ses réunions seules. null : celles rattachées à aucune fiche.
    • search string : Ne garde que les lignes dont le titre, le résumé ou le transcript contient ce texte, sans tenir compte de la casse (les accents, eux, comptent).
    • started_after string : Ne garde que les réunions tenues ce jour-là ou après (AAAA-MM-JJ).
    • started_before string : Ne garde que les réunions tenues ce jour-là ou avant (AAAA-MM-JJ).
    • limit integer : Combien de lignes rendre au plus (300 par défaut et au maximum).
    • offset integer : Combien de lignes sauter, pour aller chercher la suite de la liste.
    Rend object[]
    Chaque ligne porte
    • id string · toujours présent
    • source string · toujours présent
    • external_id null|string · toujours présent
    • title string · toujours présent
    • locale string · toujours présent
    • started_at string · toujours présent
    • ended_at null|string · toujours présent
    • duration_seconds null|number · toujours présent
    • participants object[] · toujours présent
      • name string · toujours présent
      • email null|string · toujours présent
      • role null|string · toujours présent
      • organization null|string · toujours présent
    • tags string[] · toujours présent
    • summary null|string · toujours présent
    • transcript_chars number · toujours présent
    • created_at string · toujours présent
    • client_id null|string · toujours présent
    • client_name null|string · toujours présent
    Lien vers ce point d'entrée
  • /api/v1/get_meetingGET · POSTreadLecture. Une réunion et son résumé. Le transcript n'est rendu que si include_transcript vaut vrai, et par tranches : une heure de réunion pèse plusieurs dizaines de milliers de caractères. Tant que transcript_next_offset n'est pas nul, le transcript continue : rappeler l'outil avec transcript_offset égal à cette valeur pour la tranche suivante, jusqu'à null pour l'avoir lu en entier.
    Paramètres
    • id string · obligatoire : Identifiant de la réunion, tel que rendu par list_meetings.
    • include_transcript boolean · = false : Joindre le transcript, rendu par tranches s'il est long.
    • transcript_offset integer · = 0 : Où reprendre la lecture du transcript, en caractères : la valeur de transcript_next_offset rendue par l'appel précédent.
    Rend object
    Champs
    • created_at string · toujours présent
    • id string · toujours présent
    • locale string · toujours présent
    • client_id null|string · toujours présent
    • title string · toujours présent
    • tags string[] · toujours présent
    • source string · toujours présent
    • external_id null|string · toujours présent
    • started_at string · toujours présent
    • ended_at null|string · toujours présent
    • duration_seconds null|number · toujours présent
    • summary null|string · toujours présent
    • transcript_chars number · toujours présent
    • client_name null|string · toujours présent
    • participants object[] · toujours présent
      • name string · toujours présent
      • email null|string · toujours présent
      • role null|string · toujours présent
      • organization null|string · toujours présent
      • account null|object · toujours présent
        • user_id string · toujours présent
        • name string · toujours présent
        • side string · toujours présentValeurs
          clientagency
    • people object[] · toujours présent
      • user_id string · toujours présent
      • name string · toujours présent
      • email null|string · toujours présent
      • side string · toujours présentValeurs
        clientagency
    • meeting_url null|string · toujours présent
    • recording_url null|string · toujours présent
    • metadata Record<string, Json> · toujours présent
    • transcript null|string · toujours présent
    • api_key_name null|string · toujours présent
    • updated_at string · toujours présent
    Lien vers ce point d'entrée
  • /api/v1/create_meetingPOSTwriteÉcriture. Dépose le transcript d'une réunion et fait tout le travail qui suit, comme pour une réunion enregistrée par le bot : rattachement de la fiche client (déduit des participants et de ce qui se dit, ou posé par client_id), compte rendu, tâches que la réunion appelle et corrections qu'elle rend nécessaires sur ce qui existe déjà, ces deux dernières écrites en propositions qui attendent l'avis de l'équipe. Compte de quelques secondes à une minute. Rend la réunion, son compte rendu, l'issue (written, ou failed quand le modèle n'a pas répondu : la réunion reste et resummarize_meeting le redemande) et le nombre de propositions, qui se lisent ensuite par list_tasks et list_meeting_proposals avec le meeting_id rendu. Avec external_id, un second dépôt du même identifiant rend la réunion existante sans rien refaire.
    Paramètres
    • title string · obligatoire : Titre de la réunion.
    • transcript string · obligatoire : Transcript intégral, en texte. Une ligne par prise de parole, « [mm:ss] Nom: texte » quand l'outil source le permet : le locuteur et l'heure s'affichent alors sur la fiche.
    • started_at string|null : Début de la réunion, ISO 8601. Absent : l'heure de l'appel. À donner dès qu'on la connaît, c'est elle qui range la réunion et date les échéances des tâches proposées.
    • ended_at string|null : Fin de la réunion, ISO 8601.
    • participants object[] : Participants. Leur adresse e-mail rattache la réunion à la fiche client, et leur nom permet de confier une tâche proposée à un membre de l'équipe.
      • name string · obligatoire : Nom du participant, tel qu'il doit se lire sur la fiche et dans le compte rendu.
      • email string|null : Adresse e-mail du participant. Elle rattache la réunion à la fiche client et le reconnaît parmi l'équipe ou les contacts.
      • role string|null : Fonction du participant (gérant, responsable marketing...), quand on la connaît.
      • organization string|null : Entreprise ou structure du participant, quand on la connaît.
    • client_id string|null : Fiche client de la réunion. Absente, elle se déduit des participants et de ce qui se dit, comme pour une réunion enregistrée.
    • source string : Outil d'où vient le transcript (fireflies, zoom…). « import » par défaut.
    • external_id string|null : Identifiant de la réunion chez l'outil source. Un second dépôt du même couple source et external_id rend la réunion déjà déposée, sans rien réécrire ni refaire.
    Rend object
    Champs
    • id string · toujours présent
    • status string · toujours présentValeurs
      createdexisting
    • summary_outcome string · toujours présentValeurs
      failedwrittenskipped
    • title string · toujours présent
    • locale string · toujours présent
    • client_id null|string · toujours présent
    • client_name null|string · toujours présent
    • summary null|string · toujours présent
    • proposed_tasks number · toujours présent
    • proposed_changes number · toujours présent
    Lien vers ce point d'entrée
  • /api/v1/set_meeting_clientPOSTwriteÉcriture. Rattache une réunion à une fiche client, ou l'en détache avec client_id nul. À l'arrivée, le rattachement se déduit des adresses des participants ; cet outil sert à le corriger quand la déduction s'est tue ou s'est trompée.
    Paramètres
    • id string · obligatoire : Identifiant de la réunion, tel que rendu par list_meetings.
    • client_id string|null · obligatoire : Identifiant de la fiche client, tel que rendu par list_clients. null détache la réunion de toute fiche.
    Rend object
    Champs
    • ok boolean · toujours présent
    Lien vers ce point d'entrée
  • /api/v1/update_meeting_participantsPOSTwriteÉcriture. Remplace la liste des participants d'une réunion, pour corriger une personne mal reconnue ou en ajouter une oubliée. C'est la liste que le compte rendu lit pour nommer les gens et confier les tâches : appeler ensuite resummarize_meeting pour que le résumé et les propositions suivent.
    Paramètres
    • id string · obligatoire : Identifiant de la réunion, tel que rendu par list_meetings.
    • participants object[] · obligatoire : La liste complète, qui remplace la précédente : un participant absent de la liste en sort.
      • name string · obligatoire : Nom du participant, tel qu'il doit se lire sur la fiche et dans le compte rendu.
      • email string|null : Adresse e-mail du participant. Elle rattache la réunion à la fiche client et le reconnaît parmi l'équipe ou les contacts.
      • role string|null : Fonction du participant (gérant, responsable marketing...), quand on la connaît.
      • organization string|null : Entreprise ou structure du participant, quand on la connaît.
    Rend object
    Champs
    • participants number · toujours présent
    Lien vers ce point d'entrée
  • /api/v1/rename_meeting_speakersPOSTwriteÉcriture. Renomme des voix du transcript d'une réunion (« Intervenant B », ou une personne prise pour une autre) : toutes leurs lignes changent d'un coup, et les participants suivent (le nom donné y entre, celui qu'aucune voix ne porte plus en sort). Deux voix nommées pareil n'en font plus qu'une. Les voix se lisent dans le transcript de get_meeting avec include_transcript. Appeler ensuite resummarize_meeting pour que le résumé et les propositions suivent.
    Paramètres
    • id string · obligatoire : Identifiant de la réunion, tel que rendu par list_meetings.
    • renames object[] · obligatoire : Les voix à renommer, chacune avec son nouveau nom. Toutes leurs lignes du transcript changent d'un coup.
      • from string · obligatoire : La voix telle que le transcript l'écrit en tête de ses lignes.
      • to string · obligatoire : Son nom. Deux voix qui reçoivent le même nom n'en font plus qu'une, ce qui répare une personne coupée en deux.
    Rend object
    Champs
    • lines number · toujours présent
    • participants number · toujours présent
    Lien vers ce point d'entrée
  • /api/v1/resummarize_meetingPOSTwriteÉcriture. Réécrit le résumé d'une réunion à partir de son transcript et de ce que l'application sait de son client, en rattachant la fiche si personne ne l'a fait. Écrase le résumé précédent, et rend written, skipped (pas de transcript) ou failed.
    Paramètres
    • id string · obligatoire : Identifiant de la réunion, tel que rendu par list_meetings.
    Rend object
    Champs
    • outcome string · toujours présentValeurs
      failedwrittenskipped
    Lien vers ce point d'entrée
  • /api/v1/delete_meetingPOSTdestructiveSuppression définitive, irréversible. Supprime définitivement une réunion, son résumé et son transcript.
    Paramètres
    • id string · obligatoire : Identifiant de la réunion, tel que rendu par list_meetings.
    Rend object
    Champs
    • ok boolean · toujours présent
    Lien vers ce point d'entrée

meeting-transcriptions

  • /api/v1/create_meeting_transcriptionPOSTwriteÉcriture. Transcrit l'enregistrement audio ou vidéo d'une réunion tenue hors visio (rendez-vous en personne, appel téléphonique, export d'un autre outil) et en fait une réunion comme si le bot l'avait enregistrée. L'audio vient d'un lien public (audio_url : URL directe ou présignée, partage Dropbox ou Google Drive) ou d'un fichier des fichiers partagés (file_id). La reconnaissance tient le bruit et les mauvais micros, sépare les voix et détecte la langue (alternance comprise) ; les voix sont ensuite nommées d'après l'équipe, les contacts de la fiche, les participants annoncés et ce qui se dit. Puis vient tout le travail d'une réunion enregistrée : rattachement de la fiche client, compte rendu, tâches et corrections proposées. Rend la demande tout de suite (status transcribing) : le travail prend de quelques secondes à quelques minutes, et get_meeting_transcription dit quand la réunion est prête. Avec external_id, une seconde demande du même identifiant rend la première, même ratée, sans rien renvoyer.
    Paramètres
    • audio_url string : Lien http(s) public vers le fichier audio ou vidéo (mp3, m4a, wav, ogg, webm, mp4…), que le service de transcription télécharge lui-même : une URL présignée, un lien direct, un partage Dropbox ou Google Drive ouvert à qui a le lien (ramené au fichier automatiquement). Exclusif de file_id.
    • file_id string : Un fichier audio ou vidéo déjà déposé dans les fichiers partagés d'une fiche (voir get_client_file_board). Sa fiche devient celle de la réunion, sauf client_id contraire. Exclusif de audio_url.
    • upload_path string : Un enregistrement déposé sur l'écran Réunions, désigné par son chemin de stockage. Seul l'écran en produit (l'envoi passe par une autorisation qui n'est pas publiée) : un assistant ou un intégrateur donne audio_url ou file_id. Exclusif des deux.
    • title string : Titre de la réunion. Absent : un titre provisoire daté, que le compte rendu remplace par un vrai titre.
    • started_at string|null : Début de l'enregistrement, ISO 8601. Absent : l'heure de la demande. À donner dès qu'on la connaît, c'est elle qui range la réunion et date les échéances des tâches proposées ; la fin s'en déduit par la durée de l'audio.
    • participants object[] : Les personnes présentes, quand on les connaît. Elles aident à nommer les voix (l'équipe et les contacts de la fiche le sont déjà sans rien dire), et leur adresse e-mail rattache la réunion à la fiche client.
      • name string · obligatoire : Nom du participant, tel qu'il doit se lire sur la fiche et dans le compte rendu.
      • email string|null : Adresse e-mail du participant. Elle rattache la réunion à la fiche client et le reconnaît parmi l'équipe ou les contacts.
      • role string|null : Fonction du participant (gérant, responsable marketing...), quand on la connaît.
      • organization string|null : Entreprise ou structure du participant, quand on la connaît.
    • speakers_expected integer : Nombre EXACT de personnes qui parlent, seulement si on en est sûr : c'est une contrainte dure pour la séparation des voix, et un nombre faux la dégrade. Absent, elle compte seule.
    • language string : Langue parlée, quand on la connaît (fr, en, es…). Absente, elle est détectée sur l'audio, alternance de langues comprise.
    • vocabulary string[] : Mots que la reconnaissance doit bien entendre : noms de produits, de marques, de lieux, jargon (six mots au plus par expression). Les noms de l'équipe, de la fiche et de ses contacts y sont déjà. C'est ce qui aide le plus sur un audio bruité.
    • client_id string|null : Fiche client de la réunion. Absente, elle se déduit des participants et de ce qui se dit, comme pour une réunion enregistrée par le bot.
    • source string : Outil d'où vient l'enregistrement (dictaphone, zoom, telephone…). « audio » par défaut.
    • external_id string|null : Identifiant de l'enregistrement chez l'outil source. Une seconde demande du même couple source et external_id rend la première, sans retranscrire ni rien refaire.
    Rend object
    Champs
    • id string · toujours présent
    • status string · toujours présentValeurs
      faileddonetranscribingprocessing
    • error null|string · toujours présent
    • audio_origin string · toujours présentValeurs
      fileurlupload
    • file_id null|string · toujours présent
    • title null|string · toujours présent
    • client_id null|string · toujours présent
    • source string · toujours présent
    • external_id null|string · toujours présent
    • meeting_id null|string · toujours présent
    • created_at string · toujours présent
    • updated_at string · toujours présent
    • meeting null|object · toujours présent
      • id string · toujours présent
      • title string · toujours présent
      • locale string · toujours présent
      • client_id null|string · toujours présent
      • client_name null|string · toujours présent
      • summary null|string · toujours présent
      • proposed_tasks number · toujours présent
      • proposed_changes number · toujours présent
    Lien vers ce point d'entrée
  • /api/v1/get_meeting_transcriptionGET · POSTreadLecture. Où en est une transcription demandée par create_meeting_transcription : transcribing (chez le service), processing (Noki nomme les voix et écrit le compte rendu), done ou failed (avec le motif). Une fois done, rend aussi la réunion produite : son titre, sa langue, sa fiche client, son compte rendu et le nombre de tâches et de corrections proposées (meeting_id les retrouve dans get_meeting, list_tasks et list_meeting_proposals). La relire tant qu'elle n'est pas finie fait aussi relire le travail chez le service, ce qui rattrape un avis de fin perdu.
    Paramètres
    • id string · obligatoire : Identifiant de la demande, rendu par create_meeting_transcription.
    Rend object
    Champs
    • id string · toujours présent
    • status string · toujours présentValeurs
      faileddonetranscribingprocessing
    • error null|string · toujours présent
    • audio_origin string · toujours présentValeurs
      fileurlupload
    • file_id null|string · toujours présent
    • title null|string · toujours présent
    • client_id null|string · toujours présent
    • source string · toujours présent
    • external_id null|string · toujours présent
    • meeting_id null|string · toujours présent
    • created_at string · toujours présent
    • updated_at string · toujours présent
    • meeting null|object · toujours présent
      • id string · toujours présent
      • title string · toujours présent
      • locale string · toujours présent
      • client_id null|string · toujours présent
      • client_name null|string · toujours présent
      • summary null|string · toujours présent
      • proposed_tasks number · toujours présent
      • proposed_changes number · toujours présent
    Lien vers ce point d'entrée
  • /api/v1/list_meeting_transcriptionsGET · POSTreadLecture. Transcriptions d'enregistrements audio demandées, de la plus récente à la plus ancienne, avec leur état et la réunion produite (meeting_id).
    Paramètres
    • limit integer : Combien de lignes rendre au plus (100 par défaut et au maximum).
    • offset integer : Combien de lignes sauter, pour aller chercher la suite de la liste.
    Rend object[]
    Chaque ligne porte
    • id string · toujours présent
    • status string · toujours présentValeurs
      faileddonetranscribingprocessing
    • error null|string · toujours présent
    • audio_origin string · toujours présentValeurs
      fileurlupload
    • file_id null|string · toujours présent
    • title null|string · toujours présent
    • client_id null|string · toujours présent
    • source string · toujours présent
    • external_id null|string · toujours présent
    • meeting_id null|string · toujours présent
    • created_at string · toujours présent
    • updated_at string · toujours présent
    Lien vers ce point d'entrée

meeting-proposals

  • /api/v1/list_meeting_proposalsGET · POSTreadLecture. Modifications qu'une réunion propose sur une fiche client, une note ou une tâche existante : ce qu'on lit aujourd'hui, ce que la réunion dit d'y mettre, et le passage qui l'établit. Sans filtre, toutes ; sinon celles d'une réunion ou d'une fiche. Rien n'est encore écrit : chacune attend d'être acceptée ou jetée.
    Paramètres
    • meeting_id string : Identifiant de la réunion, tel que rendu par list_meetings : ne rend que ses propositions. Absent : toutes les réunions.
    • client_id string : Identifiant de la fiche client, tel que rendu par list_clients : ne rend que ses propositions. Absent : toutes les fiches.
    • limit integer : Combien de lignes rendre au plus (200 par défaut et au maximum).
    • offset integer : Combien de lignes sauter, pour aller chercher la suite de la liste.
    Rend object[]
    Chaque ligne porte
    • id string · toujours présent
    • meeting_id string · toujours présent
    • client_id null|string · toujours présent
    • target string · toujours présentValeurs
      clienttasknotedecisionclient_custom_value
    • operation string · toujours présentValeurs
      createupdate
    • target_id null|string · toujours présent
    • changes object[] · toujours présent
      • field string · toujours présent
      • before null|string · toujours présent
      • after string · toujours présent
    • evidence string · toujours présent
    • status string · toujours présentValeurs
      approvedrejectedpending
    • applied_id null|string · toujours présent
    • decided_at null|string · toujours présent
    • created_at string · toujours présent
    • target_name null|string · toujours présent
    Lien vers ce point d'entrée
  • /api/v1/approve_meeting_proposalPOSTwriteÉcriture. Accepte une proposition et applique la modification, par la même porte que l'écran (validation et règles comprises). changes corrige une valeur avant de l'accepter, champ par champ ; les champs absents gardent ce que la proposition portait. Refuse quand la valeur a changé depuis la réunion, force passe outre après relecture.
    Paramètres
    • id string · obligatoire : Identifiant de la proposition, tel que rendu par list_meeting_proposals.
    • changes object[] : Corrections à faire avant d'accepter, champ par champ. Absent : la proposition est acceptée telle quelle ; un champ non cité garde sa valeur proposée.
      • field string · obligatoire : Nom du champ à corriger, tel qu'il figure dans les changes de la proposition (list_meeting_proposals).
      • after string · obligatoire : La valeur à écrire à la place de celle proposée. Une chaîne vide efface la valeur du champ.
    • force boolean : true passe outre le refus levé quand la valeur a été changée à la main depuis la réunion. À n'envoyer qu'après avoir relu cet écart.
    Rend object
    Champs
    • ok boolean · toujours présent
    • applied_id null|string · toujours présent
    Lien vers ce point d'entrée
  • /api/v1/reject_meeting_proposalPOSTwriteÉcriture. Jette une proposition. Elle reste en base, marquée refusée, pour qu'un nouveau résumé de la même réunion ne la repropose pas.
    Paramètres
    • id string · obligatoire : Identifiant de la proposition, tel que rendu par list_meeting_proposals.
    Rend object
    Champs
    • ok boolean · toujours présent
    Lien vers ce point d'entrée

recall

  • /api/v1/list_meeting_recordingsGET · POSTreadLecture. Enregistrements de visio demandés à Recall : ce qui est prévu, en cours, terminé ou raté, du plus récent au plus ancien.
    Paramètres
    • limit integer : Combien de lignes rendre au plus (50 par défaut et au maximum).
    • offset integer : Combien de lignes sauter, pour aller chercher la suite de la liste.
    Rend object[]
    Chaque ligne porte
    • id string · toujours présent
    • meeting_url string · toujours présent
    • join_at null|string · toujours présent
    • status string · toujours présentValeurs
      faileddonescheduledrecordingcancelled
    • error null|string · toujours présent
    • meeting_id null|string · toujours présent
    • created_at string · toujours présent
    Lien vers ce point d'entrée
  • /api/v1/list_upcoming_meetingsGET · POSTreadLecture. Réunions en cours et à venir, de la plus proche à la plus lointaine, avec le lien de la visio pour y entrer. Elles viennent des agendas connectés et des enregistrements lancés à la main : une réunion sans lien de visio n'y figure pas, et ce qui est déjà terminé se lit par listMeetings.
    Paramètres
    • hours integer : Horizon en heures (24 par défaut, 336 au maximum). Ce qui est en cours est rendu quoi qu'il arrive.
    • limit integer : Combien de lignes rendre au plus (50 par défaut et au maximum).
    • offset integer : Combien de lignes sauter, pour aller chercher la suite de la liste.
    Rend object[]
    Chaque ligne porte
    • id string · toujours présent
    • title null|string · toujours présent
    • meeting_url string · toujours présent
    • join_at null|string · toujours présent
    • status string · toujours présentValeurs
      faileddonescheduledrecordingcancelled
    • origin string · toujours présentValeurs
      calendarmanualmeet
    • meeting_id null|string · toujours présent
    • created_at string · toujours présent
    Lien vers ce point d'entrée
  • /api/v1/start_meeting_recordingPOSTwriteÉcriture. Envoie un bot enregistrer une visio (Google Meet, Zoom, Teams). Sans join_at le bot part tout de suite, ce qui peut échouer faute de machine disponible : au-delà de dix minutes d'avance, l'arrivée est garantie. Une réunion déjà couverte rend le bot existant au lieu d'en créer un second.
    Paramètres
    • meeting_url string · obligatoire : Lien de la visio à enregistrer : Google Meet, Zoom ou Microsoft Teams.
    • join_at string|null : Heure d'arrivée du bot, instant ISO 8601 avec décalage ; absente ou null, il part tout de suite.
    • title string|null : Titre de la réunion ; absent, le compte rendu la nomme d'après ce qui s'y est dit.
    Rend object
    Champs
    • status string · toujours présentValeurs
      createdreused
    • recording object · toujours présent
      • id string · toujours présent
      • meeting_url string · toujours présent
      • join_at null|string · toujours présent
      • status string · toujours présentValeurs
        faileddonescheduledrecordingcancelled
      • error null|string · toujours présent
      • meeting_id null|string · toujours présent
      • created_at string · toujours présent
    Lien vers ce point d'entrée
  • /api/v1/start_instant_meetingPOSTwriteÉcriture. Ouvre une visio Google Meet et y envoie le bot dans la foulée. La salle est créée au nom de la personne dont l'agenda est connecté, n'est posée dans aucun agenda et n'invite personne : le lien rendu est celui à partager. Demande que cet agenda ait accordé l'ouverture de visio, ce qui se fait en le reconnectant.
    Paramètres
    • title string|null : Titre de la réunion ; absent, le compte rendu la nomme d'après ce qui s'y est dit.
    Rend object
    Champs
    • meeting_url string · toujours présent
    • recording object · toujours présent
      • id string · toujours présent
      • meeting_url string · toujours présent
      • join_at null|string · toujours présent
      • status string · toujours présentValeurs
        faileddonescheduledrecordingcancelled
      • error null|string · toujours présent
      • meeting_id null|string · toujours présent
      • created_at string · toujours présent
    Lien vers ce point d'entrée
  • /api/v1/cancel_meeting_recordingPOSTwriteÉcriture. Rappelle un bot, avant son départ ou pendant la visio. Un enregistrement en cours est perdu, il n'y a pas de reprise.
    Paramètres
    • id string · obligatoire : cancel_meeting_recording : l'enregistrement (id de list_meeting_recordings). get_meeting_recording_url : la réunion (list_meetings).
    Rend object
    Champs
    • id string · toujours présent
    • meeting_url string · toujours présent
    • join_at null|string · toujours présent
    • status string · toujours présentValeurs
      faileddonescheduledrecordingcancelled
    • error null|string · toujours présent
    • meeting_id null|string · toujours présent
    • created_at string · toujours présent
    Lien vers ce point d'entrée
  • /api/v1/get_meeting_recording_urlGET · POSTreadLecture. URL fraîche pour réécouter l'enregistrement d'une réunion, à partir de son identifiant. Ces liens expirent vite et Recall ne garde le média que quelques jours : la réponse vaut null passé ce délai.
    Paramètres
    • id string · obligatoire : cancel_meeting_recording : l'enregistrement (id de list_meeting_recordings). get_meeting_recording_url : la réunion (list_meetings).
    Rend object
    Champs
    • url null|string · toujours présent
    Lien vers ce point d'entrée

recall-calendar

  • /api/v1/list_calendar_connectionsGET · POSTreadLecture. Agendas connectés à l'enregistrement automatique : adresse Google autorisée, état de la connexion, pause éventuelle, dernière synchronisation.

    Aucun paramètre.

    Rend object[]
    Chaque ligne porte
    • id string · toujours présent
    • user_id string · toujours présent
    • platform_email null|string · toujours présent
    • status string · toujours présentValeurs
      pendingconnecteddisconnected
    • active boolean · toujours présent
    • error null|string · toujours présent
    • synced_at null|string · toujours présent
    • meet_auto_join boolean · toujours présent
    • meet_subscription_name null|string · toujours présent
    • meet_subscription_expire_at null|string · toujours présent
    • meet_error null|string · toujours présent
    • created_at string · toujours présent
    Lien vers ce point d'entrée
  • /api/v1/start_calendar_connectionPOSTwriteÉcriture. Ouvre une autorisation Google pour un agenda du compte appelant et rend l'adresse où se rendre. N'accorde rien par elle-même : il faut ensuite consentir chez Google pour que l'agenda soit connecté. Un compte peut connecter plusieurs agendas : sans « id », la connexion en ajoute un ; avec « id » (un agenda du compte), elle le reconnecte, ce qu'il faut pour un agenda qui ne se lit plus ou qui n'accepte pas encore l'écriture. « from » dit l'écran où ramène le retour (« integrations » par défaut, ou « calendar » pour l'Agenda) ; une agence qui n'a pas ouvert les Réunions connecte un agenda neuf en pause, sans bot.
    Paramètres
    • from string : Écran où ramène le retour de Google : integrations (défaut, onglet Réunions) ou calendar (l'Agenda).Valeurs
      integrationscalendar
    • id string : Agenda du compte à reconnecter, tel que list_calendar_connections le rend ; absent : en connecter un de plus.
    Rend object
    Champs
    • url string · toujours présent
    Lien vers ce point d'entrée
  • /api/v1/set_calendar_activePOSTwriteÉcriture. Suspend ou reprend l'enregistrement automatique d'un agenda. Les bots déjà planifiés ne sont pas rappelés, seule la suite est concernée.
    Paramètres
    • id string · obligatoire : Identifiant de l'agenda connecté, tel que list_calendar_connections le rend.
    • active boolean · obligatoire : Faux : met en pause l'enregistrement automatique des réunions prévues ; vrai le reprend.
    Rend object
    Champs
    • id string · toujours présent
    • user_id string · toujours présent
    • platform_email null|string · toujours présent
    • status string · toujours présentValeurs
      pendingconnecteddisconnected
    • active boolean · toujours présent
    • error null|string · toujours présent
    • synced_at null|string · toujours présent
    • meet_auto_join boolean · toujours présent
    • meet_subscription_name null|string · toujours présent
    • meet_subscription_expire_at null|string · toujours présent
    • meet_error null|string · toujours présent
    • created_at string · toujours présent
    Lien vers ce point d'entrée
  • /api/v1/set_meet_auto_joinPOSTwriteÉcriture. Allume ou éteint l'enregistrement des réunions Meet ouvertes hors agenda, pour un agenda connecté. Allumer pose l'abonnement Google s'il manque ; éteindre le laisse en place et se rallume aussitôt.
    Paramètres
    • id string · obligatoire : Identifiant de l'agenda connecté, tel que list_calendar_connections le rend.
    • enabled boolean · obligatoire : Vrai : enregistrer aussi les réunions Meet ouvertes hors agenda ; faux : ne plus le faire.
    Rend object
    Champs
    • id string · toujours présent
    • user_id string · toujours présent
    • platform_email null|string · toujours présent
    • status string · toujours présentValeurs
      pendingconnecteddisconnected
    • active boolean · toujours présent
    • error null|string · toujours présent
    • synced_at null|string · toujours présent
    • meet_auto_join boolean · toujours présent
    • meet_subscription_name null|string · toujours présent
    • meet_subscription_expire_at null|string · toujours présent
    • meet_error null|string · toujours présent
    • created_at string · toujours présent
    Lien vers ce point d'entrée
  • /api/v1/retry_meet_subscriptionPOSTwriteÉcriture. Repose l'abonnement Google aux réunions ouvertes hors agenda, après un échec. Sans effet quand l'abonnement est déjà en place et sain.
    Paramètres
    • id string · obligatoire : Identifiant de l'agenda connecté, tel que list_calendar_connections le rend.
    Rend object
    Champs
    • id string · toujours présent
    • user_id string · toujours présent
    • platform_email null|string · toujours présent
    • status string · toujours présentValeurs
      pendingconnecteddisconnected
    • active boolean · toujours présent
    • error null|string · toujours présent
    • synced_at null|string · toujours présent
    • meet_auto_join boolean · toujours présent
    • meet_subscription_name null|string · toujours présent
    • meet_subscription_expire_at null|string · toujours présent
    • meet_error null|string · toujours présent
    • created_at string · toujours présent
    Lien vers ce point d'entrée
  • /api/v1/disconnect_calendarPOSTdestructiveSuppression définitive, irréversible. Retire un agenda : Recall cesse de le suivre et la connexion disparaît. Il faudra repasser par l'autorisation Google pour la rétablir.
    Paramètres
    • id string · obligatoire : Identifiant de l'agenda connecté, tel que list_calendar_connections le rend.
    Rend object
    Champs
    • id string · toujours présent
    Lien vers ce point d'entrée

calendar-events

  • /api/v1/list_calendar_eventsGET · POSTreadLecture. Événements des agendas Google connectés du compte appelant entre deux instants ISO avec leur décalage (« from », « to » exclu, six semaines au plus) : titre, début et fin (jours compris pour un événement d'une journée, instants sinon), occupé ou disponible, lien Google et lien de visio, l'agenda qui le porte (« calendar_id »), s'il se modifie depuis Noki, le nombre d'invités et les fiches clients liées. Lus chez Google à la demande, jamais copiés ; un événement vu dans deux agendas n'apparaît qu'une fois. « calendars » dit l'état de chaque agenda (lu, à reconnecter, injoignable, écriture accordée ou non), « status » celui de l'ensemble.
    Paramètres
    • from string · obligatoire : Début de la fenêtre, instant ISO 8601 avec son décalage (« 2026-10-05T00:00:00+02:00 »).
    • to string · obligatoire : Fin de la fenêtre, exclue, même forme ; six semaines au plus après le début.
    Rend object
    Champs
    • status string · toujours présentValeurs
      okfailednot_connectedreconnectmodule_closed
    • email null|string · toujours présent
    • calendars object[] · toujours présent
      • id string · toujours présent
      • email null|string · toujours présent
      • status string · toujours présentValeurs
        okfailedreconnect
      • writable boolean · toujours présent
    • events object[] · toujours présent
      • id string · toujours présent
      • calendar_id string · toujours présent
      • title null|string · toujours présent
      • all_day boolean · toujours présent
      • start string · toujours présent
      • end string · toujours présent
      • busy boolean · toujours présent
      • html_link null|string · toujours présent
      • meeting_url null|string · toujours présent
      • editable boolean · toujours présent
      • guests number · toujours présent
      • client_ids string[] · toujours présent
      • recurring boolean · toujours présent
      • task_id null|string · toujours présent
    Lien vers ce point d'entrée
  • /api/v1/get_calendar_eventGET · POSTreadLecture. Fiche d'un événement d'un agenda connecté du compte appelant (« calendar_id », « event_id » tels que list_calendar_events les rend) : en plus de ce que la liste donne, la description en texte, le lieu, l'organisateur et chaque invité avec sa réponse.
    Paramètres
    • calendar_id string · obligatoire : Agenda connecté qui porte l'événement, le « calendar_id » rendu par list_calendar_events.
    • event_id string · obligatoire : Identifiant Google de l'événement ou de l'occurrence, tel que list_calendar_events le rend.
    Rend object
    Champs
    • id string · toujours présent
    • calendar_id string · toujours présent
    • title null|string · toujours présent
    • all_day boolean · toujours présent
    • start string · toujours présent
    • end string · toujours présent
    • busy boolean · toujours présent
    • html_link null|string · toujours présent
    • meeting_url null|string · toujours présent
    • editable boolean · toujours présent
    • guests number · toujours présent
    • client_ids string[] · toujours présent
    • recurring boolean · toujours présent
    • task_id null|string · toujours présent
    • description null|string · toujours présent
    • location null|string · toujours présent
    • organizer_email null|string · toujours présent
    • guest_list object[] · toujours présent
      • email string · toujours présent
      • name null|string · toujours présent
      • response string · toujours présentValeurs
        accepteddeclinedtentativeneedsAction
      • organizer boolean · toujours présent
      • self boolean · toujours présent
    Lien vers ce point d'entrée
  • /api/v1/create_calendar_eventPOSTwriteÉcriture. Crée un événement dans un agenda Google connecté du compte appelant (« calendar_id », ou le premier qui accepte l'écriture) et rend sa fiche. Toute la journée : « start » et « end » sont des jours, le dernier compris ; à l'heure : deux instants ISO avec décalage. « client_ids » lie l'événement à des fiches clients, « meet » ouvre une visio Google Meet. « recurrence » le répète : « frequency » (daily, weekdays du lundi au vendredi, weekly le même jour de la semaine, monthly à la même date, yearly), « interval » (2 : une période sur deux), et au plus une fin, « until » (un jour, compris) ou « count » (le nombre d'occurrences) ; un événement à l'heure qui se répète donne aussi « time_zone ». N'invite personne : les invités se posent ensuite par update_calendar_event et sa liste « guests », qui envoie les invitations.
    Paramètres
    • calendar_id string : Agenda connecté où l'écrire (list_calendar_connections) ; absent : le premier qui accepte l'écriture.
    • title string · obligatoire : Titre de l'événement, 300 caractères au plus.
    • all_day boolean · obligatoire : Vrai : un événement d'une ou plusieurs journées ; faux : à l'heure.
    • start string · obligatoire : Toute la journée : le premier jour, AAAA-MM-JJ. À l'heure : un instant ISO 8601 avec son décalage.
    • end string · obligatoire : Toute la journée : le dernier jour, compris, AAAA-MM-JJ. À l'heure : un instant ISO 8601 après le début.
    • time_zone string : Fuseau IANA d'affichage chez Google (« Europe/Paris ») ; requis pour un événement à l'heure qui se répète.
    • description string : Description de l'événement, en texte, 8000 caractères au plus.
    • location string : Lieu de l'événement, 1000 caractères au plus.
    • client_ids string[] : Fiches clients que l'événement concerne, telles que list_clients les rend (20 au plus).
    • meet boolean : Vrai : ouvrir une visio Google Meet avec l'événement.
    • recurrence object : Comment l'événement se répète ; absent, il est unique.
      • frequency string · obligatoire : Période : daily, weekdays (du lundi au vendredi), weekly (même jour), monthly (même date), yearly.Valeurs
        dailyweekdaysweeklymonthlyyearly
      • interval integer : Une occurrence toutes les N périodes (2 : une sur deux) ; absent, chaque période.
      • until string : Dernier jour où il peut avoir lieu, compris, au format AAAA-MM-JJ ; exclusif de count.
      • count integer : Nombre d'occurrences, la première comprise (730 au plus) ; exclusif de until.
    Rend object
    Champs
    • id string · toujours présent
    • calendar_id string · toujours présent
    • title null|string · toujours présent
    • all_day boolean · toujours présent
    • start string · toujours présent
    • end string · toujours présent
    • busy boolean · toujours présent
    • html_link null|string · toujours présent
    • meeting_url null|string · toujours présent
    • editable boolean · toujours présent
    • guests number · toujours présent
    • client_ids string[] · toujours présent
    • recurring boolean · toujours présent
    • task_id null|string · toujours présent
    • description null|string · toujours présent
    • location null|string · toujours présent
    • organizer_email null|string · toujours présent
    • guest_list object[] · toujours présent
      • email string · toujours présent
      • name null|string · toujours présent
      • response string · toujours présentValeurs
        accepteddeclinedtentativeneedsAction
      • organizer boolean · toujours présent
      • self boolean · toujours présent
    Lien vers ce point d'entrée
  • /api/v1/update_calendar_eventPOSTwriteÉcriture. Modifie un événement d'un agenda connecté : seuls les champs donnés changent. « all_day », « start » et « end » vont ensemble (le déplacer) ; « client_ids » remplace les fiches liées ; « guests » remplace la liste des invités (qui y entre reçoit une invitation, qui en sort une annulation) ; « meet » à vrai ouvre une visio s'il n'en a pas. Les invités sont prévenus de tout changement par Google. Refusé sur un événement dont on n'est pas l'organisateur, ou sur un agenda connecté en lecture seule.
    Paramètres
    • calendar_id string · obligatoire : Agenda connecté qui porte l'événement, le « calendar_id » rendu par list_calendar_events.
    • event_id string · obligatoire : Identifiant Google de l'événement ou de l'occurrence, tel que list_calendar_events le rend.
    • title string : Nouveau titre. Absent : laissé tel quel.
    • all_day boolean : Vrai : toute la journée, faux : à l'heure. Se donne avec start et end pour déplacer l'événement.
    • start string : Nouveau début, avec all_day et end : un jour AAAA-MM-JJ, ou un instant ISO 8601 avec décalage.
    • end string : Nouvelle fin, avec all_day et start : le dernier jour compris, ou un instant ISO 8601 après le début.
    • time_zone string : Fuseau IANA des nouvelles heures ; lu seulement avec all_day, start et end.
    • description string : Nouvelle description, en texte ; une chaîne vide l'efface. Absente : inchangée.
    • location string : Nouveau lieu ; une chaîne vide l'efface. Absent : inchangé.
    • client_ids string[] : Fiches clients liées (list_clients), la liste entière qui remplace l'ancienne ; vide les délie toutes.
    • meet boolean : Vrai : ouvrir une visio Google Meet si l'événement n'en a pas ; faux ne retire rien.
    • guests string[] : Adresses e-mail des invités, la liste entière : qui y entre est invité, qui en sort reçoit une annulation.
    Rend object
    Champs
    • id string · toujours présent
    • calendar_id string · toujours présent
    • title null|string · toujours présent
    • all_day boolean · toujours présent
    • start string · toujours présent
    • end string · toujours présent
    • busy boolean · toujours présent
    • html_link null|string · toujours présent
    • meeting_url null|string · toujours présent
    • editable boolean · toujours présent
    • guests number · toujours présent
    • client_ids string[] · toujours présent
    • recurring boolean · toujours présent
    • task_id null|string · toujours présent
    • description null|string · toujours présent
    • location null|string · toujours présent
    • organizer_email null|string · toujours présent
    • guest_list object[] · toujours présent
      • email string · toujours présent
      • name null|string · toujours présent
      • response string · toujours présentValeurs
        accepteddeclinedtentativeneedsAction
      • organizer boolean · toujours présent
      • self boolean · toujours présent
    Lien vers ce point d'entrée
  • /api/v1/delete_calendar_eventPOSTdestructiveSuppression définitive, irréversible. Supprime un événement d'un agenda connecté du compte appelant ; ses invités reçoivent l'annulation. Pour une occurrence d'une série, seule celle-ci disparaît, sauf avec « series » à vrai : toute la série part alors, occurrences passées et à venir. Rend l'identifiant de ce qui a été supprimé.
    Paramètres
    • calendar_id string · obligatoire : Agenda connecté qui porte l'événement, le « calendar_id » rendu par list_calendar_events.
    • event_id string · obligatoire : Identifiant Google de l'événement ou de l'occurrence, tel que list_calendar_events le rend.
    • series boolean : Vrai : supprimer toute la série dont event_id est une occurrence. Faux ou absent : cette occurrence seule.
    Rend object
    Champs
    • id string · toujours présent
    Lien vers ce point d'entrée

task-calendar-events

  • /api/v1/get_task_calendar_settingsGET · POSTreadLecture. Agendas Google connectés du compte appelant, tels qu'une tâche peut y entrer (« calendars »), et celui où entrent d'office les tâches qu'il cale à l'heure (« default_calendar_id », null si aucun). « status » vaut not_connected sans agenda connecté, module_closed quand l'agence n'a pas ouvert l'Agenda. Ne lit que la base, aucun appel à Google.

    Aucun paramètre.

    Rend object
    Champs
    • status string · toujours présentValeurs
      oknot_connectedmodule_closed
    • calendars object[] · toujours présent
      • id string · toujours présent
      • email null|string · toujours présent
    • default_calendar_id null|string · toujours présent
    Lien vers ce point d'entrée
  • /api/v1/set_task_calendar_defaultPOSTwriteÉcriture. Choisit l'agenda Google (« calendar_id », un des agendas du compte appelant) où entreront d'office les tâches qu'il calera à une heure de début, ou aucun (null). Un seul à la fois. « time_zone » (IANA, Europe/Paris par défaut) est le fuseau où se liront leurs heures. Ne touche à aucune tâche déjà calée.
    Paramètres
    • calendar_id string|null · obligatoire : Agenda du compte appelant où entrent d'office les tâches calées à l'heure (get_task_calendar_settings) ; null : aucun.
    • time_zone string : Fuseau IANA où se liront les heures de ces tâches (« Europe/Paris » par défaut).
    Rend object
    Champs
    • status string · toujours présentValeurs
      oknot_connectedmodule_closed
    • calendars object[] · toujours présent
      • id string · toujours présent
      • email null|string · toujours présent
    • default_calendar_id null|string · toujours présent
    Lien vers ce point d'entrée
  • /api/v1/get_task_calendar_eventGET · POSTreadLecture. Dit si une tâche est posée dans un agenda Google du compte appelant : « calendar_id » (null si elle n'y est pas), le lien Google de l'événement, et « timed », vrai quand la tâche a une heure de début, sans quoi elle ne peut pas y entrer.
    Paramètres
    • task_id string · obligatoire : Identifiant de la tâche, tel que list_tasks le rend.
    Rend object
    Champs
    • task_id string · toujours présent
    • timed boolean · toujours présent
    • calendar_id null|string · toujours présent
    • html_link null|string · toujours présent
    Lien vers ce point d'entrée
  • /api/v1/set_task_calendar_eventPOSTwriteÉcriture. Pose une tâche dans un agenda Google du compte appelant (« calendar_id ») ou l'en retire (null). La tâche doit avoir une heure de début : l'événement porte son titre, va de cette heure à l'heure d'échéance (ou dure la durée par défaut du compte), et a pour description le lien qui rouvre la tâche ; il n'invite personne. Il suit ensuite la tâche quand son titre ou ses heures changent, et part quand elle perd son heure ou est supprimée ; le déplacer chez Google ne déplace pas la tâche. La poser dans un autre agenda l'y déplace. « time_zone » (IANA) dit où se lisent ses heures.
    Paramètres
    • task_id string · obligatoire : Identifiant de la tâche, tel que list_tasks le rend.
    • calendar_id string|null · obligatoire : Agenda du compte appelant où poser la tâche (get_task_calendar_settings) ; null l'en retire.
    • time_zone string : Fuseau IANA où se lisent les heures de la tâche ; absent : celui déjà retenu, sinon « Europe/Paris ».
    Rend object
    Champs
    • task_id string · toujours présent
    • timed boolean · toujours présent
    • calendar_id null|string · toujours présent
    • html_link null|string · toujours présent
    Lien vers ce point d'entrée

questionnaires

  • /api/v1/list_questionnairesGET · POSTreadLecture. Questionnaires de l'agence, avec pour chacun son nombre de questions, d'envois et de réponses reçues.
    Paramètres
    • limit integer : Combien de lignes rendre au plus (200 par défaut et au maximum).
    • offset integer : Combien de lignes sauter, pour aller chercher la suite de la liste.
    Rend object[]
    Chaque ligne porte
    • id string · toujours présent
    • title string · toujours présent
    • description null|string · toujours présent
    • locale string · toujours présent
    • questions number · toujours présent
    • sent number · toujours présent
    • completed number · toujours présent
    • updated_at string · toujours présent
    Lien vers ce point d'entrée
  • /api/v1/get_questionnaireGET · POSTreadLecture. Un questionnaire et sa structure entière : sections, questions, options.
    Paramètres
    • id string · obligatoire : Identifiant du questionnaire, tel que rendu par list_questionnaires.
    Rend object
    Champs
    • id string · toujours présent
    • title string · toujours présent
    • description null|string · toujours présent
    • locale string · toujours présent
    • content object · toujours présent
      • sections object[] · toujours présent
        • key string · toujours présent
        • title string · toujours présent
        • hint string
        • showIf object
          • key string · toujours présent
          • anyOf string[] · toujours présent
        • questions object[] · toujours présent
          • key string · toujours présent
          • type string · toujours présentValeurs
            numbertexturlselectmultitextarea
          • label string · toujours présent
          • help string
          • placeholder string
          • otherPlaceholder string
          • required stringValeurs
            falsetrue
          • options object[]
            • key string · toujours présent
            • label string · toujours présent
            • other stringValeurs
              falsetrue
          • showIf object
            • key string · toujours présent
            • anyOf string[] · toujours présent
    • updated_at string · toujours présent
    Lien vers ce point d'entrée
  • /api/v1/upsert_questionnairePOSTwriteÉcriture. Crée ou modifie un questionnaire. Modifier ne touche à aucune réponse déjà reçue : chaque envoi garde la copie des questions telles qu'elles ont été posées.
    Paramètres
    • id string : Identifiant du questionnaire à modifier, tel que rendu par list_questionnaires. Absent : un questionnaire est créé.
    • title string · obligatoire : Titre du questionnaire, 200 caractères au plus.
    • description string : Présentation montrée au répondant, 1000 caractères au plus. Vide ou absente : aucune.
    • locale string · = "fr" : Langue dans laquelle le questionnaire est rédigé : fr, en ou es. Absente : fr.Valeurs
      frenes
    • content object · obligatoire : Structure complète du questionnaire. Chaque envoi déjà fait garde sa propre copie.
      • sections object[] · obligatoire : Sections du questionnaire, une étape chacune, dans l'ordre de lecture, 30 au plus.
        • key string · obligatoire : Clé de la section, unique dans le questionnaire : minuscules, chiffres et _, 40 caractères au plus.
        • title string · obligatoire : Titre de la section, 300 caractères au plus.
        • hint string : Phrase d'introduction sous le titre, 500 caractères au plus. Une adresse http(s) ou [texte](https://…) s'y affiche en lien cliquable. Absente : aucune.
        • showIf object : Condition d'affichage de toute la section, masquée si la réponse existe et ne correspond pas. Absente : toujours montrée.
          • key string · obligatoire : Clé d'une question posée plus haut, dont la réponse commande l'affichage.
          • anyOf string[] · obligatoire : Valeurs attendues, des clés d'options de cette question : il suffit que la réponse en contienne une.
        • questions object[] · obligatoire : Questions de la section, dans l'ordre de lecture, 60 au plus.
          • key string · obligatoire : Clé de la question, unique dans tout le questionnaire et sous laquelle sa réponse est rangée : minuscules, chiffres et _.
          • type string · obligatoire : Type de réponse : select (choix unique), multi (choix multiples), text, textarea, number ou url.Valeurs
            selectmultitexttextareanumberurl
          • label string · obligatoire : Intitulé de la question, 300 caractères au plus.
          • help string : Précision affichée sous l'intitulé, 500 caractères au plus. Une adresse http(s) ou [texte](https://…) s'y affiche en lien cliquable. Absente : aucune.
          • placeholder string : Texte indicatif du champ de saisie (text, textarea, number, url), 120 caractères au plus.
          • otherPlaceholder string : Texte indicatif du champ libre ouvert par l'option other. Absent : celui de la langue (« Précisez… »).
          • required boolean : Vrai : l'étape ne se franchit pas sans réponse à cette question. Absent : facultative.
          • options object[] : Options proposées, au moins une pour select et multi, ignorées des autres types.
            • key string · obligatoire : Clé stable de l'option, enregistrée dans la réponse : minuscules, chiffres et _, 40 caractères au plus.
            • label string · obligatoire : Libellé de l'option affiché au répondant.
            • other boolean : Vrai : choisir cette option ouvre un champ libre, enregistré sous <clé de la question>_other. Une option au plus par question.
          • showIf object : Condition d'affichage de la question. Absente : toujours posée.
            • key string · obligatoire : Clé d'une question posée plus haut, dont la réponse commande l'affichage.
            • anyOf string[] · obligatoire : Valeurs attendues, des clés d'options de cette question : il suffit que la réponse en contienne une.
    Rend object
    Champs
    • id string · toujours présent
    Lien vers ce point d'entrée
  • /api/v1/duplicate_questionnairePOSTwriteÉcriture. Copie un questionnaire sous un nouveau nom, pour en faire une variante qu'on modifie ensuite.
    Paramètres
    • id string · obligatoire : Identifiant du questionnaire à copier, tel que rendu par list_questionnaires.
    • title string · obligatoire : Titre de la copie, 200 caractères au plus.
    Rend object
    Champs
    • id string · toujours présent
    Lien vers ce point d'entrée
  • /api/v1/delete_questionnairePOSTdestructiveSuppression définitive, irréversible. Supprime un questionnaire de la bibliothèque. Les envois déjà faits restent lisibles.
    Paramètres
    • id string · obligatoire : Identifiant du questionnaire, tel que rendu par list_questionnaires.
    Rend object
    Champs
    • ok true · toujours présent
    Lien vers ce point d'entrée
  • /api/v1/send_questionnairePOSTwriteÉcriture. Envoie un questionnaire à un client : crée le lien à jeton et, sauf mention contraire, l'envoie par e-mail à l'adresse de la fiche.
    Paramètres
    • questionnaire_id string · obligatoire : Identifiant du questionnaire à envoyer, tel que rendu par list_questionnaires.
    • client_id string · obligatoire : Identifiant du client à qui la réponse appartiendra, tel que rendu par list_clients.
    • email string : Adresse à qui le lien est envoyé. Absente : celle de la fiche client.
    • notify boolean · = true : Faux : l'envoi est créé et son lien rendu, sans qu'aucun e-mail ne parte. Absent : vrai.
    Rend object
    Champs
    • id string · toujours présent
    • url string · toujours présent
    • sent boolean · toujours présent
    Lien vers ce point d'entrée
  • /api/v1/list_questionnaire_responsesGET · POSTreadLecture. Envois faits et où ils en sont, éventuellement filtrés sur un client ou un questionnaire.
    Paramètres
    • client_id string : Ne garder que les envois de ce client, tel que rendu par list_clients. Absent : tous.
    • questionnaire_id string : Ne garder que les envois de ce questionnaire, tel que rendu par list_questionnaires. Absent : tous.
    • limit integer : Combien de lignes rendre au plus (500 par défaut et au maximum).
    • offset integer : Combien de lignes sauter, pour aller chercher la suite de la liste.
    Rend object[]
    Chaque ligne porte
    • id string · toujours présent
    • client_id string · toujours présent
    • client_name null|string · toujours présent
    • questionnaire_id null|string · toujours présent
    • questionnaire_title string · toujours présent
    • email null|string · toujours présent
    • locale string · toujours présent
    • token string · toujours présent
    • sent_at null|string · toujours présent
    • opened_at null|string · toujours présent
    • completed_at null|string · toujours présent
    • updated_at string · toujours présent
    • answered number · toujours présent
    • total number · toujours présent
    Lien vers ce point d'entrée
  • /api/v1/get_questionnaire_responseGET · POSTreadLecture. Une réponse, question par question, telle qu'elle a été posée.
    Paramètres
    • id string · obligatoire : Identifiant de l'envoi (la réponse), tel que rendu par list_questionnaire_responses.
    Rend object
    Champs
    • response object · toujours présent
      • id string · toujours présent
      • client_id string · toujours présent
      • client_name null|string · toujours présent
      • questionnaire_id null|string · toujours présent
      • questionnaire_title string · toujours présent
      • email null|string · toujours présent
      • locale string · toujours présent
      • token string · toujours présent
      • sent_at null|string · toujours présent
      • opened_at null|string · toujours présent
      • completed_at null|string · toujours présent
      • created_at string · toujours présent
      • updated_at string · toujours présent
    • content object · toujours présent
      • sections object[] · toujours présent
        • key string · toujours présent
        • title string · toujours présent
        • hint string
        • showIf object
          • key string · toujours présent
          • anyOf string[] · toujours présent
        • questions object[] · toujours présent
          • key string · toujours présent
          • type string · toujours présentValeurs
            numbertexturlselectmultitextarea
          • label string · toujours présent
          • help string
          • placeholder string
          • otherPlaceholder string
          • required stringValeurs
            falsetrue
          • options object[]
            • key string · toujours présent
            • label string · toujours présent
            • other stringValeurs
              falsetrue
          • showIf object
            • key string · toujours présent
            • anyOf string[] · toujours présent
    • answers Record<string, string|number|string[]> · toujours présent
    Lien vers ce point d'entrée
  • /api/v1/delete_questionnaire_responsePOSTdestructiveSuppression définitive, irréversible. Supprime définitivement un envoi et les réponses qu'il portait.
    Paramètres
    • id string · obligatoire : Identifiant de l'envoi (la réponse), tel que rendu par list_questionnaire_responses.
    Rend object
    Champs
    • ok true · toujours présent
    Lien vers ce point d'entrée

client-forms

  • /api/v1/list_client_formsGET · POSTreadLecture. Formulaires d'une fiche client, avec pour chacun son état (ouvert ou brouillon), son nombre de champs, de réponses reçues et de réponses encore à traiter.
    Paramètres
    • client_id string · obligatoire : Identifiant du client dont on liste les formulaires, tel que rendu par list_clients.
    • limit integer : Combien de lignes rendre au plus (100 par défaut et au maximum).
    • offset integer : Combien de lignes sauter, pour aller chercher la suite de la liste.
    Rend object[]
    Chaque ligne porte
    • id string · toujours présent
    • client_id string · toujours présent
    • title string · toujours présent
    • description null|string · toujours présent
    • icon null|object · toujours présent
      Forme 1 (au choix)
      • kind "emoji" · toujours présent
      • emoji string · toujours présent
      Forme 2 (au choix)
      • kind "icon" · toujours présent
      • name string · toujours présentValeurs
        calendarstardocumentteambagcartshopboxprice-tagsalegiftdeliverycardmoneybillgallerycamerachecklistnotebookpenchatletterleafdropdropperbottlecosmeticflametest-tubeheartrocketlightbulbmap-pointshieldchartsettingsflagmedalglobetarget
      • tone string · toujours présentValeurs
        duotonemono
      • color stringValeurs
        bluevioletgreenyelloworangered
    • available boolean · toujours présent
    • field_count number · toujours présent
    • submission_count number · toujours présent
    • pending_count number · toujours présent
    • last_submitted_at null|string · toujours présent
    • updated_at string · toujours présent
    Lien vers ce point d'entrée
  • /api/v1/get_client_formGET · POSTreadLecture. Un formulaire client, son icône, ses sections et ses champs, dans l'ordre où le client les remplit (chaque champ nomme sa section par `section`).
    Paramètres
    • id string · obligatoire : Identifiant du formulaire, tel que rendu par list_client_forms.
    Rend object
    Champs
    • id string · toujours présent
    • client_id string · toujours présent
    • client_name null|string · toujours présent
    • title string · toujours présent
    • description null|string · toujours présent
    • icon null|object · toujours présent
      Forme 1 (au choix)
      • kind "emoji" · toujours présent
      • emoji string · toujours présent
      Forme 2 (au choix)
      • kind "icon" · toujours présent
      • name string · toujours présentValeurs
        calendarstardocumentteambagcartshopboxprice-tagsalegiftdeliverycardmoneybillgallerycamerachecklistnotebookpenchatletterleafdropdropperbottlecosmeticflametest-tubeheartrocketlightbulbmap-pointshieldchartsettingsflagmedalglobetarget
      • tone string · toujours présentValeurs
        duotonemono
      • color stringValeurs
        bluevioletgreenyelloworangered
    • available boolean · toujours présent
    • sections object[] · toujours présent
      • key string · toujours présent
      • title string · toujours présent
      • description string
    • fields object[] · toujours présent
      • key string · toujours présent
      • type string · toujours présentValeurs
        numberbooleanfileemaildatetexturlselecttextareacurrencyimage
      • label string · toujours présent
      • help string
      • placeholder string
      • required stringValeurs
        falsetrue
      • options object[]
        • key string · toujours présent
        • label string · toujours présent
      • currency stringValeurs
        EURUSDGBPCHFCAD
      • multiple stringValeurs
        falsetrue
      • section string
    • updated_at string · toujours présent
    Lien vers ce point d'entrée
  • /api/v1/upsert_client_formPOSTwriteÉcriture. Crée ou modifie un formulaire sur une fiche client. Un formulaire créé reste un brouillon que le client ne voit pas tant qu'on ne l'a pas ouvert ; modifier ne touche à aucune réponse reçue. `sections` range les champs en sections que le client remplit une à une, comme un questionnaire, la suivante ne s'ouvrant qu'une fois celle-ci complète (chaque champ nomme la sienne par `section`, la première à défaut ; vide : une seule page ; absent : on garde celles du formulaire). `icon` est un emoji (kind emoji, et le caractère dans emoji) ou un pictogramme de la maison (kind icon, son nom, tone duotone ou mono, et une teinte facultative) ; `null` le retire, absent n'y touche pas.
    Paramètres
    • id string : Identifiant du formulaire à modifier, tel que rendu par list_client_forms. Absent : un formulaire est créé.
    • client_id string · obligatoire : Identifiant du client, tel que rendu par list_clients. Lu à la création, ignoré ensuite : un formulaire ne change pas de client.
    • title string · obligatoire : Titre du formulaire, 200 caractères au plus.
    • description string : Présentation montrée au client, 1000 caractères au plus. Vide ou absente : aucune.
    • icon object|null : Icône du formulaire dans les listes : un emoji ou un pictogramme. null la retire, absente : inchangée.
      Forme 1 (au choix)
      • kind "emoji" · obligatoire : emoji : l'icône est un emoji.
      • emoji string · obligatoire : Un seul emoji, sans texte autour.
      Forme 2 (au choix)
      • kind "icon" · obligatoire : icon : l'icône est un pictogramme de la maison.
      • name string · obligatoire : Nom du pictogramme, parmi les quarante proposés (bag, star, rocket...).Valeurs
        bagcartshopboxprice-tagsalegiftdeliverycardmoneybillgallerycameradocumentchecklistnotebookpenchatletterleafdropdropperbottlecosmeticflametest-tubestarheartrocketlightbulbcalendarmap-pointteamshieldchartsettingsflagmedalglobetarget
      • tone string · obligatoire : duotone (la forme et un second ton) ou mono (une seule encre).Valeurs
        duotonemono
      • color string : Teinte du pictogramme : blue, violet, green, yellow, orange ou red. Absente : à l'encre.Valeurs
        bluevioletgreenyelloworangered
    • fields object[] · obligatoire : Champs du formulaire, dans l'ordre, 60 au plus ; ils remplacent les précédents en modification.
      • key string · obligatoire : Clé du champ, unique dans le formulaire et qui indexe sa réponse : minuscules, chiffres et _.
      • type string · obligatoire : Type de saisie : text, textarea, number, currency (montant), boolean, select, date, url, email, image (des photos) ou file (un document : PDF, ou une image du document).Valeurs
        texttextareanumbercurrencybooleanselectdateurlemailimagefile
      • label string · obligatoire : Libellé du champ, 300 caractères au plus.
      • help string : Précision sous le libellé (exemple, contrainte, format). Absente : aucune.
      • placeholder string : Texte indicatif du champ de saisie, 120 caractères au plus. Absent : aucun.
      • required boolean : Vrai : l'envoi ne part pas tant que ce champ est vide. Absent : facultatif.
      • options object[] : Choix proposés, au moins un pour un champ select, ignorés des autres types.
        • key string · obligatoire : Clé stable du choix, enregistrée dans la réponse : minuscules, chiffres et _, 40 caractères au plus.
        • label string · obligatoire : Libellé du choix affiché au client.
      • currency string : Devise d'un champ currency, en code ISO 4217. Absente : EUR.Valeurs
        EURUSDGBPCHFCAD
      • multiple boolean : Vrai : un champ image ou file accepte plusieurs fichiers (12 au plus). Absent : un seul.
      • section string : Clé de la section du champ, parmi sections. Inconnue ou absente : la première.
    • sections object[] : Sections parcourues une à une par le client, 20 au plus. Vide : une seule page. Absent : aucune à la création, inchangées ensuite.
      • key string · obligatoire : Clé de la section, unique dans le formulaire et reprise par le section de ses champs : minuscules, chiffres et _.
      • title string · obligatoire : Titre de la section, 200 caractères au plus.
      • description string : Phrase d'introduction de la section, 500 caractères au plus. Absente : aucune.
    • available boolean : Vrai : formulaire ouvert au client. Absent : fermé à la création, inchangé en modification.
    Rend object
    Champs
    • id string · toujours présent
    Lien vers ce point d'entrée
  • /api/v1/set_client_form_availabilityPOSTwriteÉcriture. Ouvre un formulaire au client (il apparaît dans son espace) ou le referme. Refermer ne supprime aucune réponse.
    Paramètres
    • id string · obligatoire : Identifiant du formulaire, tel que rendu par list_client_forms.
    • available boolean · obligatoire : Vrai pour ouvrir le formulaire au client (il doit avoir au moins un champ), faux pour le refermer sans rien supprimer.
    Rend object
    Champs
    • id string · toujours présent
    • available boolean · toujours présent
    Lien vers ce point d'entrée
  • /api/v1/delete_client_formPOSTdestructiveSuppression définitive, irréversible. Supprime définitivement un formulaire client, toutes ses réponses et les photos qu'elles portaient.
    Paramètres
    • id string · obligatoire : Identifiant du formulaire, tel que rendu par list_client_forms.
    Rend object
    Champs
    • ok true · toujours présent
    Lien vers ce point d'entrée
  • /api/v1/list_client_form_submissionsGET · POSTreadLecture. Réponses reçues à un formulaire client, de la plus récente à la plus ancienne, avec leurs valeurs, qui les a envoyées et si l'équipe les a traitées. Une image ou un fichier (PDF) y est le chemin de son dépôt : get_client_form_submission rend les liens pour le voir.
    Paramètres
    • form_id string · obligatoire : Identifiant du formulaire dont on liste les réponses, tel que rendu par list_client_forms.
    • limit integer : Combien de lignes rendre au plus (500 par défaut et au maximum).
    • offset integer : Combien de lignes sauter, pour aller chercher la suite de la liste.
    Rend object[]
    Chaque ligne porte
    • id string · toujours présent
    • form_id string · toujours présent
    • headline null|string · toujours présent
    • submitted_by_name null|string · toujours présent
    • handled_at null|string · toujours présent
    • created_at string · toujours présent
    • answers Record<string, string|number|false|true|string[]> · toujours présent
    Lien vers ce point d'entrée
  • /api/v1/get_client_form_submission_imagesGET · POSTreadLecture. Liens de lecture, valables une heure, des photos et fichiers (PDF) de toutes les réponses à un formulaire client (les mêmes réponses que la première page de list_client_form_submissions), indexés par le chemin que porte chaque réponse.
    Paramètres
    • id string · obligatoire : Identifiant du formulaire, tel que rendu par list_client_forms.
    Rend object
    Champs
    • urls Record<string, string> · toujours présent
    Lien vers ce point d'entrée
  • /api/v1/get_client_form_submissionGET · POSTreadLecture. Une réponse à un formulaire client, champ par champ telle qu'elle a été posée, avec des liens de lecture et de téléchargement de ses photos et fichiers (PDF, sous la même clé images) valables une heure.
    Paramètres
    • id string · obligatoire : Identifiant de la réponse, tel que rendu par list_client_form_submissions.
    Rend object
    Champs
    • submission object · toujours présent
      • id string · toujours présent
      • form_id string · toujours présent
      • form_title string · toujours présent
      • client_id string · toujours présent
      • headline null|string · toujours présent
      • submitted_by_name null|string · toujours présent
      • handled_at null|string · toujours présent
      • created_at string · toujours présent
    • fields object[] · toujours présent
      • key string · toujours présent
      • type string · toujours présentValeurs
        numberbooleanfileemaildatetexturlselecttextareacurrencyimage
      • label string · toujours présent
      • help string
      • placeholder string
      • required stringValeurs
        falsetrue
      • options object[]
        • key string · toujours présent
        • label string · toujours présent
      • currency stringValeurs
        EURUSDGBPCHFCAD
      • multiple stringValeurs
        falsetrue
      • section string
    • sections object[] · toujours présent
      • key string · toujours présent
      • title string · toujours présent
      • description string
    • answers Record<string, string|number|false|true|string[]> · toujours présent
    • images Record<string, object[]> · toujours présent
      • path string · toujours présent
      • url string · toujours présent
      • download_url string · toujours présent
    Lien vers ce point d'entrée
  • /api/v1/set_client_form_submission_handledPOSTwriteÉcriture. Marque une réponse comme traitée par l'équipe (le produit est en ligne, par exemple), ou la remet à traiter.
    Paramètres
    • id string · obligatoire : Identifiant de la réponse, tel que rendu par list_client_form_submissions.
    • handled boolean · obligatoire : Vrai : la réponse est marquée traitée, horodatée à l'instant. Faux : elle redevient à traiter.
    Rend object
    Champs
    • id string · toujours présent
    • handled_at null|string · toujours présent
    Lien vers ce point d'entrée
  • /api/v1/delete_client_form_submissionPOSTdestructiveSuppression définitive, irréversible. Supprime définitivement une réponse à un formulaire client, ses photos et ses fichiers.
    Paramètres
    • id string · obligatoire : Identifiant de la réponse, tel que rendu par list_client_form_submissions.
    Rend object
    Champs
    • ok true · toujours présent
    Lien vers ce point d'entrée

credentials

  • /api/v1/get_credential_boardGET · POSTreadLecture. Identifiants déposés pour un client et demandes en cours. Les secrets restent chiffrés et ne sont jamais rendus ici.
    Paramètres
    • client_id string : Fiche client concernée, telle que rendue par list_clients. Requise côté agence.
    Rend object
    Champs
    • credentials object[] · toujours présent
      • id string · toujours présent
      • client_id string · toujours présent
      • label string · toujours présent
      • type string · toujours présentValeurs
        loginapi_key
      • key_version number · toujours présent
      • created_by null|string · toujours présent
      • created_side string · toujours présentValeurs
        clientagency
      • created_at string · toujours présent
      • updated_at string · toujours présent
    • requests object[] · toujours présent
      • id string · toujours présent
      • client_id string · toujours présent
      • label string · toujours présent
      • type string · toujours présentValeurs
        loginapi_key
      • message null|string · toujours présent
      • status string · toujours présentValeurs
        opencancelleddeclinedfulfilled
      • requested_side string · toujours présentValeurs
        clientagency
      • requested_by_label string · toujours présent
      • fulfilled_credential_id null|string · toujours présent
      • created_at string · toujours présent
      • updated_at string · toujours présent
    • events object[] · toujours présent
      • id string · toujours présent
      • credential_id string · toujours présent
      • credential_label string · toujours présent
      • event string · toujours présentValeurs
        createdupdatedrevealeddeletedrekeyed
      • actor_side string · toujours présentValeurs
        clientagency
      • actor_label string · toujours présent
      • created_at string · toujours présent
    • side string · toujours présentValeurs
      clientagency
    • key_available boolean · toujours présent
    Lien vers ce point d'entrée
  • /api/v1/create_credentialPOSTwriteÉcriture. Dépose un identifiant chiffré pour un client. Le secret transite par la conversation : préférer l'écran quand c'est possible.
    Paramètres
    • client_id string : Fiche client concernée, telle que rendue par list_clients. Requise côté agence.
    • label string · obligatoire : Nom de l'identifiant tel qu'il s'affiche dans la liste (Back-office Shopify...).
    • type string · obligatoire : Forme de l'identifiant : login (identifiant et mot de passe) ou api_key (clé d'API). Décide des valeurs requises.Valeurs
      loginapi_key
    • values object · obligatoire : Les valeurs de l'identifiant, chiffrées en base. Les champs étrangers au type sont écartés.
      • url string : Adresse du service ou de sa page de connexion. Facultative pour les deux types.
      • username string : Identifiant ou e-mail de connexion. Requis pour le type login, ignoré pour api_key.
      • password string : Mot de passe du compte. Requis pour le type login, ignoré pour api_key.
      • key string : Clé d'API. Requise pour le type api_key, ignorée pour login.
      • secret string : Seconde moitié d'un couple de clés, quand l'API en délivre une. Type api_key seulement, facultative.
      • notes string : Notes libres sur l'accès (périmètre, contact, procédure). Facultatives pour les deux types.
    • request_id string : Demande ouverte à laquelle ce dépôt répond, telle que rendue par get_credential_board ; elle passe alors satisfaite.
    Rend object
    Champs
    • id string · toujours présent
    • client_id string · toujours présent
    • label string · toujours présent
    • type string · toujours présentValeurs
      loginapi_key
    • key_version number · toujours présent
    • created_by null|string · toujours présent
    • created_side string · toujours présentValeurs
      clientagency
    • created_at string · toujours présent
    • updated_at string · toujours présent
    Lien vers ce point d'entrée
  • /api/v1/update_credentialPOSTwriteÉcriture. Modifie un identifiant déposé. Remplacer le secret écrase l'ancien sans recours.
    Paramètres
    • id string · obligatoire : Identifiant de l'accès partagé, tel que rendu par get_credential_board.
    • label string : Nouveau nom affiché dans la liste. Absent : laissé tel quel.
    • values object : Toutes les valeurs, réécrites en bloc selon le type existant : un champ omis est vidé. Absent : laissées telles quelles.
      • url string : Adresse du service ou de sa page de connexion. Facultative pour les deux types.
      • username string : Identifiant ou e-mail de connexion. Requis pour le type login, ignoré pour api_key.
      • password string : Mot de passe du compte. Requis pour le type login, ignoré pour api_key.
      • key string : Clé d'API. Requise pour le type api_key, ignorée pour login.
      • secret string : Seconde moitié d'un couple de clés, quand l'API en délivre une. Type api_key seulement, facultative.
      • notes string : Notes libres sur l'accès (périmètre, contact, procédure). Facultatives pour les deux types.
    Rend object
    Champs
    • id string · toujours présent
    • client_id string · toujours présent
    • label string · toujours présent
    • type string · toujours présentValeurs
      loginapi_key
    • key_version number · toujours présent
    • created_by null|string · toujours présent
    • created_side string · toujours présentValeurs
      clientagency
    • created_at string · toujours présent
    • updated_at string · toujours présent
    Lien vers ce point d'entrée
  • /api/v1/delete_credentialPOSTdestructiveSuppression définitive, irréversible. Supprime définitivement un identifiant déposé.
    Paramètres
    • id string · obligatoire : Identifiant de l'accès partagé, tel que rendu par get_credential_board.
    Rend void
    Lien vers ce point d'entrée
  • /api/v1/create_credential_requestPOSTwriteÉcriture. Demande un identifiant à un client. Aucun secret n'entre ici, seulement la demande.
    Paramètres
    • client_id string : Fiche client concernée, telle que rendue par list_clients. Requise côté agence.
    • label string · obligatoire : Nom de l'accès demandé, repris par l'identifiant qui y répondra (Back-office Shopify...).
    • type string · obligatoire : Forme attendue : login (identifiant et mot de passe) ou api_key (clé d'API).Valeurs
      loginapi_key
    • message string : Précisions pour qui reçoit la demande (compte voulu, droits nécessaires). Absent ou vide : aucune.
    Rend object
    Champs
    • id string · toujours présent
    • client_id string · toujours présent
    • label string · toujours présent
    • type string · toujours présentValeurs
      loginapi_key
    • message null|string · toujours présent
    • status string · toujours présentValeurs
      opencancelleddeclinedfulfilled
    • requested_side string · toujours présentValeurs
      clientagency
    • requested_by_label string · toujours présent
    • fulfilled_credential_id null|string · toujours présent
    • created_at string · toujours présent
    • updated_at string · toujours présent
    Lien vers ce point d'entrée
  • /api/v1/close_credential_requestPOSTwriteÉcriture. Clôt une demande d'identifiant.
    Paramètres
    • id string · obligatoire : Identifiant de la demande ouverte, tel que rendu par get_credential_board.
    • status string · obligatoire : declined : refusée par qui recevait la demande ; cancelled : annulée par qui l'avait faite.Valeurs
      declinedcancelled
    Rend object
    Champs
    • id string · toujours présent
    • client_id string · toujours présent
    • label string · toujours présent
    • type string · toujours présentValeurs
      loginapi_key
    • message null|string · toujours présent
    • status string · toujours présentValeurs
      opencancelleddeclinedfulfilled
    • requested_side string · toujours présentValeurs
      clientagency
    • requested_by_label string · toujours présent
    • fulfilled_credential_id null|string · toujours présent
    • created_at string · toujours présent
    • updated_at string · toujours présent
    Lien vers ce point d'entrée
  • /api/v1/get_key_rotation_statusGET · POSTreadLecture. État du chiffrement des identifiants : version de clé en service et nombre de secrets restant à re-chiffrer.

    Aucun paramètre.

    Rend object
    Champs
    • current null|number · toujours présent
    • available number[] · toujours présent
    • counts object[] · toujours présent
      • version number · toujours présent
      • count number · toujours présent
    • orphaned number[] · toujours présent
    Lien vers ce point d'entrée

bills

  • /api/v1/list_client_billsGET · POSTreadLecture. Factures adressées à un client : numéro, date d'émission, total TVA comprise, TVA, nom du PDF. Aucune URL n'est rendue ici.
    Paramètres
    • client_id string : Fiche client dont on lit les factures, telle que rendue par list_clients. Requise côté agence.
    • limit integer : Combien de lignes rendre au plus (500 par défaut et au maximum).
    • offset integer : Combien de lignes sauter, pour aller chercher la suite de la liste.
    Rend object[]
    Chaque ligne porte
    • id string · toujours présent
    • client_id string · toujours présent
    • number string · toujours présent
    • issued_on string · toujours présent
    • due_on null|string · toujours présent
    • paid_on null|string · toujours présent
    • total_cents number · toujours présent
    • vat_cents number · toujours présent
    • file_name string · toujours présent
    • size_bytes number · toujours présent
    • created_at string · toujours présent
    Lien vers ce point d'entrée
  • /api/v1/create_client_billPOSTwriteÉcriture. Enregistre une facture pour un client et pousse son PDF, attendu en data URL complète. Le numéro, la date d'émission et les montants en centimes sont affirmés par l'appelant : l'écran, lui, les lit dans le document et les fait valider.
    Paramètres
    • client_id string · obligatoire : Identifiant de la fiche client facturée, tel que rendu par list_clients.
    • number string · obligatoire : Numéro de la facture, recopié du document.
    • issued_on string · obligatoire : Date d'émission imprimée sur la facture, au format AAAA-MM-JJ.
    • due_on string|null : Date d'échéance, au format AAAA-MM-JJ, pas avant l'émission. Absente ou null : la facture n'en porte pas.
    • total_cents integer · obligatoire : Total TTC de la facture, en centimes d'euro (12000 pour 120,00 €).
    • vat_cents integer · obligatoire : Montant de TVA compris dans le total, en centimes d'euro ; jamais plus que le total.
    • file_name string · obligatoire : Nom d'origine du fichier PDF, repris au téléchargement. Coupé à 200 caractères.
    • data_url string · obligatoire : Le PDF entier en data URL (data:application/pdf;base64,...), 3 Mo au plus.
    Rend object
    Champs
    • id string · toujours présent
    • client_id string · toujours présent
    • number string · toujours présent
    • issued_on string · toujours présent
    • due_on null|string · toujours présent
    • paid_on null|string · toujours présent
    • total_cents number · toujours présent
    • vat_cents number · toujours présent
    • file_name string · toujours présent
    • size_bytes number · toujours présent
    • created_at string · toujours présent
    Lien vers ce point d'entrée
  • /api/v1/set_client_bill_due_datePOSTwriteÉcriture. Pose ou corrige l'échéance d'une facture déjà déposée, `null` l'effaçant. C'est la seule valeur d'une facture enregistrée qui se modifie : les autres recopient un document immuable. Une échéance antérieure à la date d'émission est refusée.
    Paramètres
    • id string · obligatoire : Identifiant de la facture, tel que rendu par list_client_bills.
    • due_on string|null · obligatoire : Nouvelle échéance, au format AAAA-MM-JJ, pas avant l'émission. null retire l'échéance.
    Rend object
    Champs
    • id string · toujours présent
    • client_id string · toujours présent
    • number string · toujours présent
    • issued_on string · toujours présent
    • due_on null|string · toujours présent
    • paid_on null|string · toujours présent
    • total_cents number · toujours présent
    • vat_cents number · toujours présent
    • file_name string · toujours présent
    • size_bytes number · toujours présent
    • created_at string · toujours présent
    Lien vers ce point d'entrée
  • /api/v1/set_client_bill_payment_datePOSTwriteÉcriture. Indique qu'une facture a été réglée, à la date où l'agence l'a constaté, `null` la remettant en attente. C'est la seule valeur d'une facture qui ne vienne pas du document : une facture est émise avant d'être payée. Une date antérieure à la date d'émission est refusée, et le client n'en est pas averti.
    Paramètres
    • id string · obligatoire : Identifiant de la facture, tel que rendu par list_client_bills.
    • paid_on string|null · obligatoire : Jour du règlement constaté, au format AAAA-MM-JJ, pas avant l'émission. null remet la facture en attente.
    Rend object
    Champs
    • id string · toujours présent
    • client_id string · toujours présent
    • number string · toujours présent
    • issued_on string · toujours présent
    • due_on null|string · toujours présent
    • paid_on null|string · toujours présent
    • total_cents number · toujours présent
    • vat_cents number · toujours présent
    • file_name string · toujours présent
    • size_bytes number · toujours présent
    • created_at string · toujours présent
    Lien vers ce point d'entrée
  • /api/v1/delete_client_billPOSTdestructiveSuppression définitive, irréversible. Retire définitivement une facture de la fiche d'un client, et son PDF avec. N'annule rien en comptabilité : ce qui annule une facture est un avoir, qui se dépose comme le document qu'il est.
    Paramètres
    • id string · obligatoire : Identifiant de la facture, tel que rendu par list_client_bills.
    Rend object
    Champs
    • id string · toujours présent
    Lien vers ce point d'entrée

metrics

  • /api/v1/list_client_metricsGET · POSTreadLecture. Mesures (KPI) suivies pour un client, chacune avec tous ses relevés : nom, unité, sens favorable, façon de réunir les relevés, décimales, puis les valeurs avec la période qu'elles couvrent et leurs notes.
    Paramètres
    • client_id string : Fiche client dont on lit les mesures, telle que rendue par list_clients. Requise côté agence.
    Rend object
    Champs
    • metrics object[] · toujours présent
      • id string · toujours présent
      • client_id string · toujours présent
      • name string · toujours présent
      • unit string · toujours présent
      • description null|string · toujours présent
      • direction string · toujours présentValeurs
        updownneutral
      • aggregation string · toujours présentValeurs
        sumlastaverage
      • decimals number · toujours présent
      • created_at string · toujours présent
      • readings object[] · toujours présent
        • id string · toujours présent
        • metric_id string · toujours présent
        • period_start string · toujours présent
        • period_end string · toujours présent
        • grain string · toujours présentValeurs
          customdayweekmonthyearquarter
        • value number · toujours présent
        • note null|string · toujours présent
    Lien vers ce point d'entrée
  • /api/v1/create_client_metricPOSTwriteÉcriture. Crée une mesure sur la fiche d'un client. Le nom et l'unité sont obligatoires ; la mesure est visible dans l'espace du client dès sa création, même sans relevé. `aggregation` dit comment réunir plusieurs relevés quand on les regroupe (sum pour un chiffre d'affaires, average pour un taux, last pour un stock) : le défaut est la somme, et il est faux pour un taux. Un nom déjà pris sur cette fiche est refusé.
    Paramètres
    • client_id string · obligatoire : Identifiant de la fiche client suivie, tel que rendu par list_clients.
    • name string · obligatoire : Nom de la mesure, unique sur la fiche client (Chiffre d'affaires, Sessions...).
    • unit string · obligatoire : Unité affichée à côté des valeurs, en texte libre (€, %, commandes...).
    • description string|null : Ce que la mesure compte, affiché sous son nom. Absente, null ou vide : aucune (une modification l'efface).
    • direction string · = "up" : Sens favorable : up (la hausse est bonne), down (la baisse l'est), neutral (sans jugement). Absent : up.Valeurs
      updownneutral
    • aggregation string · = "sum" : Réunion de plusieurs relevés en un point : sum (somme), average (moyenne), last (dernier relevé). Absent : sum.Valeurs
      sumaveragelast
    • decimals integer · = 0 : Nombre de décimales à l'affichage des valeurs, de 0 à 4. Absent : 0.
    Rend object
    Champs
    • id string · toujours présent
    • client_id string · toujours présent
    • name string · toujours présent
    • unit string · toujours présent
    • description null|string · toujours présent
    • direction string · toujours présentValeurs
      updownneutral
    • aggregation string · toujours présentValeurs
      sumlastaverage
    • decimals number · toujours présent
    • created_at string · toujours présent
    Lien vers ce point d'entrée
  • /api/v1/update_client_metricPOSTwriteÉcriture. Corrige une mesure : son nom, son unité, ce qu'elle décrit, son sens favorable, sa façon de réunir les relevés et ses décimales d'affichage. Ne touche à aucun relevé, et ne change jamais la fiche à laquelle elle appartient.
    Paramètres
    • id string · obligatoire : Identifiant de la mesure, tel que rendu par list_client_metrics.
    • name string · obligatoire : Nom de la mesure, unique sur la fiche client (Chiffre d'affaires, Sessions...).
    • unit string · obligatoire : Unité affichée à côté des valeurs, en texte libre (€, %, commandes...).
    • description string|null : Ce que la mesure compte, affiché sous son nom. Absente, null ou vide : aucune (une modification l'efface).
    • direction string · = "up" : Sens favorable : up (la hausse est bonne), down (la baisse l'est), neutral (sans jugement). Absent : up.Valeurs
      updownneutral
    • aggregation string · = "sum" : Réunion de plusieurs relevés en un point : sum (somme), average (moyenne), last (dernier relevé). Absent : sum.Valeurs
      sumaveragelast
    • decimals integer · = 0 : Nombre de décimales à l'affichage des valeurs, de 0 à 4. Absent : 0.
    Rend object
    Champs
    • id string · toujours présent
    • client_id string · toujours présent
    • name string · toujours présent
    • unit string · toujours présent
    • description null|string · toujours présent
    • direction string · toujours présentValeurs
      updownneutral
    • aggregation string · toujours présentValeurs
      sumlastaverage
    • decimals number · toujours présent
    • created_at string · toujours présent
    Lien vers ce point d'entrée
  • /api/v1/delete_client_metricPOSTdestructiveSuppression définitive, irréversible. Supprime une mesure ET TOUS SES RELEVÉS, définitivement. Rien ne les reconstitue : demander confirmation avant d'appeler.
    Paramètres
    • id string · obligatoire : Identifiant de la mesure, tel que rendu par list_client_metrics.
    Rend object
    Champs
    • id string · toujours présent
    Lien vers ce point d'entrée
  • /api/v1/save_metric_readingPOSTwriteÉcriture. Enregistre un relevé sur une mesure : une valeur, la période qu'elle décrit et une note facultative. La période est donnée par ses deux bornes incluses (`period_start`, `period_end`, jours civils, égales pour un relevé quotidien) plus `grain`, qui dit le pas choisi et décide de ce qui s'écrira sous le point (day, week, month, quarter, year, custom). Deux pièges : un relevé qui couvre EXACTEMENT la même période est remplacé, et un relevé qui en chevauche partiellement un autre est refusé.
    Paramètres
    • metric_id string · obligatoire : Identifiant de la mesure, tel que rendu par list_client_metrics.
    • period_start string · obligatoire : Premier jour de la période décrite (et non celui de la saisie), au format AAAA-MM-JJ.
    • period_end string · obligatoire : Dernier jour de la période, inclus, au format AAAA-MM-JJ. Égal au premier pour un relevé du jour.
    • grain string · = "day" : Pas de la période : day, week, month, quarter, year ou custom. Il décide du libellé sous le point. Absent : day.Valeurs
      dayweekmonthquarteryearcustom
    • value number · obligatoire : Valeur relevée, dans l'unité de la mesure. Elle peut être négative (une variation, une marge).
    • note string|null : Commentaire attaché au relevé. Absent, null ou vide : aucun (une correction l'efface).
    Rend object
    Champs
    • id string · toujours présent
    • metric_id string · toujours présent
    • period_start string · toujours présent
    • period_end string · toujours présent
    • grain string · toujours présentValeurs
      customdayweekmonthyearquarter
    • value number · toujours présent
    • note null|string · toujours présent
    Lien vers ce point d'entrée
  • /api/v1/save_metric_readingsPOSTwriteÉcriture. Enregistre PLUSIEURS relevés d'un coup sur une seule mesure : c'est ce qu'il faut appeler pour poser une série (douze mois de chiffre d'affaires, trente jours de trafic), plutôt que saveMetricReading autant de fois. Chaque relevé porte ses deux bornes incluses (`period_start`, `period_end`, jours civils, égales pour un relevé quotidien), son `grain` (day, week, month, quarter, year, custom), sa valeur et une note facultative. Tout ou rien : les chevauchements sont cherchés avant la moindre écriture, contre les relevés déjà posés ET entre les relevés de l'envoi, et un seul chevauchement fait refuser l'envoi entier en nommant la période fautive. Une période EXACTEMENT identique à un relevé existant le corrige, ce qui n'est pas un chevauchement. La réponse dit combien ont été créés et combien corrigés. Une mesure par appel : pour en remplir trois, faire trois appels.
    Paramètres
    • metric_id string · obligatoire : Identifiant de la mesure qui reçoit tous les relevés, tel que rendu par list_client_metrics.
    • readings object[] · obligatoire : Relevés à enregistrer, de 1 à 750, sans chevauchement entre eux ni avec l'existant. Une période déjà relevée est corrigée.
      • period_start string · obligatoire : Premier jour de la période décrite (et non celui de la saisie), au format AAAA-MM-JJ.
      • period_end string · obligatoire : Dernier jour de la période, inclus, au format AAAA-MM-JJ. Égal au premier pour un relevé du jour.
      • grain string · = "day" : Pas de la période : day, week, month, quarter, year ou custom. Il décide du libellé sous le point. Absent : day.Valeurs
        dayweekmonthquarteryearcustom
      • value number · obligatoire : Valeur relevée, dans l'unité de la mesure. Elle peut être négative (une variation, une marge).
      • note string|null : Commentaire attaché au relevé. Absent, null ou vide : aucun (une correction l'efface).
    Rend object
    Champs
    • saved number · toujours présent
    • replaced number · toujours présent
    Lien vers ce point d'entrée
  • /api/v1/delete_metric_readingPOSTdestructiveSuppression définitive, irréversible. Retire un relevé d'une mesure. La courbe se referme sur les points voisins ; la mesure, elle, reste.
    Paramètres
    • id string · obligatoire : Identifiant du relevé, tel que rendu par list_client_metrics.
    Rend object
    Champs
    • id string · toujours présent
    Lien vers ce point d'entrée

files

  • /api/v1/get_client_file_boardGET · POSTreadLecture. Fichiers d'un client : noms, types, tailles, qui les a déposés, s'ils sont partagés avec lui (shared_with_client) ou gardés pour l'équipe, et la place occupée. Avec client_id à null, les fichiers internes de l'agence, liés à aucun client, et dans client_folders le dossier de chaque client qui a des fichiers. Aucune URL n'est rendue ici : pour lire un document, prendre son identifiant et appeler get_client_file_text.
    Paramètres
    • client_id string|null : Identifiant de la fiche client. null : les fichiers internes de l'agence, qui ne sont liés à aucun client.
    • limit integer : Combien de lignes rendre au plus (500 par défaut et au maximum).
    • offset integer : Combien de lignes sauter, pour aller chercher la suite de la liste.
    Rend object
    Champs
    • client_id null|string · toujours présent
    • folders object[] · toujours présent
      • id string · toujours présent
      • parent_id null|string · toujours présent
      • name string · toujours présent
      • client_id null|string · toujours présent
      • created_at string · toujours présent
    • files object[] · toujours présent
      • id string · toujours présent
      • client_id null|string · toujours présent
      • name string · toujours présent
      • mime_type string · toujours présent
      • size_bytes number · toujours présent
      • has_thumb boolean · toujours présent
      • folder_id null|string · toujours présent
      • shared_with_client boolean · toujours présent
      • created_by null|string · toujours présent
      • created_side string · toujours présentValeurs
        clientagency
      • created_at string · toujours présent
    • client_folders object[] · toujours présent
      • client_id string · toujours présent
      • name string · toujours présent
      • file_count number · toujours présent
    • used_bytes number · toujours présent
    • quota_bytes number · toujours présent
    Lien vers ce point d'entrée
  • /api/v1/get_client_file_textGET · POSTreadLecture. Le TEXTE d'un fichier partagé, par son identifiant (celui que rend get_client_file_board) : un PDF qui porte une couche de texte (certificat d'analyse, facture, contrat, rapport de laboratoire) ou un fichier textuel (txt, csv, md, json, xml, yaml). Rend une tranche de 12 000 caractères au plus, avec le nombre de pages du document et jusqu'où la lecture est allée ; quand `next_offset` n'est pas nul, rappeler le même outil avec cette valeur pour la suite. Ne rend jamais le fichier lui-même ni d'URL. Un PDF scanné (des pages qui sont des images) ne porte aucun texte : la réponse le dit alors dans `note` plutôt que de rendre un vide qu'on lirait comme un document vide. Une archive, un .docx et un tableur sont refusés en le disant ; pour VOIR une image ou une vidéo, get_attachments.
    Paramètres
    • id string · obligatoire : Identifiant du fichier, tel que rendu par get_client_file_board.
    • offset integer · = 0 : Rang du caractère où reprendre la lecture, à recopier du next_offset de la réponse précédente. 0 par défaut : le début.
    Rend object
    Champs
    • id string · toujours présent
    • name string · toujours présent
    • mime_type string · toujours présent
    • size_bytes number · toujours présent
    • pages null|number · toujours présent
    • pages_read null|number · toujours présent
    • offset number · toujours présent
    • text string · toujours présent
    • next_offset null|number · toujours présent
    • note null|string · toujours présent
    Lien vers ce point d'entrée
  • /api/v1/upload_client_filePOSTwriteÉcriture. Dépose un fichier (PDF, image, document, archive) dans les fichiers d'un client, ou dans les fichiers internes de l'agence avec client_id: null. Le fichier arrive soit par son contenu en base64 (content_base64, 3 Mo au plus), soit par un lien https public que le serveur télécharge lui-même (source_url, 50 Mo au plus) ; jamais les deux. folder_id le range dans un dossier (get_client_file_board, create_client_file_folder) ; shared_with_client: false le garde pour l'équipe sur une fiche client. Rend le fichier publié, avec son identifiant. Un lien de partage qui ouvre une page (Google Drive, WeTransfer) ne marche pas : il faut le lien de téléchargement direct, ou le contenu.
    Paramètres
    • client_id string|null : Identifiant de la fiche client. null : les fichiers internes de l'agence, qui ne sont liés à aucun client.
    • name string · obligatoire : Nom du fichier, avec son extension (devis-orus.pdf).
    • content_base64 string : Contenu du fichier en base64, ou en data URL (data:application/pdf;base64,...). 3 Mo au plus une fois décodé ; au-delà, source_url.
    • source_url string : Lien https public d'où télécharger le fichier, 50 Mo au plus. Le serveur va le chercher lui-même ; un lien qui demande une connexion ne marchera pas.
    • mime_type string : Type du fichier (application/pdf). Facultatif : déduit sinon de l'extension.
    • folder_id string|null : Dossier où ranger le fichier (identifiant rendu par get_client_file_board ou create_client_file_folder). Absent : à la racine.
    • shared_with_client boolean : Le client verra-t-il ce fichier ? Vrai par défaut sur une fiche client ; sans effet dans les fichiers internes de l'agence.
    Rend object
    Champs
    • id string · toujours présent
    • client_id null|string · toujours présent
    • name string · toujours présent
    • mime_type string · toujours présent
    • size_bytes number · toujours présent
    • has_thumb boolean · toujours présent
    • folder_id null|string · toujours présent
    • shared_with_client boolean · toujours présent
    • created_by null|string · toujours présent
    • created_side string · toujours présentValeurs
      clientagency
    • created_at string · toujours présent
    Lien vers ce point d'entrée
  • /api/v1/confirm_client_file_uploadPOSTwriteÉcriture. Termine un envoi commencé depuis l'écran : relit la taille et le type dans le stockage, puis publie le fichier dans le dossier partagé. Pour déposer un fichier soi-même, upload_client_file.
    Paramètres
    • id string · obligatoire : Identifiant du fichier rendu par la préparation de l'envoi, un geste de l'écran qui n'est pas publié.
    • thumb_uploaded boolean : true si la vignette a bien été envoyée au stockage avec le fichier. Absent : aucune vignette.
    Rend object
    Champs
    • id string · toujours présent
    • client_id null|string · toujours présent
    • name string · toujours présent
    • mime_type string · toujours présent
    • size_bytes number · toujours présent
    • has_thumb boolean · toujours présent
    • folder_id null|string · toujours présent
    • shared_with_client boolean · toujours présent
    • created_by null|string · toujours présent
    • created_side string · toujours présentValeurs
      clientagency
    • created_at string · toujours présent
    Lien vers ce point d'entrée
  • /api/v1/delete_client_filePOSTdestructiveSuppression définitive, irréversible. Supprime définitivement un fichier partagé, et l'octet avec.
    Paramètres
    • id string · obligatoire : Identifiant du fichier, tel que rendu par get_client_file_board.
    Rend object
    Champs
    • id string · toujours présent
    Lien vers ce point d'entrée
  • /api/v1/delete_client_filesPOSTdestructiveSuppression définitive, irréversible. Supprime définitivement plusieurs fichiers partagés d'un coup, et les octets avec. Rien n'est effacé si l'un d'eux ne peut pas l'être.
    Paramètres
    • ids string[] · obligatoire : Identifiants des fichiers à supprimer, tels que rendus par get_client_file_board.
    Rend object
    Champs
    • ids string[] · toujours présent
    Lien vers ce point d'entrée
  • /api/v1/set_client_files_sharedPOSTwriteÉcriture. Montre au client des fichiers que l'agence a déposés sur sa fiche (shared: true), ou les garde pour l'équipe (shared: false). Le client est prévenu de ce qu'on lui partage, et ce qu'il a vu avant ne se rattrape pas. Refusé pour un fichier interne de l'agence, un fichier déposé par le client, et une pièce jointe de conversation.
    Paramètres
    • ids string[] · obligatoire : Identifiants des fichiers, tels que rendus par get_client_file_board.
    • shared boolean · obligatoire : true montre les fichiers au client, false les garde pour l'équipe.
    Rend object[]
    Chaque ligne porte
    • id string · toujours présent
    • client_id null|string · toujours présent
    • name string · toujours présent
    • mime_type string · toujours présent
    • size_bytes number · toujours présent
    • has_thumb boolean · toujours présent
    • folder_id null|string · toujours présent
    • shared_with_client boolean · toujours présent
    • created_by null|string · toujours présent
    • created_side string · toujours présentValeurs
      clientagency
    • created_at string · toujours présent
    Lien vers ce point d'entrée
  • /api/v1/rename_client_filePOSTwriteÉcriture. Renomme un fichier du dossier partagé. L'extension d'origine est toujours gardée, et le fichier se télécharge ensuite sous ce nom. Le client n'est pas prévenu.
    Paramètres
    • id string · obligatoire : Identifiant du fichier, tel que rendu par get_client_file_board.
    • name string · obligatoire : Nouveau nom. L'extension d'origine est gardée : inutile de la retaper, et en écrire une autre ne change pas le type du fichier.
    Rend object
    Champs
    • id string · toujours présent
    • client_id null|string · toujours présent
    • name string · toujours présent
    • mime_type string · toujours présent
    • size_bytes number · toujours présent
    • has_thumb boolean · toujours présent
    • folder_id null|string · toujours présent
    • shared_with_client boolean · toujours présent
    • created_by null|string · toujours présent
    • created_side string · toujours présentValeurs
      clientagency
    • created_at string · toujours présent
    Lien vers ce point d'entrée

file-folders

  • /api/v1/create_client_file_folderPOSTwriteÉcriture. Crée un dossier dans le dossier partagé d'un client, ou dans celui de l'agence avec client_id à null, à la racine ou dans un autre dossier. Deux dossiers de même nom ne cohabitent pas au même endroit.
    Paramètres
    • client_id string|null : Identifiant de la fiche client. null : le dossier interne de l'agence, lié à aucun client.
    • parent_id string|null : Dossier parent, tel que rendu par get_client_file_board, dans le même arbre que client_id. Absent ou null : la racine.
    • name string · obligatoire : Nom du nouveau dossier, unique parmi ses voisins.
    Rend object
    Champs
    • id string · toujours présent
    • parent_id null|string · toujours présent
    • name string · toujours présent
    • client_id null|string · toujours présent
    • created_at string · toujours présent
    Lien vers ce point d'entrée
  • /api/v1/rename_client_file_folderPOSTwriteÉcriture. Renomme un dossier du dossier partagé. Ce qu'il contient n'est pas touché et ne change pas de place.
    Paramètres
    • id string · obligatoire : Identifiant du dossier, tel que rendu par get_client_file_board.
    • name string · obligatoire : Nouveau nom du dossier, unique parmi ses voisins.
    Rend object
    Champs
    • id string · toujours présent
    • parent_id null|string · toujours présent
    • name string · toujours présent
    • client_id null|string · toujours présent
    • created_at string · toujours présent
    Lien vers ce point d'entrée
  • /api/v1/delete_client_file_folderPOSTwriteÉcriture. Supprime un dossier du dossier partagé. Aucun fichier n'est supprimé : son contenu, sous-dossiers compris, remonte dans le dossier qui le contenait.
    Paramètres
    • id string · obligatoire : Identifiant du dossier, tel que rendu par get_client_file_board.
    Rend object
    Champs
    • id string · toujours présent
    Lien vers ce point d'entrée
  • /api/v1/move_client_file_itemsPOSTwriteÉcriture. Range des fichiers et des dossiers dans un autre dossier, ou les remet à la racine. Aucun octet ne bouge, un dossier ne peut pas être rangé dans l'un de ses sous-dossiers, et rien ne passe du dossier d'un client à celui de l'agence ni l'inverse.
    Paramètres
    • file_ids string[] · = [] : Identifiants des fichiers à ranger, tel que rendu par get_client_file_board.
    • folder_ids string[] · = [] : Identifiants des dossiers à ranger, avec tout leur contenu, tel que rendu par get_client_file_board.
    • to_folder_id string|null : Dossier d'arrivée, tel que rendu par get_client_file_board, dans le même arbre. Absent ou null : la racine.
    Rend object
    Champs
    • file_ids string[] · toujours présent
    • folder_ids string[] · toujours présent
    • to_folder_id null|string · toujours présent
    Lien vers ce point d'entrée

decisions

  • /api/v1/list_decisionsGET · POSTreadLecture. Décisions de l'agence : ce qui a été tranché, le motif, l'option écartée, le jour et avec qui. Sans status, seules les décisions qui valent encore ; avec « all », l'histoire complète, remplacées et abandonnées comprises. Sans client_id, toutes ; avec null, celles qui ne concernent aucune fiche.
    Paramètres
    • client_id string|null : Identifiant de la fiche, tel que rendu par list_clients. Absent : toutes les décisions ; null : celles d'agence, sans fiche.
    • status string : Statut retenu. Absent : les décisions qui valent encore (active) ; all : l'histoire complète.Valeurs
      activesupersededabandonedall
    • search string : Ne garde que les lignes dont le titre, le motif ou l'option écartée contient ce texte, sans tenir compte de la casse (les accents, eux, comptent).
    • limit integer : Combien de lignes rendre au plus (300 par défaut et au maximum).
    • offset integer : Combien de lignes sauter, pour aller chercher la suite de la liste.
    Rend object[]
    Chaque ligne porte
    • id string · toujours présent
    • client_id null|string · toujours présent
    • title string · toujours présent
    • rationale string · toujours présent
    • rejected null|string · toujours présent
    • decided_on string · toujours présent
    • decided_with null|string · toujours présent
    • status string · toujours présentValeurs
      supersededabandonedactive
    • superseded_by null|string · toujours présent
    • meeting_id null|string · toujours présent
    • note_id null|string · toujours présent
    • evidence null|string · toujours présent
    • created_by null|string · toujours présent
    • created_at string · toujours présent
    • updated_at string · toujours présent
    • client_name null|string · toujours présent
    • created_by_name null|string · toujours présent
    Lien vers ce point d'entrée
  • /api/v1/get_decisionGET · POSTreadLecture. Une décision et sa chaîne : ce qu'elle a remplacé, ce qui l'a remplacée, la réunion d'où elle vient et la note qui la développe. Lue de haut en bas, la chaîne dit pourquoi on en est là.
    Paramètres
    • id string · obligatoire : Identifiant de la décision, tel que rendu par list_decisions.
    Rend object
    Champs
    • decision object · toujours présent
      • id string · toujours présent
      • client_id null|string · toujours présent
      • title string · toujours présent
      • rationale string · toujours présent
      • rejected null|string · toujours présent
      • decided_on string · toujours présent
      • decided_with null|string · toujours présent
      • status string · toujours présentValeurs
        supersededabandonedactive
      • superseded_by null|string · toujours présent
      • meeting_id null|string · toujours présent
      • note_id null|string · toujours présent
      • evidence null|string · toujours présent
      • created_by null|string · toujours présent
      • created_at string · toujours présent
      • updated_at string · toujours présent
      • client_name null|string · toujours présent
      • created_by_name null|string · toujours présent
    • supersedes null|object · toujours présent
      • id string · toujours présent
      • title string · toujours présent
      • decided_on string · toujours présent
    • supersededBy null|object · toujours présent
      • id string · toujours présent
      • title string · toujours présent
      • decided_on string · toujours présent
    • meeting_title null|string · toujours présent
    • note_name null|string · toujours présent
    Lien vers ce point d'entrée
  • /api/v1/create_decisionPOSTwriteÉcriture. Note une décision : ce qui est tranché (au présent, comme un fait), pourquoi, et ce qui a été écarté. N'écrase rien. À n'employer que pour ce que quelqu'un pourrait contredire demain, jamais pour un fait qui a déjà son champ. Si elle contredit une décision qui vaut encore, c'est supersedeDecision qu'il faut.
    Paramètres
    • title string · obligatoire : Ce qui est tranché, au présent, comme un fait (300 caractères au plus).
    • rationale string · obligatoire : Le motif de la décision, obligatoire (2000 caractères au plus).
    • rejected string|null : L'option écartée et pourquoi (1000 caractères au plus). Absent ou null : rien de noté.
    • client_id string|null : Fiche client visée, telle que rendue par list_clients. Absent ou null : décision d'agence, sans fiche.
    • decided_on string : Jour où la chose a été tranchée, au format AAAA-MM-JJ. Absent : aujourd'hui.
    • decided_with string|null : Le contact avec qui elle a été tranchée, en texte libre (200 caractères au plus), quand ce n'est pas l'équipe seule.
    • meeting_id string|null : Réunion d'où vient la décision, telle que rendue par list_meetings.
    • note_id string|null : Note qui développe la décision, telle que rendue par list_admin_notes.
    • evidence string|null : Le passage qui l'établit (transcript, note, message), recopié tel quel, 2000 caractères au plus.
    Rend object
    Champs
    • id string · toujours présent
    • client_id null|string · toujours présent
    • title string · toujours présent
    • rationale string · toujours présent
    • rejected null|string · toujours présent
    • decided_on string · toujours présent
    • decided_with null|string · toujours présent
    • status string · toujours présentValeurs
      supersededabandonedactive
    • superseded_by null|string · toujours présent
    • meeting_id null|string · toujours présent
    • note_id null|string · toujours présent
    • evidence null|string · toujours présent
    • created_by null|string · toujours présent
    • created_at string · toujours présent
    • updated_at string · toujours présent
    Lien vers ce point d'entrée
  • /api/v1/supersede_decisionPOSTwriteÉcriture. Remplace une décision par une nouvelle : celle d'avant cesse de valoir et pointe vers celle-ci, sans rien perdre de son motif. C'est le geste du revirement (« finalement on ne fait plus ça, on fait ça »). Refusé sur une décision déjà remplacée ou abandonnée.
    Paramètres
    • id string · obligatoire : Identifiant de la décision active qui cesse de valoir, tel que rendu par list_decisions.
    • title string · obligatoire : Ce qui est tranché, au présent, comme un fait (300 caractères au plus).
    • rationale string · obligatoire : Le motif de la décision, obligatoire (2000 caractères au plus).
    • rejected string|null : L'option écartée et pourquoi (1000 caractères au plus). Absent ou null : rien de noté.
    • client_id string|null : Fiche client visée, telle que rendue par list_clients. Absent : celle de la décision remplacée ; null : décision d'agence.
    • decided_on string : Jour où la chose a été tranchée, au format AAAA-MM-JJ. Absent : aujourd'hui.
    • decided_with string|null : Le contact avec qui elle a été tranchée, en texte libre (200 caractères au plus), quand ce n'est pas l'équipe seule.
    • meeting_id string|null : Réunion d'où vient la décision, telle que rendue par list_meetings.
    • note_id string|null : Note qui développe la décision, telle que rendue par list_admin_notes.
    • evidence string|null : Le passage qui l'établit (transcript, note, message), recopié tel quel, 2000 caractères au plus.
    Rend object
    Champs
    • id string · toujours présent
    • client_id null|string · toujours présent
    • title string · toujours présent
    • rationale string · toujours présent
    • rejected null|string · toujours présent
    • decided_on string · toujours présent
    • decided_with null|string · toujours présent
    • status string · toujours présentValeurs
      supersededabandonedactive
    • superseded_by null|string · toujours présent
    • meeting_id null|string · toujours présent
    • note_id null|string · toujours présent
    • evidence null|string · toujours présent
    • created_by null|string · toujours présent
    • created_at string · toujours présent
    • updated_at string · toujours présent
    Lien vers ce point d'entrée
  • /api/v1/update_decisionPOSTwriteÉcriture. Corrige une décision : sa formulation, son motif, sa date, la fiche ou la source qu'elle cite, ou son statut (abandoned quand on ne fait plus ça sans que rien ne prenne la place, active pour revenir dessus). Mise à jour partielle. Ce n'est PAS le geste du revirement, qui est supersedeDecision : réécrire un motif efface le pourquoi d'avant.
    Paramètres
    • id string · obligatoire : Identifiant de la décision, tel que rendu par list_decisions.
    • title string : Formulation corrigée, 300 caractères au plus. Absent : laissée telle quelle.
    • rationale string : Motif corrigé (une précision, pas un revirement), 2000 caractères au plus. Absent : laissé tel quel.
    • rejected string|null : L'option écartée et pourquoi. null l'efface ; absent : laissée telle quelle.
    • client_id string|null : Fiche client visée, telle que rendue par list_clients. null la détache (décision d'agence) ; absent : inchangée.
    • decided_on string : Jour où la chose a été tranchée, au format AAAA-MM-JJ. Absent : inchangé.
    • decided_with string|null : Le contact avec qui elle a été tranchée. null l'efface ; absent : inchangé.
    • meeting_id string|null : Réunion d'où vient la décision, telle que rendue par list_meetings. null la détache ; absent : inchangée.
    • note_id string|null : Note qui la développe, telle que rendue par list_admin_notes. null la détache ; absent : inchangée.
    • evidence string|null : Le passage qui l'établit, recopié tel quel. null l'efface ; absent : inchangé.
    • status string : abandoned : on ne fait plus ça, sans remplaçant ; active : on y revient. Un revirement passe par supersede_decision.Valeurs
      activeabandoned
    Rend object
    Champs
    • id string · toujours présent
    • client_id null|string · toujours présent
    • title string · toujours présent
    • rationale string · toujours présent
    • rejected null|string · toujours présent
    • decided_on string · toujours présent
    • decided_with null|string · toujours présent
    • status string · toujours présentValeurs
      supersededabandonedactive
    • superseded_by null|string · toujours présent
    • meeting_id null|string · toujours présent
    • note_id null|string · toujours présent
    • evidence null|string · toujours présent
    • created_by null|string · toujours présent
    • created_at string · toujours présent
    • updated_at string · toujours présent
    Lien vers ce point d'entrée
  • /api/v1/delete_decisionPOSTdestructiveSuppression définitive, irréversible. Supprime définitivement une décision, son motif et sa place dans la chaîne. Réservé à ce qui n'aurait jamais dû être noté (un doublon, un contresens) : une décision réellement prise se remplace ou s'abandonne, elle ne s'efface pas.
    Paramètres
    • id string · obligatoire : Identifiant de la décision, tel que rendu par list_decisions.
    Rend object
    Champs
    • id string · toujours présent
    Lien vers ce point d'entrée

assistant-conversations

  • /api/v1/list_assistant_conversationsGET · POSTreadLecture. Vos conversations avec l'assistant de l'espace admin, de la plus récente à la plus ancienne : leur titre et leur dernière activité. « search » ne filtre que sur le titre. Celles des autres membres de l'agence ne sont jamais rendues.
    Paramètres
    • search string : Ne garde que les conversations dont le TITRE contient ces mots. Le contenu des messages n'est pas fouillé, et un fil jamais nommé ne ressort donc d'aucune recherche.
    • limit integer : Combien de lignes rendre au plus (100 par défaut et au maximum).
    • offset integer : Combien de lignes sauter, pour aller chercher la suite de la liste.
    Rend object[]
    Chaque ligne porte
    • id string · toujours présent
    • title null|string · toujours présent
    • created_at string · toujours présent
    • updated_at string · toujours présent
    Lien vers ce point d'entrée
  • /api/v1/get_assistant_conversationGET · POSTreadLecture. Une de vos conversations avec l'assistant, avec tout ce qui s'y est dit : les messages, les outils appelés et ce qu'ils ont rendu. À demander pour reprendre le fil d'un échange passé.
    Paramètres
    • id string · obligatoire : Identifiant de la conversation.
    Rend object
    Champs
    • id string · toujours présent
    • title null|string · toujours présent
    • created_at string · toujours présent
    • updated_at string · toujours présent
    • turns object[] · toujours présent
      Forme 1 (au choix)
      • role "user" · toujours présent
      • content string · toujours présent
      Forme 2 (au choix)
      • role "assistant" · toujours présent
      • content string · toujours présent
      • calls object[] · toujours présent
        • id string · toujours présent
        • name string · toujours présent
        • arguments string · toujours présent
        • target object
          • tool string · toujours présent
          • level string · toujours présentValeurs
            readwritedestructive
      Forme 3 (au choix)
      • role "tool" · toujours présent
      • callId string · toujours présent
      • ok boolean · toujours présent
      • content string · toujours présent
    Lien vers ce point d'entrée
  • /api/v1/rename_assistant_conversationPOSTwriteÉcriture. Corrige le titre d'une de vos conversations. Ce qu'elle contient ne bouge pas : c'est le nom qu'on lit dans la liste, rien d'autre.
    Paramètres
    • id string · obligatoire : Identifiant de la conversation.
    • title string · obligatoire : Titre de la conversation, tel qu'il se lit dans la liste.
    Rend object
    Champs
    • id string · toujours présent
    • title null|string · toujours présent
    • created_at string · toujours présent
    • updated_at string · toujours présent
    Lien vers ce point d'entrée
  • /api/v1/delete_assistant_conversationPOSTdestructiveSuppression définitive, irréversible. Supprime définitivement une de vos conversations avec l'assistant, et tout ce qui s'y est dit. Rien ne se récupère ensuite.
    Paramètres
    • id string · obligatoire : Identifiant de la conversation.
    Rend object
    Champs
    • id string · toujours présent
    Lien vers ce point d'entrée

media

  • /api/v1/list_media_conversationsGET · POSTreadLecture. Les fils du Studio, du plus récemment nourri au plus ancien : leur titre, leur rangement et leur dernière activité. Sans filtre, seuls les fils en cours ; « archived » rend ceux qui sont rangés, « all » les deux.
    Paramètres
    • archived string : « active » (défaut) pour les conversations en cours, « archived » pour celles qui sont rangées, « all » pour les deux.Valeurs
      activearchivedall
    • client_id string : Ne rend que les fils rattachés à ce client (les projets d'une fiche).
    • limit integer : Combien de lignes rendre au plus (100 par défaut et au maximum).
    • offset integer : Combien de lignes sauter, pour aller chercher la suite de la liste.
    Rend object[]
    Chaque ligne porte
    • id string · toujours présent
    • title null|string · toujours présent
    • archived_at null|string · toujours présent
    • client_id null|string · toujours présent
    • created_at string · toujours présent
    • updated_at string · toujours présent
    • cover null|object · toujours présent
      • id string · toujours présent
      • format string · toujours présentValeurs
        imagevideo
      • orientation string · toujours présentValeurs
        postlandscapeportraitsquare
    • render_count number · toujours présent
    Lien vers ce point d'entrée
  • /api/v1/get_media_conversationGET · POSTreadLecture. Un fil du Studio : son titre, s'il est rangé, et quand il a servi pour la dernière fois. Ce qu'il contient se lit par listMediaGenerations, avec son identifiant.
    Paramètres
    • id string · obligatoire : Identifiant de la conversation.
    Rend object
    Champs
    • id string · toujours présent
    • title null|string · toujours présent
    • archived_at null|string · toujours présent
    • client_id null|string · toujours présent
    • created_at string · toujours présent
    • updated_at string · toujours présent
    Lien vers ce point d'entrée
  • /api/v1/create_media_conversationPOSTwriteÉcriture. Ouvre un fil dans le Studio. N'écrase rien. Le titre est facultatif : sans lui, la première consigne écrite dans le fil le nomme toute seule.
    Paramètres
    • title string : Titre du fil, tel qu'il se lit dans la liste.
    • client_id string|null : Fiche client pour qui le fil travaille (list_clients). Sa charte de marque s'applique à chaque demande du fil. null : aucun client.
    Rend object
    Champs
    • id string · toujours présent
    • title null|string · toujours présent
    • archived_at null|string · toujours présent
    • client_id null|string · toujours présent
    • created_at string · toujours présent
    • updated_at string · toujours présent
    Lien vers ce point d'entrée
  • /api/v1/rename_media_conversationPOSTwriteÉcriture. Corrige le titre d'un fil. Ce qu'il contient ne bouge pas : c'est le nom qu'on lit dans la liste, rien d'autre.
    Paramètres
    • id string · obligatoire : Identifiant de la conversation.
    • title string · obligatoire : Titre du fil, tel qu'il se lit dans la liste.
    Rend object
    Champs
    • id string · toujours présent
    • title null|string · toujours présent
    • archived_at null|string · toujours présent
    • client_id null|string · toujours présent
    • created_at string · toujours présent
    • updated_at string · toujours présent
    Lien vers ce point d'entrée
  • /api/v1/set_media_conversation_archivedPOSTwriteÉcriture. Range un fil (archived: true) ou le reprend (false). Rien ne se perd dans un sens ni dans l'autre : un fil rangé sort de la liste courante et se rouvre quand on en a de nouveau besoin. Tant qu'il est rangé, aucune demande ne peut y être ajoutée.
    Paramètres
    • id string · obligatoire : Identifiant de la conversation.
    • archived boolean · obligatoire : true range la conversation, false la reprend. Rien ne se perd dans un sens ni dans l'autre.
    Rend object
    Champs
    • id string · toujours présent
    • title null|string · toujours présent
    • archived_at null|string · toujours présent
    • client_id null|string · toujours présent
    • created_at string · toujours présent
    • updated_at string · toujours présent
    Lien vers ce point d'entrée
  • /api/v1/list_media_generationsGET · POSTreadLecture. Les demandes d'un fil, de la plus récente à la plus ancienne : ce qui a été demandé, dans quel format et quel cadrage, où en est chaque demande, et ce que le rendu a coûté. Sans conversation_id, toutes les demandes de l'agence. Le rendu lui-même se regarde dans l'espace d'administration.
    Paramètres
    • conversation_id string : Ne rend que les demandes de cette conversation. Sans lui, toutes.
    • limit integer : Combien de lignes rendre au plus (100 par défaut et au maximum).
    • offset integer : Combien de lignes sauter, pour aller chercher la suite de la liste.
    Rend object[]
    Chaque ligne porte
    • id string · toujours présent
    • conversation_id string · toujours présent
    • prompt string · toujours présent
    • format string · toujours présentValeurs
      imagevideo
    • orientation string · toujours présentValeurs
      postlandscapeportraitsquare
    • quality string · toujours présentValeurs
      highstandard
    • batch_id string · toujours présent
    • character_id null|string · toujours présent
    • preset null|string · toujours présent
    • model_prompt null|string · toujours présent
    • operation string · toujours présent
    • source_id null|string · toujours présent
    • params Record<string, MediaParamsValue> · toujours présent
    • model string · toujours présent
    • status string · toujours présentValeurs
      failedpendingrunningready
    • input_count number · toujours présent
    • mime_type null|string · toujours présent
    • width null|number · toujours présent
    • height null|number · toujours présent
    • duration_seconds null|number · toujours présent
    • cost_usd null|number · toujours présent
    • error null|string · toujours présent
    • created_at string · toujours présent
    Lien vers ce point d'entrée
  • /api/v1/get_media_generationGET · POSTreadLecture. Une demande de génération et son état : en attente, en cours, rendue, ou échouée avec la raison. C'est ce qu'on relit pour savoir si un rendu lancé il y a deux minutes est arrivé.
    Paramètres
    • id string · obligatoire : Identifiant de la génération.
    Rend object
    Champs
    • id string · toujours présent
    • conversation_id string · toujours présent
    • prompt string · toujours présent
    • format string · toujours présentValeurs
      imagevideo
    • orientation string · toujours présentValeurs
      postlandscapeportraitsquare
    • quality string · toujours présentValeurs
      highstandard
    • batch_id string · toujours présent
    • character_id null|string · toujours présent
    • preset null|string · toujours présent
    • model_prompt null|string · toujours présent
    • operation string · toujours présent
    • source_id null|string · toujours présent
    • params Record<string, MediaParamsValue2> · toujours présent
    • model string · toujours présent
    • status string · toujours présentValeurs
      failedpendingrunningready
    • input_count number · toujours présent
    • mime_type null|string · toujours présent
    • width null|number · toujours présent
    • height null|number · toujours présent
    • duration_seconds null|number · toujours présent
    • cost_usd null|number · toujours présent
    • error null|string · toujours présent
    • created_at string · toujours présent
    Lien vers ce point d'entrée
  • /api/v1/create_media_generationPOSTwriteÉcriture. Demande une image ou un plan vidéo (6, 10 ou 15 secondes, qualité standard en 720p ou haute en 2K) à partir d'une consigne écrite, dans l'un des quatre cadrages (paysage 16:9, story 9:16, post 3:4, carré 1:1). Jusqu'à quatre rendus d'un coup (count), un personnage enregistré dont le visage est gardé (character_id, voir listMediaCharacters), un style d'image ou un mouvement de caméra (preset), et jusqu'à quatre images de référence : en data URL, par leur lien public (https://), ou des rendus du Studio déjà prêts (reference_ids ; une image du Studio passée en vidéo devient le premier plan, c'est ainsi qu'on l'anime). Par défaut un agent réécrit la consigne et, pour un lot, invente des plans différents du même sujet (enhance: false l'éteint). Sans conversation_id, la demande rejoint le fil le plus récemment nourri, ou en ouvre un ; un fil rangé la refuse. N'écrase rien et ne lance rien : chaque rendu du lot naît en attente, et c'est advanceMediaGeneration qui l'envoie au modèle, rendu par rendu.
    Paramètres
    • conversation_id string : La conversation où poser la demande. Sans lui, la plus récemment nourrie, ou une nouvelle si l'agence n'en a aucune.
    • prompt string · obligatoire : Ce qu'on veut voir, en toutes lettres. La consigne part telle quelle au modèle.
    • format string · obligatoire : « image » pour un visuel fixe, « video » pour un plan vidéo.Valeurs
      imagevideo
    • orientation string · obligatoire : Le cadrage : « landscape » (16:9, héros de site, bannière, YouTube), « portrait » (9:16, story, reel, TikTok), « post » (3:4, fil Instagram) ou « square » (1:1, catalogue, carrousel).Valeurs
      landscapeportraitpostsquare
    • quality string : Vidéo seulement. « standard » (défaut, 720p, environ 0,03 $ la seconde) ou « high » (2K, premier du classement des plans sans le son, environ 0,10 $ la seconde). Ignoré pour une image.Valeurs
      standardhigh
    • duration number : Vidéo seulement. Durée du plan en secondes : 6 (défaut), 10 ou 15. Ignoré pour une image.Valeurs
      61015
    • images string[] : Images de référence, quatre au plus avec reference_ids : en data URL, ou par leur lien public en https:// (le serveur la télécharge et la réduit). Le modèle s'en inspire pour une image ; pour une vidéo, la première sert de premier plan.
    • reference_ids string[] : Identifiants de générations déjà rendues (listMediaGenerations) dont le rendu sert de référence, avant les images. Pour animer une image du Studio : format « video » et son identifiant ici, elle devient le premier plan.
    • count number : Combien de rendus commander, de 1 (défaut) à 4. Chacun est une génération à part, payée à part, à faire avancer à part ; ils partagent un batch_id.Valeurs
      1234
    • character_id string : Le personnage ou le produit enregistré à mettre en scène (listMediaCharacters) : ses photos partent en référence pour garder son visage, ou la forme, l'étiquette, les couleurs et le texte d'un produit. Pour une vidéo, une première image est d'abord dessinée avec lui (environ 0,035 $ de plus).
    • preset string : Un style pour une image (packshot, lifestyle, editorial, ugc, flatlay, hero) ou un mouvement de caméra pour une vidéo (dolly_in, dolly_out, orbit, crane_up, fpv_drone, handheld, crash_zoom, pan, static, motion_graphics, kinetic_type). Un preset qui ne vaut pas pour le format est refusé.Valeurs
      packshotlifestyleeditorialugcflatlayherodolly_indolly_outorbitcrane_upfpv_dronehandheldcrash_zoompanstaticmotion_graphicskinetic_type
    • keyframe boolean : Vidéo seulement. true : une première image est d'abord dessinée avec les références (une scène avec le produit joint, environ 0,035 $), puis animée. Sans lui, la première image jointe sert telle quelle de premier plan. Toujours le cas avec un personnage.
    • enhance boolean : true (défaut) : un modèle de langage réécrit la consigne en consigne détaillée, et invente des plans différents quand count dépasse 1. false : la consigne part telle quelle, à réserver à une consigne déjà écrite pour le modèle.
    • brand boolean : true (défaut) : quand le fil est rattaché à un client qui a une charte de marque (get_client_brand_kit), sa palette, sa typographie, ses règles et son ton s'ajoutent à la consigne. false : la demande part sans la charte.
    • logo boolean : Image seulement, avec la charte : true joint le logo du client en dernière image de référence (une de plus, ce qui peut faire passer au modèle des références). Absent : sans le logo.
    • model string : « auto » (défaut) laisse le Studio choisir le modèle le moins cher qui rend bien. Sinon, pour une image : qwen/qwen-image-3 (Qwen Image 3), noki/editorial (Noki Éditorial), bytedance-seed/seedream-5-0-pro (Seedream 5.0 Pro), google/gemini-nano-banana-2.1 (Nano Banana 2.1), openai/gpt-image-2.5-flare (GPT Image 2.5), black-forest-labs/flux-3-image (Flux 3), recraft/recraft-v4.1 (Recraft V4.1) ; pour une vidéo : heygen/heygen-video-1 (HeyGen Video 1), kwaivgi/kling-v3.0-pro (Kling 3.0 Pro), google/veo-3.1-fast (Veo 3.1 Fast), bytedance/seedance-2.0 (Seedance 2.0), alibaba/wan-3.0 (Wan 3.0), minimax/hailuo-3 (Hailuo 3), runway/gen-4.5 (Runway Gen-4.5), x-ai/grok-imagine-video-1.5 (Grok Imagine 1.5). noki/editorial est le style maison (Seedream 5.0 Pro et une direction artistique photo éditoriale). Un modèle refuse ce qu'il ne sait pas rendre (format, cadrage, durée, nombre de références), avec une phrase qui dit quoi changer. Une vidéo à modèle choisi ignore quality.Valeurs
      autoqwen/qwen-image-3noki/editorialbytedance-seed/seedream-5-0-progoogle/gemini-nano-banana-2.1openai/gpt-image-2.5-flareblack-forest-labs/flux-3-imagerecraft/recraft-v4.1heygen/heygen-video-1kwaivgi/kling-v3.0-progoogle/veo-3.1-fastbytedance/seedance-2.0alibaba/wan-3.0minimax/hailuo-3runway/gen-4.5x-ai/grok-imagine-video-1.5
    Rend object
    Champs
    • batch_id string · toujours présent
    • generations object[] · toujours présent
      • id string · toujours présent
      • conversation_id string · toujours présent
      • prompt string · toujours présent
      • format string · toujours présentValeurs
        imagevideo
      • orientation string · toujours présentValeurs
        postlandscapeportraitsquare
      • quality string · toujours présentValeurs
        highstandard
      • batch_id string · toujours présent
      • character_id null|string · toujours présent
      • preset null|string · toujours présent
      • model_prompt null|string · toujours présent
      • operation string · toujours présent
      • source_id null|string · toujours présent
      • params Record<string, MediaParamsValue3> · toujours présent
      • model string · toujours présent
      • status string · toujours présentValeurs
        failedpendingrunningready
      • input_count number · toujours présent
      • mime_type null|string · toujours présent
      • width null|number · toujours présent
      • height null|number · toujours présent
      • duration_seconds null|number · toujours présent
      • cost_usd null|number · toujours présent
      • error null|string · toujours présent
      • created_at string · toujours présent
    Lien vers ce point d'entrée
  • /api/v1/advance_media_generationPOSTwriteÉcriture. Fait avancer une demande d'un cran : l'envoie au modèle si elle attendait, relit le travail en cours, et range le rendu quand il arrive. À rappeler toutes les quelques dizaines de secondes tant que l'état n'est ni « ready » ni « failed ». Sans effet sur ce qui a fini, et une demande déjà en vol n'est jamais relancée : elle ne se paie pas deux fois.
    Paramètres
    • id string · obligatoire : Identifiant de la génération.
    Rend object
    Champs
    • id string · toujours présent
    • conversation_id string · toujours présent
    • prompt string · toujours présent
    • format string · toujours présentValeurs
      imagevideo
    • orientation string · toujours présentValeurs
      postlandscapeportraitsquare
    • quality string · toujours présentValeurs
      highstandard
    • batch_id string · toujours présent
    • character_id null|string · toujours présent
    • preset null|string · toujours présent
    • model_prompt null|string · toujours présent
    • operation string · toujours présent
    • source_id null|string · toujours présent
    • params Record<string, MediaParamsValue4> · toujours présent
    • model string · toujours présent
    • status string · toujours présentValeurs
      failedpendingrunningready
    • input_count number · toujours présent
    • mime_type null|string · toujours présent
    • width null|number · toujours présent
    • height null|number · toujours présent
    • duration_seconds null|number · toujours présent
    • cost_usd null|number · toujours présent
    • error null|string · toujours présent
    • created_at string · toujours présent
    Lien vers ce point d'entrée
  • /api/v1/delete_media_generationPOSTdestructiveSuppression définitive, irréversible. Supprime une génération, ses images de référence et son rendu. Les octets partent avec la ligne : ce qui n'a pas été téléchargé est perdu.
    Paramètres
    • id string · obligatoire : Identifiant de la génération.
    Rend object
    Champs
    • id string · toujours présent
    Lien vers ce point d'entrée
  • /api/v1/set_media_conversation_clientPOSTwriteÉcriture. Rattache un fil du Studio à une fiche client (client_id, voir list_clients), le change de client, ou l'en détache (null). La charte de marque du client s'applique alors à chaque nouvelle demande du fil ; les rendus déjà faits ne bougent pas.
    Paramètres
    • id string · obligatoire : Identifiant de la conversation.
    • client_id string|null · obligatoire : Fiche client pour qui le fil travaille (list_clients). Sa charte de marque s'applique à chaque demande du fil. null : aucun client.
    Rend object
    Champs
    • id string · toujours présent
    • title null|string · toujours présent
    • archived_at null|string · toujours présent
    • client_id null|string · toujours présent
    • created_at string · toujours présent
    • updated_at string · toujours présent
    Lien vers ce point d'entrée

media-characters

  • /api/v1/list_media_charactersGET · POSTreadLecture. Les personnages et les produits du Studio, par ordre alphabétique : leur nature (kind : character ou product), leur nom, leur description et leur nombre de photos. C'est leur identifiant que createMediaGeneration attend dans character_id pour les mettre en scène : le visage d'un personnage, la forme, l'étiquette et les couleurs d'un produit, gardés d'un visuel à l'autre.
    Paramètres
    • limit integer : Combien de lignes rendre au plus (50 par défaut et au maximum).
    • offset integer : Combien de lignes sauter, pour aller chercher la suite de la liste.
    Rend object[]
    Chaque ligne porte
    • id string · toujours présent
    • kind string · toujours présentValeurs
      characterproduct
    • name string · toujours présent
    • description null|string · toujours présent
    • photo_count number · toujours présent
    • created_at string · toujours présent
    • updated_at string · toujours présent
    Lien vers ce point d'entrée
  • /api/v1/create_media_characterPOSTwriteÉcriture. Enregistre un personnage ou un produit réutilisable (kind : « character » par défaut, « product » pour un flacon, un pot, un paquet) : un nom, une description facultative (âge, style, attitude ; contenance, parfum) et une à quatre photos nettes de lui seul, en data URL ou par lien public https://. N'écrase rien. Ses photos partiront en référence de chaque image ou vidéo qui le cite, et un produit y garde sa forme, son étiquette et ses couleurs.
    Paramètres
    • kind string : « character » (défaut) : une personne ou une mascotte, dont le visage est gardé. « product » : un produit (un flacon, un pot, un paquet), dont la forme, l'étiquette, les couleurs et le texte sont gardés à l'identique d'un visuel à l'autre.Valeurs
      characterproduct
    • name string · obligatoire : Le nom du personnage, tel qu'il se lit dans le menu du Studio et que la consigne le cite.
    • description string|null : Ce que les photos ne disent pas (un âge, un style, une attitude), en une ou deux phrases. Part avec chaque consigne qui le met en scène. null l'efface.
    • photos string[] · obligatoire : Une à quatre photos du personnage, nettes et sans autre visage : en data URL, ou par leur lien public en https://. De face d'abord, puis profil ou plein pied.
    Rend object
    Champs
    • id string · toujours présent
    • kind string · toujours présentValeurs
      characterproduct
    • name string · toujours présent
    • description null|string · toujours présent
    • photo_count number · toujours présent
    • created_at string · toujours présent
    • updated_at string · toujours présent
    Lien vers ce point d'entrée
  • /api/v1/update_media_characterPOSTwriteÉcriture. Corrige un personnage : son nom, sa description (null l'efface) ou ses photos. Ce qui n'est pas envoyé reste ; des photos envoyées REMPLACENT toutes les anciennes, qui sont effacées. Les rendus déjà faits ne bougent pas.
    Paramètres
    • id string · obligatoire : Identifiant du personnage.
    • kind string : « character » (défaut) : une personne ou une mascotte, dont le visage est gardé. « product » : un produit (un flacon, un pot, un paquet), dont la forme, l'étiquette, les couleurs et le texte sont gardés à l'identique d'un visuel à l'autre.Valeurs
      characterproduct
    • name string : Le nom du personnage, tel qu'il se lit dans le menu du Studio et que la consigne le cite.
    • description string|null : Ce que les photos ne disent pas (un âge, un style, une attitude), en une ou deux phrases. Part avec chaque consigne qui le met en scène. null l'efface.
    • photos string[] : Les nouvelles photos, qui REMPLACENT toutes les anciennes. Absent, les photos restent. Une à quatre, en data URL ou par lien https://.
    Rend object
    Champs
    • id string · toujours présent
    • kind string · toujours présentValeurs
      characterproduct
    • name string · toujours présent
    • description null|string · toujours présent
    • photo_count number · toujours présent
    • created_at string · toujours présent
    • updated_at string · toujours présent
    Lien vers ce point d'entrée
  • /api/v1/delete_media_characterPOSTdestructiveSuppression définitive, irréversible. Supprime un personnage et ses photos. Les rendus qu'il a servi à faire restent dans leurs fils ; une demande encore en attente partira sans lui.
    Paramètres
    • id string · obligatoire : Identifiant du personnage.
    Rend object
    Champs
    • id string · toujours présent
    Lien vers ce point d'entrée

media-operations

  • /api/v1/create_media_operationPOSTwriteÉcriture. Retouche un rendu déjà prêt du Studio (source_id, voir listMediaGenerations) et pose le résultat dans le même fil, sous un nouveau lot. Image : remove_background détoure le sujet (background « transparent » pour un PNG transparent, environ 0,06 $, ou une couleur #RRGGBB, environ 0,035 $) ; replace_background pose le sujet dans une autre scène et le rééclaire pour qu'il s'y fonde (scene en toutes lettres, ou scene_preset) ; relight change la lumière (light : un préréglage ou une phrase) ; retouch applique une consigne (instruction), à toute l'image ou à la seule zone region {x, y, w, h} en fractions de 0 à 1 ; expand agrandit le cadre vers un autre cadrage (orientation) sans toucher au contenu ; upscale redessine l'image en 4K à l'identique (agrandissement génératif, pas un agrandisseur de pixels) ; declinate produit un agrandissement par cadrage coché (orientations), un rendu chacun ; layers sépare un visuel plat en deux rendus, le sujet détouré sur fond transparent et le fond seul sans le sujet ni le texte (layer pour n'en refaire qu'un). Vidéo : video_upscale agrandit la vidéo (factor de 1,5 à 3, défaut 2 ; environ 0,035 $ par mégapixel rendu et par seconde, soit près de 0,80 $ pour six secondes de 720p doublées) ; video_edit étalonne, rééclaire ou modifie la vidéo (grade : un effet prêt, et/ou instruction ; quality « high » passe chez Runway Aleph, bien plus cher). N'écrase rien, et ne lance rien : chaque rendu naît en attente, et c'est advanceMediaGeneration qui l'envoie au modèle. Refuse un rendu pas encore prêt, du mauvais format pour la retouche, ou dans un fil archivé.
    Paramètres
    • source_id string · obligatoire : Le rendu de départ (listMediaGenerations) : une image ou une vidéo déjà rendue (status « ready »). La retouche se pose dans le même fil.
    • operation string · obligatoire : La retouche. Image : remove_background, replace_background, relight, retouch, expand, upscale, declinate, layers. Vidéo : video_upscale, video_edit.Valeurs
      remove_backgroundreplace_backgroundrelightretouchexpandupscaledeclinatelayersvideo_upscalevideo_edit
    • background string : remove_background : « transparent » (défaut, PNG à couche alpha) ou une couleur unie écrite #RRGGBB.
    • scene string : replace_background : la nouvelle scène, décrite en toutes lettres. L'emporte sur scene_preset.
    • scene_preset string : replace_background : une scène prête (studio, marble, forest, beach, concrete, botanical, night_city).Valeurs
      studiomarbleforestbeachconcretebotanicalnight_city
    • light string : relight : une lumière prête (golden_hour, softbox, neon, backlight, night, window, overcast) ou une lumière décrite en toutes lettres.
    • instruction string : retouch : ce qui doit changer dans l'image (obligatoire). video_edit : ce qui doit changer dans la vidéo, seul ou en plus de grade.
    • region object : retouch : la seule zone que la retouche peut changer, en fractions de l'image. Sans elle, la consigne vaut pour toute l'image.
      • x number · obligatoire : Bord gauche de la zone, en fraction de la largeur (0 à 1).
      • y number · obligatoire : Bord haut de la zone, en fraction de la hauteur (0 à 1).
      • w number · obligatoire : Largeur de la zone, en fraction de la largeur.
      • h number · obligatoire : Hauteur de la zone, en fraction de la hauteur.
    • orientation string : expand : le nouveau cadrage (landscape 16:9, portrait 9:16, post 3:4, square 1:1), autre que celui du rendu.Valeurs
      landscapeportraitpostsquare
    • orientations string[] : declinate : les cadrages à produire, un agrandissement par cadrage ; celui du rendu est ignoré.Valeurs
      landscapeportraitpostsquare
    • layer string : layers : ne produire que ce calque (subject : le sujet détouré, background : le fond seul). Sans lui, les deux.Valeurs
      subjectbackground
    • factor number : video_upscale : le facteur d'agrandissement, de 1,5 à 3 (défaut 2).
    • grade string : video_edit : un effet prêt, étalonnage ou rééclairage (warm_film, teal_orange, black_white, pastel, golden_hour, night).Valeurs
      warm_filmteal_orangeblack_whitepastelgolden_hournight
    • quality string : video_edit : « standard » (défaut, rapide, environ 0,03 $ la seconde) ou « high » (Runway Aleph, environ 0,28 $ la seconde, 0,56 $ au moins).Valeurs
      standardhigh
    Rend object
    Champs
    • batch_id string · toujours présent
    • generations object[] · toujours présent
      • id string · toujours présent
      • conversation_id string · toujours présent
      • prompt string · toujours présent
      • format string · toujours présentValeurs
        imagevideo
      • orientation string · toujours présentValeurs
        postlandscapeportraitsquare
      • quality string · toujours présentValeurs
        highstandard
      • batch_id string · toujours présent
      • character_id null|string · toujours présent
      • preset null|string · toujours présent
      • model_prompt null|string · toujours présent
      • operation string · toujours présent
      • source_id null|string · toujours présent
      • params Record<string, MediaParamsValue5> · toujours présent
      • model string · toujours présent
      • status string · toujours présentValeurs
        failedpendingrunningready
      • input_count number · toujours présent
      • mime_type null|string · toujours présent
      • width null|number · toujours présent
      • height null|number · toujours présent
      • duration_seconds null|number · toujours présent
      • cost_usd null|number · toujours présent
      • error null|string · toujours présent
      • created_at string · toujours présent
    Lien vers ce point d'entrée

media-montage

  • /api/v1/create_media_montagePOSTwriteÉcriture. Monte de un à huit plans vidéo déjà rendus d'un même fil (identifiants de listMediaGenerations), dans l'ordre donné, chacun coupé à l'entrée et à la sortie (start, end en secondes), avec un enchaînement entre deux plans : cut, fondu enchaîné, fondu au noir, glissé ou zoom (transition, transition_seconds de 0,3 à 1). Un seul plan coupé fait une coupe. Une minute au plus une fois coupé ; les plans d'un autre cadrage sont réduits et bordés de noir dans celui du premier, le son est gardé quand un plan en a. Gratuit, aucun modèle n'est appelé. N'écrase rien : la vidéo montée naît en attente dans le fil des plans, et c'est advanceMediaGeneration qui la calcule, en une fois.
    Paramètres
    • clips object[] · obligatoire : Les plans, dans l'ordre où ils passent : de un à huit, une minute au plus une fois coupés. Un seul plan coupé fait une coupe.
      • id string · obligatoire : Identifiant d'une génération vidéo prête du même fil (listMediaGenerations). Le même plan peut revenir plusieurs fois, avec des coupes différentes.
      • start number : Point d'entrée, en secondes depuis le début du plan. 0 par défaut.
      • end number|null : Point de sortie, en secondes depuis le début du plan. Absent ou null : jusqu'au bout.
    • transition string : L'enchaînement entre deux plans : « cut » (défaut, aucun), « fade » (fondu enchaîné), « fadeblack » (fondu au noir), « slide » (le plan suivant pousse le précédent hors du cadre) ou « zoom » (le plan qui part s'enfonce pendant que le suivant apparaît).Valeurs
      cutfadefadeblackslidezoom
    • transition_seconds number : La durée de l'enchaînement, de 0,3 à 1 seconde (0,5 par défaut). Raccourcie d'elle-même entre deux plans trop courts pour la porter. Ignorée pour un cut.
    • prompt string : La légende du montage, telle que le fil l'affiche à la place d'une consigne. Sans elle, « Montage de N plans ».
    Rend object
    Champs
    • batch_id string · toujours présent
    • generations object[] · toujours présent
      • id string · toujours présent
      • conversation_id string · toujours présent
      • prompt string · toujours présent
      • format string · toujours présentValeurs
        imagevideo
      • orientation string · toujours présentValeurs
        postlandscapeportraitsquare
      • quality string · toujours présentValeurs
        highstandard
      • batch_id string · toujours présent
      • character_id null|string · toujours présent
      • preset null|string · toujours présent
      • model_prompt null|string · toujours présent
      • operation string · toujours présent
      • source_id null|string · toujours présent
      • params Record<string, MediaParamsValue6> · toujours présent
      • model string · toujours présent
      • status string · toujours présentValeurs
        failedpendingrunningready
      • input_count number · toujours présent
      • mime_type null|string · toujours présent
      • width null|number · toujours présent
      • height null|number · toujours présent
      • duration_seconds null|number · toujours présent
      • cost_usd null|number · toujours présent
      • error null|string · toujours présent
      • created_at string · toujours présent
    Lien vers ce point d'entrée
  • /api/v1/create_media_extensionPOSTwriteÉcriture. Prolonge une vidéo prête (source_id, une minute au plus) : sa dernière image devient la première d'un nouveau plan de 6, 10 ou 15 secondes, tourné par le même modèle selon la consigne de ce qui se passe ensuite (prompt), puis les deux sont recollés en une seule vidéo. Se paie au prix d'un plan de cette durée (le recollage est gratuit). N'écrase rien : la vidéo prolongée naît en attente dans le fil du plan, et advanceMediaGeneration la fait avancer (envoi, relecture du travail pendant trois à quatre minutes, recollage).
    Paramètres
    • source_id string · obligatoire : Identifiant de la vidéo à prolonger : une génération vidéo prête (listMediaGenerations), d'une minute au plus.
    • prompt string · obligatoire : Ce qui se passe ensuite, en toutes lettres : la suite part de la dernière image du plan.
    • duration number : Durée de la suite en secondes : 6 (défaut), 10 ou 15.Valeurs
      61015
    Rend object
    Champs
    • batch_id string · toujours présent
    • generations object[] · toujours présent
      • id string · toujours présent
      • conversation_id string · toujours présent
      • prompt string · toujours présent
      • format string · toujours présentValeurs
        imagevideo
      • orientation string · toujours présentValeurs
        postlandscapeportraitsquare
      • quality string · toujours présentValeurs
        highstandard
      • batch_id string · toujours présent
      • character_id null|string · toujours présent
      • preset null|string · toujours présent
      • model_prompt null|string · toujours présent
      • operation string · toujours présent
      • source_id null|string · toujours présent
      • params Record<string, MediaParamsValue7> · toujours présent
      • model string · toujours présent
      • status string · toujours présentValeurs
        failedpendingrunningready
      • input_count number · toujours présent
      • mime_type null|string · toujours présent
      • width null|number · toujours présent
      • height null|number · toujours présent
      • duration_seconds null|number · toujours présent
      • cost_usd null|number · toujours présent
      • error null|string · toujours présent
      • created_at string · toujours présent
    Lien vers ce point d'entrée

media-recipes

  • /api/v1/list_media_recipesGET · POSTreadLecture. Les recettes du Studio, par ordre alphabétique : un nom, une consigne (ses trous entre accolades compris, {product}) et les réglages d'une demande (format, cadrage, modèle, preset, nombre de rendus, durée, personnage ou produit). Pour refaire l'une d'elles, passer ses réglages à createMediaGeneration après avoir rempli les trous.
    Paramètres
    • limit integer : Combien de lignes rendre au plus (100 par défaut et au maximum).
    • offset integer : Combien de lignes sauter, pour aller chercher la suite de la liste.
    Rend object[]
    Chaque ligne porte
    • id string · toujours présent
    • name string · toujours présent
    • prompt string · toujours présent
    • format string · toujours présentValeurs
      imagevideo
    • orientation string · toujours présentValeurs
      postlandscapeportraitsquare
    • model string · toujours présent
    • preset string|null · toujours présentValeurs
      packshotlifestyleeditorialugcflatlayherodolly_indolly_outorbitcrane_upfpv_dronehandheldcrash_zoompanstaticmotion_graphicskinetic_type
    • count string · toujours présentValeurs
      1234
    • quality string|null · toujours présentValeurs
      highstandard
    • duration string|null · toujours présentValeurs
      10615
    • keyframe boolean · toujours présent
    • enhance boolean · toujours présent
    • character_id null|string · toujours présent
    • created_at string · toujours présent
    • updated_at string · toujours présent
    Lien vers ce point d'entrée
  • /api/v1/create_media_recipePOSTwriteÉcriture. Enregistre une recette : un nom, une consigne et les réglages d'une demande, pour la refaire plus tard depuis le Studio. Ne lance aucune génération et n'écrase rien. Refuse une combinaison qu'aucune demande ne pourrait envoyer (un preset d'un autre format, un modèle qui ne sert pas ce cadrage ou cette durée).
    Paramètres
    • name string · obligatoire : Le nom de la recette, tel qu'il se lit dans la bibliothèque du Studio.
    • prompt string · obligatoire : La consigne retenue, trous entre accolades compris ({product}, {color}) : elle se recopie dans le composeur, et rien ne part avant qu'on l'envoie.
    • format string · obligatoire : « image » ou « video ».Valeurs
      imagevideo
    • orientation string · obligatoire : Le cadrage : « landscape » (16:9), « portrait » (9:16), « post » (3:4), « square » (1:1).Valeurs
      landscapeportraitpostsquare
    • model string : « auto » (défaut) laisse le Studio choisir le modèle le moins cher qui rend bien. Sinon, pour une image : qwen/qwen-image-3 (Qwen Image 3), noki/editorial (Noki Éditorial), bytedance-seed/seedream-5-0-pro (Seedream 5.0 Pro), google/gemini-nano-banana-2.1 (Nano Banana 2.1), openai/gpt-image-2.5-flare (GPT Image 2.5), black-forest-labs/flux-3-image (Flux 3), recraft/recraft-v4.1 (Recraft V4.1) ; pour une vidéo : heygen/heygen-video-1 (HeyGen Video 1), kwaivgi/kling-v3.0-pro (Kling 3.0 Pro), google/veo-3.1-fast (Veo 3.1 Fast), bytedance/seedance-2.0 (Seedance 2.0), alibaba/wan-3.0 (Wan 3.0), minimax/hailuo-3 (Hailuo 3), runway/gen-4.5 (Runway Gen-4.5), x-ai/grok-imagine-video-1.5 (Grok Imagine 1.5). noki/editorial est le style maison (Seedream 5.0 Pro et une direction artistique photo éditoriale). Un modèle refuse ce qu'il ne sait pas rendre (format, cadrage, durée, nombre de références), avec une phrase qui dit quoi changer. Une vidéo à modèle choisi ignore quality.Valeurs
      autoqwen/qwen-image-3noki/editorialbytedance-seed/seedream-5-0-progoogle/gemini-nano-banana-2.1openai/gpt-image-2.5-flareblack-forest-labs/flux-3-imagerecraft/recraft-v4.1heygen/heygen-video-1kwaivgi/kling-v3.0-progoogle/veo-3.1-fastbytedance/seedance-2.0alibaba/wan-3.0minimax/hailuo-3runway/gen-4.5x-ai/grok-imagine-video-1.5
    • preset string : Un style d'image ou un mouvement de caméra, selon le format.Valeurs
      packshotlifestyleeditorialugcflatlayherodolly_indolly_outorbitcrane_upfpv_dronehandheldcrash_zoompanstaticmotion_graphicskinetic_type
    • count number : Combien de rendus la recette commande, de 1 (défaut) à 4.Valeurs
      1234
    • quality string : Vidéo seulement, quand le modèle est « auto » : « standard » ou « high ».Valeurs
      standardhigh
    • duration number : Vidéo seulement : 6, 10 ou 15 secondes.Valeurs
      61015
    • keyframe boolean : Vidéo seulement : dessiner d'abord une première image avec les références.
    • enhance boolean : false : la consigne part telle quelle, sans l'agent de consigne. Allumé par défaut.
    • character_id string : Le personnage ou le produit enregistré que la recette met en scène (listMediaCharacters).
    Rend object
    Champs
    • id string · toujours présent
    • name string · toujours présent
    • prompt string · toujours présent
    • format string · toujours présentValeurs
      imagevideo
    • orientation string · toujours présentValeurs
      postlandscapeportraitsquare
    • model string · toujours présent
    • preset string|null · toujours présentValeurs
      packshotlifestyleeditorialugcflatlayherodolly_indolly_outorbitcrane_upfpv_dronehandheldcrash_zoompanstaticmotion_graphicskinetic_type
    • count string · toujours présentValeurs
      1234
    • quality string|null · toujours présentValeurs
      highstandard
    • duration string|null · toujours présentValeurs
      10615
    • keyframe boolean · toujours présent
    • enhance boolean · toujours présent
    • character_id null|string · toujours présent
    • created_at string · toujours présent
    • updated_at string · toujours présent
    Lien vers ce point d'entrée
  • /api/v1/delete_media_recipePOSTdestructiveSuppression définitive, irréversible. Supprime une recette. Les demandes qu'elle a servi à écrire et leurs rendus restent dans leurs fils.
    Paramètres
    • id string · obligatoire : Identifiant de la recette.
    Rend object
    Champs
    • id string · toujours présent
    Lien vers ce point d'entrée

brand-kits

  • /api/v1/get_client_brand_kitGET · POSTreadLecture. La charte de marque d'un client pour le Studio : sa palette (nom et hexadécimal), ses polices (titre, texte), ce qu'un visuel doit faire et ne doit jamais faire, son ton, et s'il a un logo. null s'il n'en a pas encore. Elle s'ajoute à chaque demande d'un fil rattaché à ce client.
    Paramètres
    • client_id string · obligatoire : Identifiant de la fiche client, tel que rendu par list_clients.
    Rend null|object
    Lien vers ce point d'entrée
  • /api/v1/upsert_client_brand_kitPOSTwriteÉcriture. Écrit la charte de marque d'un client : la crée au premier appel, la corrige ensuite. Ce qui n'est pas envoyé reste ; les couleurs (huit au plus) et les polices s'envoient au complet et remplacent les précédentes ; un texte null ou vide l'efface ; logo en data URL ou par lien https:// remplace l'ancien, null le retire.
    Paramètres
    • client_id string · obligatoire : Identifiant de la fiche client, tel que rendu par list_clients.
    • colors object[] : La palette au complet, 8 couleurs au plus : la liste envoyée remplace la précédente.
      • name string · obligatoire : Le nom de la couleur (« Sapin », « Crème »). Vide : son hexadécimal en tient lieu.
      • hex string · obligatoire : La couleur en hexadécimal, #rrggbb (#rgb est accepté).
    • fonts object[] : Les polices au complet, une par rôle : la liste envoyée remplace la précédente.
      • role string · obligatoire : « titre » pour les titres, « texte » pour le texte courant.Valeurs
        titretexte
      • family string · obligatoire : Le nom de la famille (« Playfair Display »). Vide : pas de police pour ce rôle.
    • rules_do string|null : Ce que chaque visuel doit faire (« le produit toujours au centre »). null ou vide l'efface.
    • rules_dont string|null : Ce qu'aucun visuel ne doit faire (« jamais de feuille de cannabis »). null ou vide l'efface.
    • tone string|null : Le ton et l'ambiance de la marque, en une phrase. null ou vide l'efface.
    • logo string|null : Le logo, en data URL ou par son lien public https:// ; il est réencodé en WebP, transparence gardée. null le retire, absent le laisse.
    Rend object
    Champs
    • client_id string · toujours présent
    • colors object[] · toujours présent
      • name string · toujours présent
      • hex string · toujours présent
    • fonts object[] · toujours présent
      • role string · toujours présentValeurs
        titretexte
      • family string · toujours présent
    • rules_do null|string · toujours présent
    • rules_dont null|string · toujours présent
    • tone null|string · toujours présent
    • has_logo boolean · toujours présent
    • updated_at string · toujours présent
    Lien vers ce point d'entrée

media-publish

  • /api/v1/send_media_to_publicationPOSTwriteÉcriture. Envoie un rendu prêt du Studio dans les Publications d'un client : le fichier est COPIÉ dans les fichiers du client, puis posé dans un contenu neuf (title, scheduled_on facultatif) ou à la fin du carrousel d'un contenu existant de ce client (content_id). status « to_approve » soumet le contenu au client et invite ses contacts à le relire ; « draft » (défaut pour un contenu neuf) le garde entre nous. Refusé si le module Publications est fermé. Rend content_id, à ouvrir par /go/content/<id>.
    Paramètres
    • generation_id string · obligatoire : Le rendu à envoyer, prêt (listMediaGenerations). Image ou vidéo.
    • client_id string · obligatoire : La fiche client (list_clients) dont le contenu paraîtra : le rendu est copié dans ses fichiers.
    • content_id string : Un contenu existant de ce client (list_social_contents) : le rendu s'ajoute à la fin de son carrousel. Absent : un contenu neuf est créé, et title est alors requis.
    • title string : Le titre du contenu neuf, 300 caractères au plus. Ignoré avec content_id.
    • scheduled_on string|null : Le jour de parution prévu du contenu neuf, AAAA-MM-JJ. Ignoré avec content_id.
    • status string : « draft » (défaut) : le contenu reste entre nous. « to_approve » : il part en validation, et les contacts du client sont invités à le relire. Sur un contenu existant, absent ne change pas son étape.Valeurs
      draftto_approve
    Rend object
    Champs
    • content_id string · toujours présent
    • file_id string · toujours présent
    • generation_id string · toujours présent
    Lien vers ce point d'entrée

media-insights

  • /api/v1/analyze_media_generationPOSTwriteÉcriture. Prédit la viralité d'un rendu prêt pour un réseau (instagram_feed, reels_tiktok, story, facebook_ad, website) : un modèle de vision regarde l'image ou la vidéo et rend un score sur 100, six sous-scores (accroche, lisibilité, clarté du produit, émotion, adéquation au réseau, règles publicitaires du CBD), des points forts, trois améliorations concrètes, une accroche et une légende suggérées. C'est une ESTIMATION fondée sur les bonnes pratiques du réseau, pas une mesure : la dire comme telle. Environ un demi-centime ; chaque appel range une nouvelle analyse sans écraser les précédentes, relues par listMediaAnalyses. « basis: frame » dit qu'une vidéo a été jugée sur une image.
    Paramètres
    • id string · obligatoire : Identifiant de la génération à analyser : un rendu prêt.
    • network string · obligatoire : Où le rendu paraîtra : « instagram_feed » (fil Instagram), « reels_tiktok » (Reels ou TikTok), « story », « facebook_ad » (publicité Meta) ou « website » (site web).Valeurs
      instagram_feedreels_tiktokstoryfacebook_adwebsite
    Rend object
    Champs
    • id string · toujours présent
    • generation_id string · toujours présent
    • network string · toujours présentValeurs
      instagram_feedreels_tiktokstoryfacebook_adwebsite
    • result object · toujours présent
      • score number · toujours présent
      • scores object · toujours présent
        • attention number · toujours présent
        • readability number · toujours présent
        • product_clarity number · toujours présent
        • emotion number · toujours présent
        • platform_fit number · toujours présent
        • compliance number · toujours présent
      • strengths string[] · toujours présent
      • improvements string[] · toujours présent
      • caption string · toujours présent
      • hook string · toujours présent
      • basis string · toujours présentValeurs
        imagevideoframe
    • model string · toujours présent
    • cost_usd null|number · toujours présent
    • created_at string · toujours présent
    Lien vers ce point d'entrée
  • /api/v1/list_media_analysesGET · POSTreadLecture. Les analyses de viralité déjà faites pour un rendu, de la plus récente à la plus ancienne, avec leur réseau, leurs scores et leurs suggestions. À lire avant de relancer analyzeMediaGeneration : une analyse gardée ne se repaie pas.
    Paramètres
    • generation_id string · obligatoire : Identifiant de la génération dont on relit les analyses.
    • limit integer : Combien de lignes rendre au plus (50 par défaut et au maximum).
    • offset integer : Combien de lignes sauter, pour aller chercher la suite de la liste.
    Rend object[]
    Chaque ligne porte
    • id string · toujours présent
    • generation_id string · toujours présent
    • network string · toujours présentValeurs
      instagram_feedreels_tiktokstoryfacebook_adwebsite
    • result object · toujours présent
      • score number · toujours présent
      • scores object · toujours présent
        • attention number · toujours présent
        • readability number · toujours présent
        • product_clarity number · toujours présent
        • emotion number · toujours présent
        • platform_fit number · toujours présent
        • compliance number · toujours présent
      • strengths string[] · toujours présent
      • improvements string[] · toujours présent
      • caption string · toujours présent
      • hook string · toujours présent
      • basis string · toujours présentValeurs
        imagevideoframe
    • model string · toujours présent
    • cost_usd null|number · toujours présent
    • created_at string · toujours présent
    Lien vers ce point d'entrée

media-spend

  • /api/v1/get_media_spendGET · POSTreadLecture. Ce que le Studio a dépensé aujourd'hui et cette semaine (heure de Paris, semaine du lundi), en dollars facturés par les fournisseurs, avec les plafonds de l'agence et ce qu'il reste avant eux (limit_usd et remaining_usd à null : aucun plafond). À lire avant de commander une série coûteuse : une demande qui ferait dépasser un plafond est refusée, et un rendu commandé ne part plus une fois le plafond atteint. Un rendu effacé reste compté.

    Aucun paramètre.

    Rend object
    Champs
    • day object · toujours présent
      • spent_usd number · toujours présent
      • limit_usd null|number · toujours présent
      • remaining_usd null|number · toujours présent
      • since string · toujours présent
    • week object · toujours présent
      • spent_usd number · toujours présent
      • limit_usd null|number · toujours présent
      • remaining_usd null|number · toujours présent
      • since string · toujours présent
    Lien vers ce point d'entrée
  • /api/v1/set_media_spend_limitsPOSTwriteÉcriture. Pose les plafonds de dépense du Studio, par jour et par semaine, en dollars. Les deux s'envoient ensemble et remplacent les précédents : null retire un plafond. Le plafond du jour ne peut pas dépasser celui de la semaine. Rend les compteurs avec les plafonds neufs.
    Paramètres
    • daily_usd number|null · obligatoire : Plafond de dépense du Studio par jour (de minuit à minuit, heure de Paris), en dollars (ce que les fournisseurs facturent). null pour n'en poser aucun.
    • weekly_usd number|null · obligatoire : Plafond de dépense du Studio par semaine (du lundi au dimanche, heure de Paris), en dollars (ce que les fournisseurs facturent). null pour n'en poser aucun.
    Rend object
    Champs
    • day object · toujours présent
      • spent_usd number · toujours présent
      • limit_usd null|number · toujours présent
      • remaining_usd null|number · toujours présent
      • since string · toujours présent
    • week object · toujours présent
      • spent_usd number · toujours présent
      • limit_usd null|number · toujours présent
      • remaining_usd null|number · toujours présent
      • since string · toujours présent
    Lien vers ce point d'entrée

media-ads

  • /api/v1/create_media_ad_from_productPOSTwriteÉcriture. Fait une publicité depuis le lien public d'une fiche produit (https://) : le serveur lit la page (nom, description, prix, photo principale), un modèle écrit le concept (une accroche, 2 à 4 plans distincts du même produit, un texte à l'écran par plan, une légende), puis chaque plan devient une demande du Studio avec la photo du produit en référence (une vidéo part d'une vraie scène dessinée d'abord avec le produit). Rend le concept, le produit lu et les générations en attente : fais-les avancer avec advanceMediaGeneration comme toute demande. Coût indicatif : le prix de chaque plan (0,03 $ la seconde en vidéo standard, plus 0,035 $ de première image ; 0,03 $ une image). N'écrase rien.
    Paramètres
    • url string · obligatoire : L'adresse publique de la fiche produit, en https:// (une boutique Shopify, WooCommerce, PrestaShop…). Le serveur lit son nom, sa description, son prix et sa photo principale.
    • conversation_id string : La conversation du Studio où poser les plans. Sans lui, la plus récemment nourrie, ou une nouvelle.
    • format string : « video » (défaut) pour des plans vidéo, « image » pour une série de visuels.Valeurs
      imagevideo
    • orientation string : Le cadrage : « portrait » (défaut, 9:16, Reels, TikTok, story), « post » (3:4), « square » (1:1) ou « landscape » (16:9).Valeurs
      landscapeportraitpostsquare
    • shots number : Combien de plans : 2, 3 (défaut) ou 4. Chacun est une génération à part, payée à part.Valeurs
      234
    • duration number : Vidéo seulement : la durée de chaque plan en secondes, 6 (défaut), 10 ou 15.Valeurs
      61015
    • quality string : Vidéo seulement : « standard » (défaut, 720p) ou « high » (2K).Valeurs
      standardhigh
    • notes string : L'angle voulu, en une ou deux phrases (la cible, le ton, ce qu'il faut mettre en avant). Facultatif.
    Rend object
    Champs
    • conversation_id string · toujours présent
    • product object · toujours présent
      • url string · toujours présent
      • title null|string · toujours présent
      • description null|string · toujours présent
      • price null|string · toujours présent
      • brand null|string · toujours présent
      • image null|string · toujours présent
    • concept object · toujours présent
      • hook string · toujours présent
      • shots object[] · toujours présent
        • prompt string · toujours présent
        • text null|string · toujours présent
      • caption string · toujours présent
    • generations object[] · toujours présent
      • id string · toujours présent
      • conversation_id string · toujours présent
      • prompt string · toujours présent
      • format string · toujours présentValeurs
        imagevideo
      • orientation string · toujours présentValeurs
        postlandscapeportraitsquare
      • quality string · toujours présentValeurs
        highstandard
      • batch_id string · toujours présent
      • character_id null|string · toujours présent
      • preset null|string · toujours présent
      • model_prompt null|string · toujours présent
      • operation string · toujours présent
      • source_id null|string · toujours présent
      • params Record<string, MediaParamsValue8> · toujours présent
      • model string · toujours présent
      • status string · toujours présentValeurs
        failedpendingrunningready
      • input_count number · toujours présent
      • mime_type null|string · toujours présent
      • width null|number · toujours présent
      • height null|number · toujours présent
      • duration_seconds null|number · toujours présent
      • cost_usd null|number · toujours présent
      • error null|string · toujours présent
      • created_at string · toujours présent
    Lien vers ce point d'entrée

notes

  • /api/v1/list_admin_notesGET · POSTreadLecture. Notes de l'équipe : nom, fiche client rattachée, dossier, auteur, dates, nombre de commentaires, date de publication au client (null si la note n'est pas partie). Sans le corps des notes, mais search le fouille avec le nom. Sans client_id, rend toutes les notes ; avec null, celles qui ne sont rattachées à aucune fiche. Rend aussi l'arbre entier des dossiers : un dossier dont client_id est posé est dans le dossier de cette fiche (au premier niveau quand parent_id est vide), et une note liée à un client sans folder_id est à la racine du dossier de ce client.
    Paramètres
    • client_id string|null : Identifiant de la fiche client, tel que rendu par list_clients : ses seules notes. null : les notes liées à aucune fiche. Absent : toutes.
    • search string : Ne garde que les lignes dont le nom ou le corps contient ce texte, sans tenir compte de la casse (les accents, eux, comptent).
    • limit integer : Combien de lignes rendre au plus (300 par défaut et au maximum).
    • offset integer : Combien de lignes sauter, pour aller chercher la suite de la liste.
    Rend object
    Champs
    • client_id null|string · toujours présent
    • folders object[] · toujours présent
      • id string · toujours présent
      • parent_id null|string · toujours présent
      • name string · toujours présent
      • client_id null|string · toujours présent
      • created_at string · toujours présent
    • notes object[] · toujours présent
      • created_at string · toujours présent
      • id string · toujours présent
      • updated_at string · toujours présent
      • created_by null|string · toujours présent
      • name string · toujours présent
      • position null|number · toujours présent
      • client_id null|string · toujours présent
      • icon null|object · toujours présent
        Forme 1 (au choix)
        • kind "emoji" · toujours présent
        • emoji string · toujours présent
        Forme 2 (au choix)
        • kind "icon" · toujours présent
        • name string · toujours présentValeurs
          calendarstardocumentteambagcartshopboxprice-tagsalegiftdeliverycardmoneybillgallerycamerachecklistnotebookpenchatletterleafdropdropperbottlecosmeticflametest-tubeheartrocketlightbulbmap-pointshieldchartsettingsflagmedalglobetarget
        • tone string · toujours présentValeurs
          duotonemono
        • color stringValeurs
          bluevioletgreenyelloworangered
      • folder_id null|string · toujours présent
      • client_name null|string · toujours présent
      • created_by_name null|string · toujours présent
      • comment_count number · toujours présent
      • published_at null|string · toujours présent
    Lien vers ce point d'entrée
  • /api/v1/get_admin_noteGET · POSTreadLecture. Une note, corps Markdown compris : ce qui s'écrit en ce moment, l'instantané publié au client s'il y en a un, ses médias, et l'annuaire des personnes que son fil peut interpeller. Une longue note (jusqu'à 100 000 caractères) se rend par tranches : tant que note.content_next_offset n'est pas nul, le texte continue, et il faut rappeler l'outil avec content_offset égal à cette valeur, jusqu'à null, avant de répondre sur la note ou de la modifier. Quand la fiche ne tient pas d'un bloc, l'instantané publié identique au texte de travail porte same_as_note au lieu de son texte ; s'il diffère, il porte content_chars, et se lit par published_offset (0 pour commencer), la suite par publication.content_next_offset.
    Paramètres
    • id string · obligatoire : Identifiant de la note, tel que rendu par list_admin_notes.
    • content_offset integer · = 0 : Où reprendre la lecture du texte de travail, en caractères : la valeur de note.content_next_offset rendue par l'appel précédent.
    • published_offset integer : Lire l'instantané publié au client plutôt que le texte de travail, à partir de ce rang (0 pour commencer, puis publication.content_next_offset). Utile seulement quand il diffère du texte de travail.
    Rend object
    Champs
    • note object · toujours présent
      • id string · toujours présent
      • client_id null|string · toujours présent
      • folder_id null|string · toujours présent
      • name string · toujours présent
      • content string · toujours présent
      • icon null|object · toujours présent
        Forme 1 (au choix)
        • kind "emoji" · toujours présent
        • emoji string · toujours présent
        Forme 2 (au choix)
        • kind "icon" · toujours présent
        • name string · toujours présentValeurs
          calendarstardocumentteambagcartshopboxprice-tagsalegiftdeliverycardmoneybillgallerycamerachecklistnotebookpenchatletterleafdropdropperbottlecosmeticflametest-tubeheartrocketlightbulbmap-pointshieldchartsettingsflagmedalglobetarget
        • tone string · toujours présentValeurs
          duotonemono
        • color stringValeurs
          bluevioletgreenyelloworangered
      • position null|number · toujours présent
      • created_by null|string · toujours présent
      • created_at string · toujours présent
      • updated_at string · toujours présent
    • publication null|object · toujours présent
      • note_id string · toujours présent
      • client_id string · toujours présent
      • name string · toujours présent
      • content string · toujours présent
      • published_at string · toujours présent
    • created_by_name null|string · toujours présent
    • media object[] · toujours présent
      • id string · toujours présent
      • client_id null|string · toujours présent
      • name string · toujours présent
      • mime_type string · toujours présent
      • size_bytes number · toujours présent
      • has_thumb boolean · toujours présent
      • folder_id null|string · toujours présent
      • shared_with_client boolean · toujours présent
      • created_by null|string · toujours présent
      • created_side string · toujours présentValeurs
        clientagency
      • created_at string · toujours présent
    • current_user_id string · toujours présent
    • team object[] · toujours présent
      • user_id string · toujours présent
      • email null|string · toujours présent
      • name null|string · toujours présent
      • avatar_url null|string · toujours présent
    • members object[] · toujours présent
      • user_id string · toujours présent
      • email null|string · toujours présent
      • name null|string · toujours présent
      • avatar_url null|string · toujours présent
    • folders object[] · toujours présent
      • id string · toujours présent
      • parent_id null|string · toujours présent
      • name string · toujours présent
      • client_id null|string · toujours présent
      • created_at string · toujours présent
    Lien vers ce point d'entrée
  • /api/v1/create_admin_notePOSTwriteÉcriture. Ouvre une note, rattachée ou non à une fiche client. Une note liée à un client se range dans le dossier de ce client : à sa racine par défaut, ou dans folder_id, qui doit alors être un dossier de ce client. Un folder_id seul lie la note au client de ce dossier. Le client ne la voit pas : le corps Markdown peut être fourni d'emblée ou écrit ensuite par updateAdminNote, puis remis par publishAdminNote. Une page HTML (une présentation) s'y intègre par le bloc que rend createEditorHtml, et une vidéo, un document partagé ou toute page web par une ligne <div data-type="url-embed" data-url="https://…"></div>, que le lecteur charge d'un clic.
    Paramètres
    • name string · obligatoire : Nom de la note.
    • client_id string|null : Identifiant de la fiche client dont parle la note, tel que rendu par list_clients. Absent ou null : une note d'équipe.
    • folder_id string|null : Dossier du carnet où ranger la note, tel que rendu par list_admin_notes ; il la lie au client de ce dossier. Absent ou null : la racine.
    • content string : Corps de la note, en Markdown. Absent : une note vide, à écrire ensuite par update_admin_note.
    • icon object|null : Icône posée à côté du nom : un emoji, ou un pictogramme de la maison et sa teinte. Absente : la tuile commune des notes.
      Forme 1 (au choix)
      • kind "emoji" · obligatoire : emoji : l'icône est un emoji.
      • emoji string · obligatoire : Un seul emoji, sans texte autour.
      Forme 2 (au choix)
      • kind "icon" · obligatoire : icon : l'icône est un pictogramme de la maison.
      • name string · obligatoire : Nom du pictogramme, parmi les quarante proposés (bag, star, rocket...).Valeurs
        bagcartshopboxprice-tagsalegiftdeliverycardmoneybillgallerycameradocumentchecklistnotebookpenchatletterleafdropdropperbottlecosmeticflametest-tubestarheartrocketlightbulbcalendarmap-pointteamshieldchartsettingsflagmedalglobetarget
      • tone string · obligatoire : duotone (la forme et un second ton) ou mono (une seule encre).Valeurs
        duotonemono
      • color string : Teinte du pictogramme : blue, violet, green, yellow, orange ou red. Absente : à l'encre.Valeurs
        bluevioletgreenyelloworangered
    Rend object
    Champs
    • id string · toujours présent
    • client_id null|string · toujours présent
    • folder_id null|string · toujours présent
    • name string · toujours présent
    • content string · toujours présent
    • icon null|object · toujours présent
      Forme 1 (au choix)
      • kind "emoji" · toujours présent
      • emoji string · toujours présent
      Forme 2 (au choix)
      • kind "icon" · toujours présent
      • name string · toujours présentValeurs
        calendarstardocumentteambagcartshopboxprice-tagsalegiftdeliverycardmoneybillgallerycamerachecklistnotebookpenchatletterleafdropdropperbottlecosmeticflametest-tubeheartrocketlightbulbmap-pointshieldchartsettingsflagmedalglobetarget
      • tone string · toujours présentValeurs
        duotonemono
      • color stringValeurs
        bluevioletgreenyelloworangered
    • position null|number · toujours présent
    • created_by null|string · toujours présent
    • created_at string · toujours présent
    • updated_at string · toujours présent
    Lien vers ce point d'entrée
  • /api/v1/update_admin_notePOSTwriteÉcriture. Écrit une note : son nom, son corps Markdown (en entier par content, ou par passages avec edits, qu'on préfère dès que la note existe et qu'on n'en change qu'une partie : rien d'autre n'est réécrit), son icône (un emoji, ou un pictogramme de la maison et sa teinte, null pour la retirer ; elle reste à l'équipe et ne compte pas comme une modification à republier), la fiche client qu'elle vise ou son dossier. Mise à jour partielle, les champs absents restent en place ; client_id à null détache la note de sa fiche. Fiche et dossier vont ensemble : changer de fiche sort la note de son dossier pour la racine du dossier de sa nouvelle fiche, ranger dans un dossier la lie au client de ce dossier, et nommer les deux exige qu'ils s'accordent. Rien n'arrive au client tant que publishAdminNote n'a pas été rappelé, et changer la fiche d'une note publiée la dépublie. Une page HTML (une présentation) s'y intègre par le bloc que rend createEditorHtml, recopié sur sa propre ligne.
    Paramètres
    • id string · obligatoire : Identifiant de la note, tel que rendu par list_admin_notes.
    • name string : Nouveau nom de la note. Absent : laissé tel quel.
    • client_id string|null : Identifiant de la fiche client, tel que rendu par list_clients. null détache la note de sa fiche. Absent : laissé tel quel.
    • folder_id string|null : Dossier du carnet, tel que rendu par list_admin_notes ; il lie la note au client de ce dossier. null : la racine. Absent : laissé tel quel.
    • content string : Nouveau corps de la note, en Markdown, qui remplace le précédent en entier. Pour changer quelques passages d'une note existante, préférer edits. Absent : laissé tel quel.
    • edits object[] : Remplacements ciblés dans le corps, sans le réécrire : chaque old_text, recopié à l'identique du corps lu par get_admin_note, doit y figurer une seule fois, et new_text prend sa place. Appliqués dans l'ordre, tout ou rien : un passage introuvable ou en double et rien n'est écrit. Pour ajouter, citer le passage voisin et le reprendre dans new_text ; pour retirer, new_text vide. Exclut content.
      • old_text string · obligatoire : Passage exact du corps actuel, unique dans la note.
      • new_text string · obligatoire : Ce qui le remplace. Vide : le passage est retiré.
    • icon object|null : Icône posée à côté du nom : un emoji, ou un pictogramme de la maison et sa teinte. null la retire. Absent : laissé tel quel. Ne compte pas comme une modification à republier.
      Forme 1 (au choix)
      • kind "emoji" · obligatoire : emoji : l'icône est un emoji.
      • emoji string · obligatoire : Un seul emoji, sans texte autour.
      Forme 2 (au choix)
      • kind "icon" · obligatoire : icon : l'icône est un pictogramme de la maison.
      • name string · obligatoire : Nom du pictogramme, parmi les quarante proposés (bag, star, rocket...).Valeurs
        bagcartshopboxprice-tagsalegiftdeliverycardmoneybillgallerycameradocumentchecklistnotebookpenchatletterleafdropdropperbottlecosmeticflametest-tubestarheartrocketlightbulbcalendarmap-pointteamshieldchartsettingsflagmedalglobetarget
      • tone string · obligatoire : duotone (la forme et un second ton) ou mono (une seule encre).Valeurs
        duotonemono
      • color string : Teinte du pictogramme : blue, violet, green, yellow, orange ou red. Absente : à l'encre.Valeurs
        bluevioletgreenyelloworangered
    Rend object
    Champs
    • id string · toujours présent
    • client_id null|string · toujours présent
    • folder_id null|string · toujours présent
    • name string · toujours présent
    • content string · toujours présent
    • icon null|object · toujours présent
      Forme 1 (au choix)
      • kind "emoji" · toujours présent
      • emoji string · toujours présent
      Forme 2 (au choix)
      • kind "icon" · toujours présent
      • name string · toujours présentValeurs
        calendarstardocumentteambagcartshopboxprice-tagsalegiftdeliverycardmoneybillgallerycamerachecklistnotebookpenchatletterleafdropdropperbottlecosmeticflametest-tubeheartrocketlightbulbmap-pointshieldchartsettingsflagmedalglobetarget
      • tone string · toujours présentValeurs
        duotonemono
      • color stringValeurs
        bluevioletgreenyelloworangered
    • position null|number · toujours présent
    • created_by null|string · toujours présent
    • created_at string · toujours présent
    • updated_at string · toujours présent
    Lien vers ce point d'entrée
  • /api/v1/publish_admin_notePOSTwriteÉcriture. Publie une note au client de sa fiche : elle devient un rapport, lisible dans son espace, fil de commentaires et médias compris. Refusé si la note n'est rattachée à aucune fiche. Sans versions conservées, la dernière publication fait foi.
    Paramètres
    • id string · obligatoire : Identifiant de la note, tel que rendu par list_admin_notes.
    Rend object
    Champs
    • note_id string · toujours présent
    • client_id string · toujours présent
    • name string · toujours présent
    • content string · toujours présent
    • published_at string · toujours présent
    Lien vers ce point d'entrée
  • /api/v1/unpublish_admin_notePOSTwriteÉcriture. Retire une note de l'espace de son client : elle redevient interne, son fil se referme et ses médias avec. Rien n'est supprimé, republier la rend d'un coup.
    Paramètres
    • id string · obligatoire : Identifiant de la note, tel que rendu par list_admin_notes.
    Rend object
    Champs
    • id string · toujours présent
    Lien vers ce point d'entrée
  • /api/v1/delete_admin_notePOSTdestructiveSuppression définitive, irréversible. Supprime définitivement une note, tout son fil de commentaires, et ce que le client en lisait si elle était publiée.
    Paramètres
    • id string · obligatoire : Identifiant de la note, tel que rendu par list_admin_notes.
    Rend object
    Champs
    • id string · toujours présent
    Lien vers ce point d'entrée
  • /api/v1/list_note_commentsGET · POSTreadLecture. Fil d'une note, du plus ancien message au plus récent.
    Paramètres
    • note_id string · obligatoire : Identifiant de la note, tel que rendu par list_admin_notes.
    • limit integer : Combien de lignes rendre au plus (300 par défaut et au maximum).
    • offset integer : Combien de lignes sauter, pour aller chercher la suite de la liste.
    Rend object[]
    Chaque ligne porte
    • parent_id null|string · toujours présent
    • anchor_exact null|string · toujours présent
    • anchor_prefix null|string · toujours présent
    • anchor_suffix null|string · toujours présent
    • resolved_at null|string · toujours présent
    • resolved_by null|string · toujours présent
    • resolved_by_name null|string · toujours présent
    • id string · toujours présent
    • author_id null|string · toujours présent
    • author_name string · toujours présent
    • author_avatar_url null|string · toujours présent
    • author_side string · toujours présentValeurs
      clientteam
    • body string · toujours présent
    • created_at string · toujours présent
    • edited_at null|string · toujours présent
    • shared_with_client stringValeurs
      falsetrue
    Lien vers ce point d'entrée
  • /api/v1/add_note_commentPOSTwriteÉcriture. Écrit un message dans le fil d'une note, au nom de l'administrateur de la clé. Sur une note publiée, le client le lit ; « [@Nom](mention:uuid) » notifie la personne nommée si elle voit la note. « parent_id » range le message sous une question déjà posée ; « anchor » l'attache à un passage du texte, en reprenant le passage exact et ce qui l'entoure.
    Paramètres
    • note_id string · obligatoire : Identifiant de la note, tel que rendu par list_admin_notes.
    • body string · obligatoire : Texte du message. Une mention s'écrit « [@Nom](mention:identifiant) », l'identifiant pris dans l'annuaire de get_admin_note.
    • parent_id string|null : Message auquel celui-ci répond, tel que rendu par list_note_comments ; la réponse se range sous le premier message de son fil. Absent ou null : un nouveau fil.
    • anchor object|null : Passage du corps de la note que vise un nouveau fil. Ignoré pour une réponse. Absent ou null : le message ne vise aucun passage.
      • exact string · obligatoire : Texte exact du passage visé, tel qu'il se lit dans le document, 300 caractères au plus.
      • prefix string · = "" : Texte qui précède immédiatement le passage, pour le distinguer d'une autre occurrence. Vide par défaut.
      • suffix string · = "" : Texte qui suit immédiatement le passage, même usage que prefix. Vide par défaut.
    Rend object
    Champs
    • parent_id null|string · toujours présent
    • anchor_exact null|string · toujours présent
    • anchor_prefix null|string · toujours présent
    • anchor_suffix null|string · toujours présent
    • resolved_at null|string · toujours présent
    • resolved_by null|string · toujours présent
    • resolved_by_name null|string · toujours présent
    • id string · toujours présent
    • author_id null|string · toujours présent
    • author_name string · toujours présent
    • author_avatar_url null|string · toujours présent
    • author_side string · toujours présentValeurs
      clientteam
    • body string · toujours présent
    • created_at string · toujours présent
    • edited_at null|string · toujours présent
    • shared_with_client stringValeurs
      falsetrue
    Lien vers ce point d'entrée
  • /api/v1/resolve_note_commentPOSTwriteÉcriture. Clôt la question posée par un fil de note (resolved: true) ou la rouvre (false). Se pose sur le premier message d'un fil, jamais sur une réponse, et ne notifie personne.
    Paramètres
    • comment_id string · obligatoire : Identifiant du premier message du fil, tel que rendu par list_note_comments.
    • resolved boolean · obligatoire : true clôt la question posée par le fil, false la rouvre.
    Rend object
    Champs
    • parent_id null|string · toujours présent
    • anchor_exact null|string · toujours présent
    • anchor_prefix null|string · toujours présent
    • anchor_suffix null|string · toujours présent
    • resolved_at null|string · toujours présent
    • resolved_by null|string · toujours présent
    • resolved_by_name null|string · toujours présent
    • id string · toujours présent
    • author_id null|string · toujours présent
    • author_name string · toujours présent
    • author_avatar_url null|string · toujours présent
    • author_side string · toujours présentValeurs
      clientteam
    • body string · toujours présent
    • created_at string · toujours présent
    • edited_at null|string · toujours présent
    • shared_with_client stringValeurs
      falsetrue
    Lien vers ce point d'entrée
  • /api/v1/update_note_commentPOSTwriteÉcriture. Corrige un message du fil d'une note, écrit par le compte au nom duquel la clé MCP agit. Un message écrit par quelqu'un d'autre est refusé par le moteur. Le fil affichera « modifié » à côté de sa date. Corriger ne change pas le public du message : ce qui a été écrit avant la publication de la note reste interne.
    Paramètres
    • note_id string · obligatoire : Identifiant de la note, tel que rendu par list_admin_notes.
    • comment_id string · obligatoire : Identifiant du message, tel que rendu par list_note_comments.
    • body string · obligatoire : Nouveau texte du message, qui remplace l'ancien. Une mention s'écrit « [@Nom](mention:identifiant) ».
    Rend object
    Champs
    • parent_id null|string · toujours présent
    • anchor_exact null|string · toujours présent
    • anchor_prefix null|string · toujours présent
    • anchor_suffix null|string · toujours présent
    • resolved_at null|string · toujours présent
    • resolved_by null|string · toujours présent
    • resolved_by_name null|string · toujours présent
    • id string · toujours présent
    • author_id null|string · toujours présent
    • author_name string · toujours présent
    • author_avatar_url null|string · toujours présent
    • author_side string · toujours présentValeurs
      clientteam
    • body string · toujours présent
    • created_at string · toujours présent
    • edited_at null|string · toujours présent
    • shared_with_client stringValeurs
      falsetrue
    Lien vers ce point d'entrée
  • /api/v1/delete_note_commentPOSTdestructiveSuppression définitive, irréversible. Supprime définitivement un message du fil d'une note, écrit par le compte au nom duquel la clé MCP agit. Refusé pour un message auquel on a répondu : il se corrige, il ne se supprime plus.
    Paramètres
    • note_id string · obligatoire : Identifiant de la note, tel que rendu par list_admin_notes.
    • comment_id string · obligatoire : Identifiant du message, tel que rendu par list_note_comments.
    Rend object
    Champs
    • id string · toujours présent
    Lien vers ce point d'entrée

note-folders

  • /api/v1/create_note_folderPOSTwriteÉcriture. Crée un dossier dans le carnet interne : dans un autre dossier (parent_id, dont il prend l'arbre), au premier niveau du dossier d'un client (client_id sans parent_id), ou à la racine de l'équipe. Deux dossiers de même nom ne cohabitent pas au même endroit.
    Paramètres
    • parent_id string|null : Dossier parent, tel que rendu par list_admin_notes, dont le nouveau dossier prend l'arbre. Absent ou null : une racine.
    • client_id string|null : Sans parent_id seulement : identifiant de la fiche client (list_clients) dont on ouvre un dossier de premier niveau. Absent ou null : la racine de l'équipe.
    • name string · obligatoire : Nom du nouveau dossier, unique parmi ses voisins.
    Rend object
    Champs
    • id string · toujours présent
    • parent_id null|string · toujours présent
    • name string · toujours présent
    • client_id null|string · toujours présent
    • created_at string · toujours présent
    Lien vers ce point d'entrée
  • /api/v1/rename_note_folderPOSTwriteÉcriture. Renomme un dossier du carnet interne. Ce qu'il contient n'est pas touché et ne change pas de place.
    Paramètres
    • id string · obligatoire : Identifiant du dossier, tel que rendu par list_admin_notes.
    • name string · obligatoire : Nouveau nom du dossier, unique parmi ses voisins.
    Rend object
    Champs
    • id string · toujours présent
    • parent_id null|string · toujours présent
    • name string · toujours présent
    • client_id null|string · toujours présent
    • created_at string · toujours présent
    Lien vers ce point d'entrée
  • /api/v1/delete_note_folderPOSTwriteÉcriture. Supprime un dossier du carnet interne. Aucune note n'est supprimée : son contenu, sous-dossiers compris, remonte dans le dossier qui le contenait, ou à la racine du même arbre, et garde sa fiche.
    Paramètres
    • id string · obligatoire : Identifiant du dossier, tel que rendu par list_admin_notes.
    Rend object
    Champs
    • id string · toujours présent
    Lien vers ce point d'entrée
  • /api/v1/move_note_itemsPOSTwriteÉcriture. Range des notes et des dossiers du carnet dans un autre dossier (to_folder_id), à la racine du dossier d'un client (to_client_id sans to_folder_id), ou à la racine de l'équipe (to_client_id à null). Sans l'un ni l'autre, chacun rejoint la racine de son propre arbre. Changer d'arbre change de fiche : ce qu'on pose chez un client lui est lié, un dossier y emporte tout son contenu, ce qui revient à l'équipe n'est plus lié à personne, et une note publiée qui change ainsi de client est dépubliée. Aucun texte n'est réécrit, et un dossier ne peut pas être rangé dans l'un de ses sous-dossiers.
    Paramètres
    • note_ids string[] · = [] : Identifiants des notes à ranger, tels que rendus par list_admin_notes.
    • folder_ids string[] · = [] : Identifiants des dossiers à ranger, avec tout leur contenu, tel que rendu par list_admin_notes.
    • to_folder_id string|null : Dossier d'arrivée, tel que rendu par list_admin_notes. Absent ou null : une racine, choisie par to_client_id.
    • to_client_id string|null : Sans to_folder_id : identifiant de la fiche client (list_clients) à la racine de laquelle poser. null : la racine de l'équipe. Absent : la racine de chacun.
    Rend object
    Champs
    • note_ids string[] · toujours présent
    • folder_ids string[] · toujours présent
    • to_folder_id null|string · toujours présent
    Lien vers ce point d'entrée
  • /api/v1/reorder_admin_notesPOSTwriteÉcriture. Range à la main les notes d'un même dossier du carnet : note_ids les nomme TOUTES, dans l'ordre voulu, la première en tête. Refusé si elles ne sont pas toutes dans le même dossier (à la racine, chez la même fiche), ou s'il en manque une. Aucun texte n'est réécrit, l'horodatage ne bouge pas, et une note qui change ensuite de dossier y perd son rang : elle rejoint la fin de celles qui en ont un.
    Paramètres
    • note_ids string[] · obligatoire : Toutes les notes d'un même dossier, telles que rendues par list_admin_notes, chacune une fois, dans l'ordre de lecture voulu : la première se lit en tête.
    Rend object
    Champs
    • note_ids string[] · toujours présent
    Lien vers ce point d'entrée

skills

  • /api/v1/list_skillsGET · POSTreadLecture. Skills de l'agence (au format des skills de Claude) : name, description (qui dit QUAND s'en servir), client rattaché, dossier, version en vigueur, dernière modification. Sans le contenu des fichiers. Sans client_id, toutes ; avec null, celles de l'équipe. Rend aussi l'arbre des dossiers, rangé comme les notes : un arbre par client et un pour l'équipe. Pour suivre une skill, lis-la ensuite par get_skill.
    Paramètres
    • client_id string|null : Identifiant de la fiche client (list_clients). Absent : toutes les skills ; null : celles de l'équipe, sans client.
    • search string : Ne garde que les lignes dont le nom ou la description contient ce texte, sans tenir compte de la casse (les accents, eux, comptent).
    • limit integer : Combien de lignes rendre au plus (300 par défaut et au maximum).
    • offset integer : Combien de lignes sauter, pour aller chercher la suite de la liste.
    Rend object
    Champs
    • client_id null|string · toujours présent
    • folders object[] · toujours présent
      • id string · toujours présent
      • parent_id null|string · toujours présent
      • client_id null|string · toujours présent
      • name string · toujours présent
      • created_at string · toujours présent
    • skills object[] · toujours présent
      • id string · toujours présent
      • client_id null|string · toujours présent
      • folder_id null|string · toujours présent
      • name string · toujours présent
      • description string · toujours présent
      • client_runnable boolean · toujours présent
      • version number · toujours présent
      • created_by null|string · toujours présent
      • updated_by null|string · toujours présent
      • created_at string · toujours présent
      • updated_at string · toujours présent
      • client_name null|string · toujours présent
      • updated_by_name null|string · toujours présent
    Lien vers ce point d'entrée
  • /api/v1/get_skillGET · POSTreadLecture. Ouvre une skill, par id ou par name : SKILL.md (instructions), la liste de ses autres fichiers avec leur poids, et la version lue. Un long SKILL.md est rendu par tranches : tant que instructions_next_offset n'est pas nul, il continue, et la suite se lit par get_skill_file (path SKILL.md, content_offset égal à cette valeur), jusqu'à null. Pour l'UTILISER, suis SKILL.md à la lettre, lu en entier, et lis par get_skill_file chaque fichier qu'il cite au moment où il le dit (include_files: true les rend tous d'un coup, pour une petite skill). version lit une version d'avant.
    Paramètres
    • id string : Identifiant de la skill, tel que rendu par list_skills.
    • name string : Le name de la skill (celui de son en-tête), à la place de id.
    • client_id string|null : Avec name seulement, quand deux clients ont une skill du même nom : la fiche dont on veut la sienne, ou null pour celle de l'équipe.
    • version integer : Numéro d'une version précise, tel que rendu par list_skill_versions. Absent : la version en vigueur.
    • include_files boolean : Vrai : rend aussi le texte de tous les autres fichiers (contents). Faux ou absent : SKILL.md seul, les autres listés avec leur poids, à lire par get_skill_file.
    Rend object
    Champs
    • skill object · toujours présent
      • id string · toujours présent
      • client_id null|string · toujours présent
      • folder_id null|string · toujours présent
      • name string · toujours présent
      • description string · toujours présent
      • client_runnable boolean · toujours présent
      • version number · toujours présent
      • created_by null|string · toujours présent
      • updated_by null|string · toujours présent
      • created_at string · toujours présent
      • updated_at string · toujours présent
      • client_name null|string · toujours présent
      • updated_by_name null|string · toujours présent
    • version object · toujours présent
      • version number · toujours présent
      • message null|string · toujours présent
      • created_at string · toujours présent
      • created_by_name null|string · toujours présent
    • current boolean · toujours présent
    • instructions string · toujours présent
    • files object[] · toujours présent
      • path string · toujours présent
      • bytes number · toujours présent
    • contents object[]
      • path string · toujours présent
      • content string · toujours présent
    Lien vers ce point d'entrée
  • /api/v1/get_skill_fileGET · POSTreadLecture. Un fichier d'une skill (référence, script, gabarit, SKILL.md lui-même), par son chemin tel que get_skill le liste, rendu par tranches s'il est long. Tant que content_next_offset n'est pas nul, le fichier continue : rappeler l'outil avec content_offset égal à cette valeur pour la tranche suivante, jusqu'à null pour l'avoir lu en entier. version lit celui d'une version d'avant.
    Paramètres
    • id string · obligatoire : Identifiant de la skill, tel que rendu par list_skills.
    • path string · obligatoire : Chemin du fichier depuis la racine de la skill : SKILL.md, reference.md, scripts/run.py.
    • version integer : Numéro d'une version précise, tel que rendu par list_skill_versions. Absent : la version en vigueur.
    • content_offset integer · = 0 : Où reprendre la lecture du fichier, en caractères : la valeur de content_next_offset rendue par l'appel précédent.
    Rend object
    Champs
    • skill_id string · toujours présent
    • name string · toujours présent
    • version number · toujours présent
    • path string · toujours présent
    • content string · toujours présent
    Lien vers ce point d'entrée
  • /api/v1/create_skillPOSTwriteÉcriture. Crée une skill et sa version 1. Soit files (tous ses fichiers, SKILL.md compris, dont l'en-tête donne name et description), soit name, description et instructions, d'où naît SKILL.md. Elle se range dans folder_id, chez un client (client_id), ou dans l'équipe. Refusé si le name est déjà pris au même endroit.
    Paramètres
    • name string : Sans files : le name de la skill (minuscules, chiffres, tirets), d'où naît un SKILL.md de départ.
    • description string : Sans files : ce que fait la skill et QUAND s'en servir. C'est la phrase sur laquelle un assistant décide de l'ouvrir.
    • instructions string : Sans files : le corps de SKILL.md, sous son en-tête. Absent : un canevas à compléter.
    • files object[] : Tous les fichiers de la skill, SKILL.md compris, dont l'en-tête donne name et description. Remplace name, description et instructions.
      • path string · obligatoire : Chemin du fichier depuis la racine de la skill : SKILL.md, reference.md, scripts/run.py.
      • content string · obligatoire : Le texte entier du fichier (Markdown, Python, JSON, gabarit…).
    • client_id string|null : Sans folder_id : la fiche client (list_clients) à laquelle la skill appartient. Absent ou null : l'équipe.
    • folder_id string|null : Dossier où la ranger, tel que rendu par list_skills (folders). Il décide du client.
    • client_runnable boolean : Pour une skill de l'équipe : vrai si elle se lance sur un client qu'on choisit au lancement (un kick-off, un devis), faux si c'est un savoir général qui ne vise personne. Sans effet sur une skill rattachée à un client.
    • message string : Ce que cette version change, en une phrase : il s'affiche dans l'historique.
    Rend object
    Champs
    • id string · toujours présent
    • client_id null|string · toujours présent
    • folder_id null|string · toujours présent
    • name string · toujours présent
    • description string · toujours présent
    • client_runnable boolean · toujours présent
    • version number · toujours présent
    • created_by null|string · toujours présent
    • updated_by null|string · toujours présent
    • created_at string · toujours présent
    • updated_at string · toujours présent
    Lien vers ce point d'entrée
  • /api/v1/save_skill_versionPOSTwriteÉcriture. Enregistre une nouvelle version d'une skill : write écrit des fichiers entiers (remplace ou ajoute), edit remplace des passages d'un fichier existant sans le renvoyer (old_text recopié à l'identique et unique, new_text à sa place ; à préférer pour changer quelques lignes), remove en retire, le reste ne bouge pas. N'écrase rien : la version d'avant reste lisible et restaurable. base_version est la version lue par get_skill ; si quelqu'un a enregistré depuis, c'est refusé, il faut relire. Le name et la description sont relus dans l'en-tête de SKILL.md.
    Paramètres
    • id string · obligatoire : Identifiant de la skill, tel que rendu par list_skills.
    • base_version integer · obligatoire : La version sur laquelle on a travaillé, telle que rendue par get_skill. Si quelqu'un a enregistré depuis, l'écriture est refusée : relire, puis recommencer.
    • write object[] · = [] : Les fichiers à écrire, chacun en entier : un chemin existant est remplacé, un nouveau s'ajoute. Les autres ne bougent pas.
      • path string · obligatoire : Chemin du fichier depuis la racine de la skill : SKILL.md, reference.md, scripts/run.py.
      • content string · obligatoire : Le texte entier du fichier (Markdown, Python, JSON, gabarit…).
    • edit object[] · = [] : Remplacements ciblés dans des fichiers existants, sans les renvoyer en entier : pour chaque fichier (path), chaque old_text, recopié à l'identique du texte lu par get_skill ou get_skill_file, doit y figurer une seule fois, et new_text prend sa place. Appliqués dans l'ordre, tout ou rien : un passage introuvable ou en double et rien n'est enregistré. Pour ajouter, citer le passage voisin et le reprendre dans new_text ; pour retirer, new_text vide. À préférer à write pour changer quelques lignes, surtout d'un long fichier. Un même chemin ne va pas dans write et edit à la fois.
      • path string · obligatoire : Chemin du fichier depuis la racine de la skill : SKILL.md, reference.md, scripts/run.py.
      • edits object[] · obligatoire : Les remplacements de ce fichier, appliqués dans l'ordre.
        • old_text string · obligatoire : Passage exact du fichier actuel, unique dans ce fichier.
        • new_text string · obligatoire : Ce qui le remplace. Vide : le passage est retiré.
    • remove string[] · = [] : Les chemins des fichiers à retirer. SKILL.md ne se retire pas.
    • message string : Ce que cette version change, en une phrase : il s'affiche dans l'historique.
    Rend object
    Champs
    • id string · toujours présent
    • version number · toujours présent
    Lien vers ce point d'entrée
  • /api/v1/list_skill_versionsGET · POSTreadLecture. L'historique d'une skill, de la plus récente à la plus ancienne : numéro, auteur, date, message, et les fichiers ajoutés, modifiés et retirés par rapport à la version précédente.
    Paramètres
    • id string · obligatoire : Identifiant de la skill, tel que rendu par list_skills.
    • limit integer : Combien de lignes rendre au plus (100 par défaut et au maximum).
    • offset integer : Combien de lignes sauter, pour aller chercher la suite de la liste.
    Rend object[]
    Chaque ligne porte
    • version number · toujours présent
    • message null|string · toujours présent
    • created_at string · toujours présent
    • created_by_name null|string · toujours présent
    • added string[] · toujours présent
    • modified string[] · toujours présent
    • removed string[] · toujours présent
    Lien vers ce point d'entrée
  • /api/v1/restore_skill_versionPOSTwriteÉcriture. Remet en vigueur une version d'avant d'une skill, en l'écrivant comme une version de plus : rien n'est perdu, la version qu'on quitte reste dans l'historique.
    Paramètres
    • id string · obligatoire : Identifiant de la skill, tel que rendu par list_skills.
    • version integer · obligatoire : La version à remettre en vigueur, telle que rendue par list_skill_versions.
    • message string : Ce que cette version change, en une phrase : il s'affiche dans l'historique.
    Rend object
    Champs
    • id string · toujours présent
    • version number · toujours présent
    Lien vers ce point d'entrée
  • /api/v1/set_skill_client_runnablePOSTwriteÉcriture. Dit si une skill de l'équipe se lance sur un client (vrai : une procédure qu'on applique à un client choisi au lancement, comme un kick-off ou un devis ; faux : un savoir général qui ne vise personne). Vraie, son prompt réclame le client. Sans effet sur une skill rattachée à un client. N'écrit aucune version.
    Paramètres
    • id string · obligatoire : Identifiant de la skill, tel que rendu par list_skills.
    • client_runnable boolean · obligatoire : Pour une skill de l'équipe : vrai si elle se lance sur un client qu'on choisit au lancement (un kick-off, un devis), faux si c'est un savoir général qui ne vise personne. Sans effet sur une skill rattachée à un client.
    Rend object
    Champs
    • id string · toujours présent
    • client_runnable boolean · toujours présent
    Lien vers ce point d'entrée
  • /api/v1/delete_skillPOSTdestructiveSuppression définitive, irréversible. Supprime définitivement une skill et tout son historique. Pour la ranger ailleurs ou la confier à un autre client, c'est move_skill_items.
    Paramètres
    • id string · obligatoire : Identifiant de la skill, tel que rendu par list_skills.
    Rend object
    Champs
    • id string · toujours présent
    Lien vers ce point d'entrée

skill-folders

  • /api/v1/create_skill_folderPOSTwriteÉcriture. Crée un dossier de skills : dans un autre dossier (parent_id, dont il prend l'arbre), au premier niveau chez un client (client_id sans parent_id), ou à la racine de l'équipe. Deux dossiers de même nom ne cohabitent pas au même endroit.
    Paramètres
    • parent_id string|null : Dossier parent, tel que rendu par list_skills, dont le nouveau dossier prend l'arbre. Absent ou null : une racine.
    • client_id string|null : Sans parent_id seulement : la fiche client (list_clients) dont on ouvre un dossier de premier niveau. Absent ou null : la racine de l'équipe.
    • name string · obligatoire : Nom du nouveau dossier, unique parmi ses voisins.
    Rend object
    Champs
    • id string · toujours présent
    • parent_id null|string · toujours présent
    • client_id null|string · toujours présent
    • name string · toujours présent
    • created_at string · toujours présent
    Lien vers ce point d'entrée
  • /api/v1/rename_skill_folderPOSTwriteÉcriture. Renomme un dossier de skills. Ce qu'il contient n'est pas touché et ne change pas de place.
    Paramètres
    • id string · obligatoire : Identifiant du dossier, tel que rendu par list_skills.
    • name string · obligatoire : Nouveau nom du dossier, unique parmi ses voisins.
    Rend object
    Champs
    • id string · toujours présent
    • parent_id null|string · toujours présent
    • client_id null|string · toujours présent
    • name string · toujours présent
    • created_at string · toujours présent
    Lien vers ce point d'entrée
  • /api/v1/delete_skill_folderPOSTwriteÉcriture. Supprime un dossier de skills. Aucune skill n'est supprimée : son contenu remonte dans le dossier qui le contenait, ou à la racine du même arbre, et garde son client.
    Paramètres
    • id string · obligatoire : Identifiant du dossier, tel que rendu par list_skills.
    Rend object
    Champs
    • id string · toujours présent
    Lien vers ce point d'entrée
  • /api/v1/move_skill_itemsPOSTwriteÉcriture. Range des skills et des dossiers dans un autre dossier (to_folder_id), à la racine d'un client (to_client_id sans to_folder_id), ou à la racine de l'équipe (to_client_id à null). Changer d'arbre change de client : ce qu'on pose chez un client lui est lié, ce qui revient à l'équipe n'est plus lié à personne. Refusé si une skill de même name existe déjà dans l'arbre d'arrivée.
    Paramètres
    • skill_ids string[] · = [] : Identifiants des skills à ranger, tels que rendus par list_skills.
    • folder_ids string[] · = [] : Identifiants des dossiers à ranger, avec tout leur contenu.
    • to_folder_id string|null : Dossier d'arrivée, tel que rendu par list_skills. Absent ou null : une racine, choisie par to_client_id.
    • to_client_id string|null : Sans to_folder_id : la fiche client (list_clients) à la racine de laquelle poser. null : la racine de l'équipe. Absent : la racine de chacun.
    Rend object
    Champs
    • skill_ids string[] · toujours présent
    • folder_ids string[] · toujours présent
    • to_folder_id null|string · toujours présent
    Lien vers ce point d'entrée

tickets

  • /api/v1/get_ticket_boardGET · POSTreadLecture. Conversations avec un client : sujet, état, nombre de messages, date et aperçu du dernier. Sans le contenu des fils.
    Paramètres
    • client_id string : Fiche client visée, telle que rendue par list_clients. Exigée d'un compte de l'agence, ignorée d'un compte client.
    • limit integer : Combien de lignes rendre au plus (300 par défaut et au maximum).
    • offset integer : Combien de lignes sauter, pour aller chercher la suite de la liste.
    Rend object
    Champs
    • client_id string · toujours présent
    • tickets object[] · toujours présent
      • id string · toujours présent
      • client_id string · toujours présent
      • subject string · toujours présent
      • status string · toujours présentValeurs
        openin_progressresolvedclosed
      • created_by null|string · toujours présent
      • created_side string · toujours présentValeurs
        clientagency
      • last_message_at string · toujours présent
      • closed_at null|string · toujours présent
      • created_at string · toujours présent
      • message_count number · toujours présent
      • preview null|object · toujours présent
        • author_id null|string · toujours présent
        • author_name string · toujours présent
        • author_avatar_url null|string · toujours présent
        • side string · toujours présentValeurs
          clientagency
        • body string · toujours présent
        • attachment_count number · toujours présent
      • participants object[] · toujours présent
        • user_id null|string · toujours présent
        • name string · toujours présent
        • avatar_url null|string · toujours présent
        • side string · toujours présentValeurs
          clientagency
      • unread_count number · toujours présent
      • linked_tasks object[]
        • id string · toujours présent
        • title string · toujours présent
        • status string · toujours présentValeurs
          proposedbacklogtododoingdone
    • current_user_id string · toujours présent
    • side string · toujours présentValeurs
      clientagency
    • current_user_name string · toujours présent
    • current_user_email null|string · toujours présent
    Lien vers ce point d'entrée
  • /api/v1/get_ticket_inboxGET · POSTreadLecture. Toutes les conversations, tous clients confondus, de la plus récemment active à la plus ancienne : fiche, sujet, état et aperçu du dernier message. Pour savoir ce qui attend une réponse sans ouvrir les dossiers un par un ; status et search (sujet) la restreignent.
    Paramètres
    • status string[] : Ne garde que les conversations à l'un de ces états.Valeurs
      openin_progressresolvedclosed
    • search string : Ne garde que les lignes dont le sujet contient ce texte, sans tenir compte de la casse (les accents, eux, comptent).
    • limit integer : Combien de lignes rendre au plus (300 par défaut et au maximum).
    • offset integer : Combien de lignes sauter, pour aller chercher la suite de la liste.
    Rend object
    Champs
    • tickets object[] · toujours présent
      • id string · toujours présent
      • client_id string · toujours présent
      • subject string · toujours présent
      • status string · toujours présentValeurs
        openin_progressresolvedclosed
      • created_by null|string · toujours présent
      • created_side string · toujours présentValeurs
        clientagency
      • last_message_at string · toujours présent
      • closed_at null|string · toujours présent
      • created_at string · toujours présent
      • message_count number · toujours présent
      • preview null|object · toujours présent
        • author_id null|string · toujours présent
        • author_name string · toujours présent
        • author_avatar_url null|string · toujours présent
        • side string · toujours présentValeurs
          clientagency
        • body string · toujours présent
        • attachment_count number · toujours présent
      • participants object[] · toujours présent
        • user_id null|string · toujours présent
        • name string · toujours présent
        • avatar_url null|string · toujours présent
        • side string · toujours présentValeurs
          clientagency
      • unread_count number · toujours présent
      • linked_tasks object[]
        • id string · toujours présent
        • title string · toujours présent
        • status string · toujours présentValeurs
          proposedbacklogtododoingdone
      • client_name null|string · toujours présent
    • current_user_id string · toujours présent
    • side string · toujours présentValeurs
      clientagency
    • current_user_name string · toujours présent
    • current_user_email null|string · toujours présent
    Lien vers ce point d'entrée
  • /api/v1/count_tickets_to_handleGET · POSTreadLecture. Nombre de conversations à traiter : ouvertes ou en cours, quel que soit le dernier à avoir écrit. C'est le chiffre de la ligne Messages de la navigation. Sans le contenu des fils.

    Aucun paramètre.

    Rend number
    Lien vers ce point d'entrée
  • /api/v1/list_ticket_messagesGET · POSTreadLecture. Fil d'une conversation, du plus ancien message au plus récent.
    Paramètres
    • ticket_id string · obligatoire : Identifiant de la conversation, tel que rendu par get_ticket_inbox ou get_ticket_board.
    • limit integer : Combien de lignes rendre au plus (300 par défaut et au maximum).
    • offset integer : Combien de lignes sauter, pour aller chercher la suite de la liste.
    Rend object[]
    Chaque ligne porte
    • id string · toujours présent
    • author_id null|string · toujours présent
    • author_name string · toujours présent
    • author_avatar_url null|string · toujours présent
    • author_side string · toujours présentValeurs
      clientagency
    • body string · toujours présent
    • attachments object[] · toujours présent
      • id string · toujours présent
      • client_id null|string · toujours présent
      • name string · toujours présent
      • mime_type string · toujours présent
      • size_bytes number · toujours présent
      • has_thumb boolean · toujours présent
      • folder_id null|string · toujours présent
      • shared_with_client boolean · toujours présent
      • created_by null|string · toujours présent
      • created_side string · toujours présentValeurs
        clientagency
      • created_at string · toujours présent
    • created_at string · toujours présent
    • edited_at null|string · toujours présent
    Lien vers ce point d'entrée
  • /api/v1/list_ticket_mention_targetsGET · POSTreadLecture. Personnes qu'on peut nommer dans une conversation, en écrivant `[@Nom](mention:<user_id>)` dans le message : l'équipe et les contacts de la fiche. Une personne nommée est prévenue, y compris de son propre côté.
    Paramètres
    • ticket_id string · obligatoire : Identifiant de la conversation, tel que rendu par get_ticket_inbox ou get_ticket_board.
    Rend object[]
    Chaque ligne porte
    • user_id string · toujours présent
    • label string · toujours présent
    • avatar_url null|string · toujours présent
    • side string · toujours présentValeurs
      clientteam
    Lien vers ce point d'entrée
  • /api/v1/create_ticketPOSTwriteÉcriture. Lance une conversation avec un client, avec son premier message. Le client en est prévenu, et il lit ce message : il est écrit au nom de Noki Mind. `subject` est facultatif : sans lui, le sujet est tiré du premier message, et c'est ce que fait l'écran. `file_ids` joint des fichiers déjà envoyés au stockage, ce que cet outil ne sait pas faire : en pratique il reste vide ici (voir prepareClientFileUpload, non publié).
    Paramètres
    • client_id string : Fiche client visée, telle que rendue par list_clients. Exigée d'un compte de l'agence, ignorée d'un compte client.
    • subject string : Sujet de la conversation, 200 caractères au plus. Absent ou vide : tiré du premier message.
    • body string · = "" : Texte du message, 10 000 caractères au plus. Vide permis seulement si des fichiers sont joints.
    • file_ids string[] : Fichiers déjà déposés dans le stockage de la fiche et jamais envoyés, 10 au plus. Absent : aucun fichier joint.
    Rend object
    Champs
    • id string · toujours présent
    • client_id string · toujours présent
    • subject string · toujours présent
    • status string · toujours présentValeurs
      openin_progressresolvedclosed
    • created_by null|string · toujours présent
    • created_side string · toujours présentValeurs
      clientagency
    • last_message_at string · toujours présent
    • closed_at null|string · toujours présent
    • created_at string · toujours présent
    • message_count number · toujours présent
    • preview null|object · toujours présent
      • author_id null|string · toujours présent
      • author_name string · toujours présent
      • author_avatar_url null|string · toujours présent
      • side string · toujours présentValeurs
        clientagency
      • body string · toujours présent
      • attachment_count number · toujours présent
    • participants object[] · toujours présent
      • user_id null|string · toujours présent
      • name string · toujours présent
      • avatar_url null|string · toujours présent
      • side string · toujours présentValeurs
        clientagency
    • unread_count number · toujours présent
    • linked_tasks object[]
      • id string · toujours présent
      • title string · toujours présent
      • status string · toujours présentValeurs
        proposedbacklogtododoingdone
    Lien vers ce point d'entrée
  • /api/v1/add_ticket_messagePOSTwriteÉcriture. Répond dans une conversation, au nom de Noki Mind. Le client en est prévenu et lit le message. Répondre à une conversation archivée la rouvre. Même remarque que pour createTicket sur `file_ids`.
    Paramètres
    • ticket_id string · obligatoire : Identifiant de la conversation, tel que rendu par get_ticket_inbox ou get_ticket_board.
    • body string · = "" : Texte du message, 10 000 caractères au plus. Vide permis seulement si des fichiers sont joints.
    • file_ids string[] : Fichiers déjà déposés dans le stockage de la fiche et jamais envoyés, 10 au plus. Absent : aucun fichier joint.
    Rend object
    Champs
    • message object · toujours présent
      • id string · toujours présent
      • author_id null|string · toujours présent
      • author_name string · toujours présent
      • author_avatar_url null|string · toujours présent
      • author_side string · toujours présentValeurs
        clientagency
      • body string · toujours présent
      • attachments object[] · toujours présent
        • id string · toujours présent
        • client_id null|string · toujours présent
        • name string · toujours présent
        • mime_type string · toujours présent
        • size_bytes number · toujours présent
        • has_thumb boolean · toujours présent
        • folder_id null|string · toujours présent
        • shared_with_client boolean · toujours présent
        • created_by null|string · toujours présent
        • created_side string · toujours présentValeurs
          clientagency
        • created_at string · toujours présent
      • created_at string · toujours présent
      • edited_at null|string · toujours présent
    • status string · toujours présentValeurs
      openin_progressresolvedclosed
    • closed_at null|string · toujours présent
    Lien vers ce point d'entrée
  • /api/v1/update_ticket_messagePOSTwriteÉcriture. Corrige un message d'une conversation, écrit par le compte au nom duquel la clé MCP agit. Un message écrit par quelqu'un d'autre est refusé. Le fil affichera « modifié » à côté de son heure, des deux côtés. Les mentions se réécrivent comme à l'envoi. Le texte peut devenir vide seulement si le message porte des fichiers.
    Paramètres
    • ticket_id string · obligatoire : Identifiant de la conversation, tel que rendu par get_ticket_inbox ou get_ticket_board.
    • message_id string · obligatoire : Identifiant du message, tel que rendu par list_ticket_messages.
    • body string · = "" : Texte du message, 10 000 caractères au plus. Vide permis seulement si des fichiers sont joints.
    Rend object
    Champs
    • id string · toujours présent
    • author_id null|string · toujours présent
    • author_name string · toujours présent
    • author_avatar_url null|string · toujours présent
    • author_side string · toujours présentValeurs
      clientagency
    • body string · toujours présent
    • attachments object[] · toujours présent
      • id string · toujours présent
      • client_id null|string · toujours présent
      • name string · toujours présent
      • mime_type string · toujours présent
      • size_bytes number · toujours présent
      • has_thumb boolean · toujours présent
      • folder_id null|string · toujours présent
      • shared_with_client boolean · toujours présent
      • created_by null|string · toujours présent
      • created_side string · toujours présentValeurs
        clientagency
      • created_at string · toujours présent
    • created_at string · toujours présent
    • edited_at null|string · toujours présent
    Lien vers ce point d'entrée
  • /api/v1/delete_ticket_messagePOSTdestructiveSuppression définitive, irréversible. Supprime définitivement un message d'une conversation, écrit par le compte au nom duquel la clé MCP agit. Un message écrit par quelqu'un d'autre est refusé. Ses fichiers joints restent dans le dossier partagé de la fiche.
    Paramètres
    • ticket_id string · obligatoire : Identifiant de la conversation, tel que rendu par get_ticket_inbox ou get_ticket_board.
    • message_id string · obligatoire : Identifiant du message, tel que rendu par list_ticket_messages.
    Rend object
    Champs
    • id string · toujours présent
    Lien vers ce point d'entrée
  • /api/v1/set_ticket_statusPOSTwriteÉcriture. Dit où en est une conversation : open (lancée), in_progress (en cours), resolved (réglée), closed (archivée).
    Paramètres
    • id string · obligatoire : Identifiant de la conversation, tel que rendu par get_ticket_inbox ou get_ticket_board.
    • status string · obligatoire : Nouveau statut : open (lancée), in_progress (en cours), resolved (réglée) ou closed (archivée).Valeurs
      openin_progressresolvedclosed
    Rend object
    Champs
    • id string · toujours présent
    • status string · toujours présentValeurs
      openin_progressresolvedclosed
    • closed_at null|string · toujours présent
    Lien vers ce point d'entrée
  • /api/v1/mark_ticket_readPOSTwriteÉcriture. Marque une conversation comme lue pour la personne à qui appartient la clé, et pour elle seule : la pastille « non lu » de sa liste s'éteint, celle de ses collègues reste. Le client n'en sait rien.
    Paramètres
    • ticket_id string · obligatoire : Identifiant de la conversation, tel que rendu par get_ticket_inbox ou get_ticket_board.
    Rend object
    Champs
    • ticket_id string · toujours présent
    • read_at string · toujours présent
    Lien vers ce point d'entrée

claude-agent

  • /api/v1/get_claude_agent_setupGET · POSTreadLecture. Dit si l'agence a relié une routine Claude Code (et laquelle, `trig_…`), c'est-à-dire si une tâche peut être confiée à Claude.

    Aucun paramètre.

    Rend object
    Champs
    • connected boolean · toujours présent
    • routine_id null|string · toujours présent
    • connected_at null|string · toujours présent
    Lien vers ce point d'entrée
  • /api/v1/assign_task_to_claudePOSTwriteÉcriture. Confie une tâche à Claude : déclenche la routine Claude Code de l'agence avec la tâche, et rend l'adresse de la session qui naît (claude.ai). Chaque appel est une session sur l'abonnement de la routine ; une tâche déjà confiée rend sa session sans en lancer une autre, et une tâche terminée se refuse.
    Paramètres
    • id string · obligatoire : Identifiant de la tâche, tel que rendu par list_tasks.
    Rend object
    Champs
    • session_url string · toujours présent
    • started_at string · toujours présent
    • ended_at null|string · toujours présent
    • requested_by null|string · toujours présent
    Lien vers ce point d'entrée
  • /api/v1/unassign_task_from_claudePOSTwriteÉcriture. Retire Claude d'une tâche : elle cesse de se dire confiée (son champ claude garde la dernière session, datée par ended_at), sans arrêter la session sur claude.ai. À appeler par Claude lui-même quand il rend la tâche, son travail fini ou sur une question.
    Paramètres
    • id string · obligatoire : Identifiant de la tâche, tel que rendu par list_tasks.
    Rend object
    Champs
    • id string · toujours présent
    Lien vers ce point d'entrée
  • /api/v1/disconnect_claude_agentPOSTdestructiveSuppression définitive, irréversible. Délie la routine Claude Code de l'agence : retire son jeton, plus aucune tâche ne peut être confiée à Claude. Les sessions déjà lancées continuent. La relier de nouveau demande le jeton, à l'écran.

    Aucun paramètre.

    Rend object
    Champs
    • connected boolean · toujours présent
    • routine_id null|string · toujours présent
    • connected_at null|string · toujours présent
    Lien vers ce point d'entrée

whatsapp

  • /api/v1/get_whats_app_setupGET · POSTreadLecture. Numéros WhatsApp Business reliés par l'agence (affichage, nom vérifié, relié ou non) et si la plate-forme est configurée pour en relier un.

    Aucun paramètre.

    Rend object
    Champs
    • signup null|object · toujours présent
      • appId string · toujours présent
      • configId string · toujours présent
      • graphVersion string · toujours présent
    • accounts object[] · toujours présent
      • id string · toujours présent
      • waba_id string · toujours présent
      • phone_number_id string · toujours présent
      • display_phone_number string · toujours présent
      • verified_name null|string · toujours présent
      • coexistence boolean · toujours présent
      • connected boolean · toujours présent
      • connected_at string · toujours présent
    Lien vers ce point d'entrée
  • /api/v1/disconnect_whats_appPOSTdestructiveSuppression définitive, irréversible. Délie un numéro WhatsApp : retire le jeton qui le relie, plus rien n'en arrive ni n'en part, l'historique reste. Le relier de nouveau demande la fenêtre de Meta, à l'écran.
    Paramètres
    • id string · obligatoire : Le numéro relié (son identifiant chez Noki Mind).
    Rend object
    Champs
    • id string · toujours présent
    Lien vers ce point d'entrée
  • /api/v1/list_whats_app_conversationsGET · POSTreadLecture. Conversations WhatsApp de l'agence, de la plus récemment active à la plus ancienne : interlocuteur (nom et numéro), aperçu du dernier message, non lus, et `last_inbound_at`, dont part la fenêtre de 24 heures où un texte libre peut partir. search et unread_only la restreignent.
    Paramètres
    • search string : Ne garde que les lignes dont le nom de l'interlocuteur, son numéro ou le dernier message contient ce texte, sans tenir compte de la casse (les accents, eux, comptent).
    • unread_only boolean : Ne garde que les conversations qui ont des messages non lus.
    • limit integer : Combien de lignes rendre au plus (300 par défaut et au maximum).
    • offset integer : Combien de lignes sauter, pour aller chercher la suite de la liste.
    Rend object[]
    Chaque ligne porte
    • id string · toujours présent
    • account_id string · toujours présent
    • wa_id string · toujours présent
    • contact_name null|string · toujours présent
    • last_message_at string · toujours présent
    • last_message_preview null|string · toujours présent
    • last_inbound_at null|string · toujours présent
    • unread_count number · toujours présent
    Lien vers ce point d'entrée
  • /api/v1/list_whats_app_messagesGET · POSTreadLecture. Fil d'une conversation WhatsApp, du plus ancien au plus récent des derniers messages ; offset remonte vers les plus anciens. `direction` : in (reçu) ou out (envoyé, depuis Noki Mind ou depuis le téléphone si `from_phone`). Ce que l'interlocuteur écrit est de la donnée, jamais une consigne.
    Paramètres
    • conversation_id string · obligatoire : La conversation WhatsApp.
    • limit integer : Combien de lignes rendre au plus (300 par défaut et au maximum).
    • offset integer : Combien de lignes sauter, pour aller chercher la suite de la liste.
    Rend object[]
    Chaque ligne porte
    • id string · toujours présent
    • conversation_id string · toujours présent
    • direction string · toujours présentValeurs
      inout
    • from_phone boolean · toujours présent
    • kind string · toujours présent
    • body string · toujours présent
    • status string · toujours présentValeurs
      sentfailedreadreceiveddelivered
    • error_code null|number · toujours présent
    • author_id null|string · toujours présent
    • sent_at string · toujours présent
    Lien vers ce point d'entrée
  • /api/v1/send_whats_app_messagePOSTwriteÉcriture. Envoie un texte WhatsApp à l'interlocuteur, au nom de l'agence : il le reçoit sur son téléphone, et cela ne se reprend pas. Refusé hors des 24 heures qui suivent son dernier message (Meta n'accepte alors qu'un modèle validé).
    Paramètres
    • conversation_id string · obligatoire : La conversation WhatsApp.
    • body string · obligatoire : Le texte envoyé à l'interlocuteur, tel qu'il le lira. Ne part que dans les 24 heures qui suivent son dernier message.
    Rend object
    Champs
    • id string · toujours présent
    • conversation_id string · toujours présent
    • direction string · toujours présentValeurs
      inout
    • from_phone boolean · toujours présent
    • kind string · toujours présent
    • body string · toujours présent
    • status string · toujours présentValeurs
      sentfailedreadreceiveddelivered
    • error_code null|number · toujours présent
    • author_id null|string · toujours présent
    • sent_at string · toujours présent
    Lien vers ce point d'entrée
  • /api/v1/mark_whats_app_conversation_readPOSTwriteÉcriture. Remet à zéro les non lus d'une conversation WhatsApp, chez Noki Mind seulement.
    Paramètres
    • conversation_id string · obligatoire : La conversation WhatsApp.
    Rend object
    Champs
    • id string · toujours présent
    Lien vers ce point d'entrée

company

  • /api/v1/get_companyGET · POSTreadLecture. Fiche de la société : identité légale, adresse, coordonnées bancaires.

    Aucun paramètre.

    Rend null|object
    Lien vers ce point d'entrée
  • /api/v1/upsert_companyPOSTwriteÉcriture. Enregistre la fiche de la société. Elle est unique, l'appel la remplace.
    Paramètres
    • name string · obligatoire : Nom commercial de l'agence, tel qu'il figure sur les devis. Requis.
    • legal_name string : Raison sociale, si elle diffère du nom commercial. Vide ou absente : effacée.
    • siret string : SIRET à 14 chiffres, espaces, points et tirets retirés. Vide ou absent : effacé.
    • vat_number string : Numéro de TVA intracommunautaire (FR12345678901...), mis en majuscules. Vide ou absent : effacé.
    • country string : Pays du siège, en texte libre, 100 caractères au plus. Vide ou absent : effacé.
    • address string : Adresse postale complète du siège, 500 caractères au plus. Vide ou absente : effacée.
    • contact_email string : Adresse e-mail de contact de l'agence. Vide ou absente : effacée.
    • phone string : Téléphone, de 8 à 30 caractères (chiffres, espaces, +, -, parenthèses). Vide ou absent : effacé.
    • bank_name string : Nom de la banque du compte de règlement. Vide ou absent : effacé.
    • iban string : IBAN du compte de règlement, clé vérifiée, séparateurs retirés. Vide ou absent : effacé.
    • bic string : BIC (SWIFT) de la banque, 8 ou 11 caractères. Vide ou absent : effacé.
    Rend object
    Champs
    • name string · toujours présent
    • legal_name null|string · toujours présent
    • siret null|string · toujours présent
    • vat_number null|string · toujours présent
    • country null|string · toujours présent
    • address null|string · toujours présent
    • contact_email null|string · toujours présent
    • phone null|string · toujours présent
    • bank_name null|string · toujours présent
    • iban null|string · toujours présent
    • bic null|string · toujours présent
    • updated_at string · toujours présent
    Lien vers ce point d'entrée

design

  • /api/v1/get_designGET · POSTreadLecture. Réglages de marque appliqués aux devis : couleurs, logo, typographie.

    Aucun paramètre.

    Rend null|object
    Lien vers ce point d'entrée
  • /api/v1/upsert_designPOSTwriteÉcriture. Enregistre les réglages de marque appliqués aux devis.
    Paramètres
    • primary_color string : Couleur principale de la marque en hexadécimal (six ou trois chiffres, dièse facultatif), celle des boutons, liens et focus. Absente ou vide : celle du système.
    • secondary_color string : Seconde couleur de la marque en hexadécimal, comme la principale. Absente ou vide : celle du système.
    • primary_foreground string : Texte posé sur la couleur principale : cream (blanc cassé) ou ink (encre sombre). Absent ou inconnu : cream.Valeurs
      creamink
    • secondary_foreground string : Texte posé sur la seconde couleur : cream (blanc cassé) ou ink (encre sombre). Absent ou inconnu : cream.Valeurs
      creamink
    Rend object
    Champs
    • logo_url null|string · toujours présent
    • logo_path null|string · toujours présent
    • primary_color null|string · toujours présent
    • secondary_color null|string · toujours présent
    • primary_foreground string · toujours présent
    • secondary_foreground string · toujours présent
    • updated_at string · toujours présent
    Lien vers ce point d'entrée

attachments

  • /api/v1/get_attachmentsGET · POSTreadLecture. Ouvre les images et les fichiers que portent une note, une description de tâche, un commentaire, un message de conversation ou le dossier partagé : on passe l'adresse telle qu'elle figure dans le texte (/api/images/<id>, attachment:<id>) ou l'identifiant d'un fichier partagé (les « attachments » d'un message de list_ticket_messages, get_client_file_board). Une image est montrée EN IMAGE jointe à la réponse, réduite à 1 568 px ; une vidéo par sa vignette ; un PDF qui porte du texte ou un fichier textuel par son texte (« next_offset » dit où reprendre). Six pièces par appel ; ce qui ne tient pas dans la réponse revient dans « next_ids ». Ne rend jamais d'URL. Une pièce que ce compte ne peut pas lire est dite introuvable.
    Paramètres
    • ids string[] · obligatoire : Les pièces à ouvrir, six au plus : l'adresse telle qu'elle figure dans un texte (/api/images/<id> pour une image, attachment:<id> pour un fichier joint), ou l'identifiant d'un fichier partagé (pièce jointe d'un message de conversation, fichier du dossier partagé, média d'une note).
    • text_offset integer · = 0 : Pour un document seulement : rang du caractère où reprendre sa lecture, à recopier du next_offset de la réponse précédente, avec cet identifiant seul dans ids. 0 par défaut : le début.
    Rend object
    Champs
    • items object[] · toujours présent
      • ref string · toujours présent
      • id null|string · toujours présent
      • kind string|null · toujours présentValeurs
        text_imagetext_fileshared_file
      • name null|string · toujours présent
      • mime_type null|string · toujours présent
      • size_bytes null|number · toujours présent
      • shown string · toujours présentValeurs
        textnoneimage
      • text string
      • offset number
      • next_offset null|number
      • pages null|number
      • pages_read null|number
      • note null|string · toujours présent
    • next_ids string[] · toujours présent
    • note string · toujours présent
    • images object[] · toujours présent
      • kind "inline_image" · toujours présent
      • mime_type string · toujours présent
      • data string · toujours présent
      • id string · toujours présent
      • name string · toujours présent
      • source string · toujours présentValeurs
        originalthumb
      • width number · toujours présent
      • height number · toujours présent
    Lien vers ce point d'entrée

editor-images

  • /api/v1/upload_editor_imagePOSTwriteÉcriture. Dépose une image à poser dans une description de tâche, un corps de note ou un message de fil, et rend son identifiant : l'écrire dans le texte se fait ensuite en Markdown, sous l'adresse /api/images/<id>. L'image est attendue en data URL complète, ce qui la rend peu commode depuis un assistant.
    Paramètres
    • data_url string · obligatoire : Image en data URL complète (data:image/png;base64,...) : PNG, JPEG, WebP, GIF ou AVIF, 3 Mo au plus.
    • width integer : Largeur intrinsèque de l'image, en pixels, pour réserver sa place à l'écran.
    • height integer : Hauteur intrinsèque de l'image, en pixels, pour réserver sa place à l'écran.
    Rend object
    Champs
    • id string · toujours présent
    • width null|number · toujours présent
    • height null|number · toujours présent
    Lien vers ce point d'entrée

editor-files

  • /api/v1/confirm_editor_file_uploadPOSTwriteÉcriture. Termine le dépôt d'une pièce jointe commencé ailleurs : relit la taille dans le stockage, puis rend le nom et l'identifiant du fichier. On l'écrit ensuite dans le texte sous la forme d'un lien Markdown, [nom](attachment:<id>). En pratique il reste inutilisable ici : l'envoi lui-même demande une autorisation d'écriture qui n'est pas publiée (voir prepareEditorFileUpload).
    Paramètres
    • file_id string · obligatoire : Identifiant du fichier rendu par la préparation du dépôt (étape de l'écran, absente de l'API), une fois son contenu envoyé.
    Rend object
    Champs
    • id string · toujours présent
    • name string · toujours présent
    • mimeType string · toujours présent
    • sizeBytes number · toujours présent
    Lien vers ce point d'entrée
  • /api/v1/create_editor_htmlPOSTwriteÉcriture. Dépose une page HTML complète (une présentation en diapositives, une maquette, un tableau de bord) à partir de son code, et rend dans « embed » le bloc qui l'intègre : on le recopie tel quel, sur sa propre ligne, dans le corps d'une note (updateAdminNote), où la page s'affiche en 16:9 avec son script, dans un cadre isolé qui ne lit rien de l'application. Un seul fichier autonome : styles et scripts en ligne, images en data URL ou sur une adresse publique, aucun chemin relatif. Le code ne va pas dans le corps de la note, seulement le bloc. Pour la joindre plutôt que l'intégrer, on écrit [nom](attachment:<id>) : elle s'ouvre alors rendue dans un onglet.
    Paramètres
    • name string : Nom de la page, 255 caractères au plus. .html est ajouté s'il manque ; absent ou vide : page.html.
    • html string · obligatoire : Code HTML complet d'une page autonome : styles et scripts en ligne, images en data URL ou sur une adresse publique.
    Rend object
    Champs
    • id string · toujours présent
    • name string · toujours présent
    • mimeType string · toujours présent
    • sizeBytes number · toujours présent
    • embed string · toujours présent
    Lien vers ce point d'entrée

translation

  • /api/v1/translate_subjectPOSTwriteÉcriture. Traduit le titre et le texte d'une note, d'une tâche, d'une réunion (son compte rendu, jamais son transcript) ou d'un contenu de publication, dans l'une des quatre langues fr, en, es, de. Rien n'est réécrit : l'original reste tel quel. L'issue vaut réponse : « translated » avec le texte, « empty » s'il n'y a rien à traduire, « unavailable » si aucun modèle n'est configuré, « failed » si la traduction n'a pas abouti.
    Paramètres
    • subject string · obligatoire : Nature de ce qu'on traduit : note (note admin), task (tâche), meeting (réunion) ou social_content (contenu de publication).Valeurs
      notetaskmeetingsocial_content
    • id string · obligatoire : Identifiant de la chose à traduire, tel que rendu par l'outil de sa nature (list_admin_notes, list_tasks, list_meetings, list_social_contents).
    • locale string · obligatoire : Langue cible de la traduction : fr, en, es ou de.Valeurs
      frenesde
    Rend object
    Lien vers ce point d'entrée

L'API de Noki Mind

La clé, les portées, les enveloppes, le plafond d'appels et les codes de refus : tout ce qu'il faut savoir avant d'appeler.

Revenir au guide