API Documentation v1

Base URL: https://prompt.agence-felix.fr/v1/run-tool

Request Method

POST

Authorization

Use a Bearer Token for authorization.

Fields

Field	Type	Description
`tool`	int	Corresponds to the tool ID.
`site`	int	Optional. Corresponds to the site configuration. A default configuration exists.
`locale`	string	Optional. Default is `FR`.
`mediaPath`	string	The full URL where the image is hosted. Used only for Analyze Image (tool 4).
`base64`	string	The full base64 image. Used only for Analyze Image (tool 4).
`urlPath`	string	The full URL of the web page to analyze. Used for Analyze Page (tool 3) and SEO Meta (tool 2).
`userMessage`	string	The message provided by the user for the chatbot. Tool 1 (Chatbot) has two cases: - Provide `userMessage` to interact with the chatbot. - Omit `userMessage` to retrieve the chat history.

Response

All responses are returned in JSON format:

{
    "httpCode": int,
    "tool": int,
    "message": string,
    "response": object
}

Response Examples

Chatbot

If retrieving chat history:

POST /v1/run-tool HTTP/1.1
Host: prompt.agence-felix.fr
Content-Type: application/json
Authorization: Bearer *******************
JSON BODY
{
   "tool": 1
}

{
    "httpCode": 200,
    "tool": 1,
    "message": "success",
    "response": {
        "historic": [
            {
                "role": "user",
                "text": "je suis un test"
            },
            {
                "role": "assistant",
                "text": "Il semble que vous ayez téléchargé une notice d'utilisation pour un CMS. Si vous avez des questions spécifiques ou si vous avez besoin d'aide concernant une fonctionnalité particulière de ce CMS, n'hésitez pas à me le faire savoir. Je suis ici pour vous aider à naviguer et à utiliser efficacement votre système de gestion de contenu."
            }
        ]
    }
}

If send user message:

POST /v1/run-tool HTTP/1.1
Host: prompt.agence-felix.fr
Content-Type: application/json
Authorization: Bearer *******************
JSON BODY
{
    "tool": 1,
    "userMessage": "Comment créer un bloc ?"
}

{
"httpCode": 200,
"tool": 1,
"message": "success",
"response": {
"text": "Pour créer un bloc dans votre CMS, suivez les étapes suivantes :

1. Accéder à la Page : Allez dans l'onglet 'Pages' de votre CMS et éditez la page sur laquelle vous souhaitez ajouter un bloc.

2. Ajouter une Ligne :
- Cliquez sur ‘Ajouter une ligne’.
- Choisissez le type de ligne qui correspond à vos besoins (par exemple, une ligne pleine ou divisée en colonnes).
- Cliquez sur ‘Ajouter’ pour insérer la ligne dans votre page.

3. Ajouter une Colonne :
- Cliquez sur ‘Ajouter une colonne’.
- Sélectionnez la taille de colonne souhaitée.
- Cliquez sur ‘Ajouter’ pour insérer la colonne dans votre ligne.

4. Ajouter un Bloc :
- Cliquez sur le petit ‘plus rouge’ situé dans la colonne où vous souhaitez ajouter un bloc.
- Un onglet s’ouvrira vous permettant de choisir parmi différents types de blocs.

5. Choisir le Type de Bloc : Sélectionnez le type de bloc que vous souhaitez ajouter. Voici quelques exemples de blocs disponibles :
- Bloc En-tête : Pour introduire votre page avec un titre et une image.
- Bloc Titre : Pour structurer l’arborescence de votre page.
- Bloc Texte : Pour ajouter du texte avec des options de mise en forme.
- Bloc Médias : Pour insérer des images ou des fichiers PDF.

6. Configurer le Bloc : Remplissez les champs obligatoires et optionnels selon le type de bloc choisi. Par exemple, pour un bloc texte, vous devrez entrer une description et vous pouvez ajouter une introduction ou modifier la couleur de police.

7. Enregistrer les Modifications : Une fois que vous avez configuré votre bloc, cliquez sur ‘Enregistrer’ pour sauvegarder vos modifications.

En suivant ces étapes, vous pourrez ajouter et configurer des blocs sur vos pages dans le CMS. Si vous avez besoin de plus d'informations sur un type de bloc spécifique, n'hésitez pas à demander."
}
}

SEO Meta

POST /v1/run-tool HTTP/1.1
Host: prompt.agence-felix.fr
Content-Type: application/json
Authorization: Bearer *******************
JSON BODY
{
    "tool": 2,
    "urlPath": "https://www.valdisere-agence.com/"
}

{
    "httpCode": 200,
    "tool": 2,
    "message": "success",
    "response": {
        "metaTitle": "Remises Exceptionnelles sur Nos Biens à Val d'Isère",
        "metaDescription": "Profitez de 20% de remise sur une sélection de biens à Val d'Isère du 01 au 08 Février 2025. Découvrez nos offres spéciales et contactez-nous pour plus d'infos!"
    }
}

Analyze Page

POST /v1/run-tool HTTP/1.1
Host: prompt.agence-felix.fr
Content-Type: application/json
Authorization: Bearer *******************
JSON BODY
{
    "tool": 3,
    "urlPath": "https://www.valdisere-agence.com/"
}

{
    "httpCode": 200,
    "tool": 3,
    "message": "success",
    "response": {
        "text": "Corrections

1. Orthographe et grammaire :
   - \"séléction\" → \"sélection\"
   - \"N’hésitez pas à nous contacter !\" → \"N’hésitez pas à nous contacter !\"
   - \"Préparez vous\" → \"Préparez-vous\"
   - \"au coeur\" → \"au cœur\"
   - \"l'histoire des l...\" → \"l'histoire des lieux...\"
   - \"tranquilité\" → \"tranquillité\"
   - \"au meilleur tarif !\" → \"au meilleur tarif !\"

Reformulations

1. Amélioration de la lisibilité :
   - \"Profitez de 20% de remise sur une sélection de biens du 01 au 08 Février 2025 !\" → \"Bénéficiez d'une remise de 20 % sur une sélection de biens du 1er au 8 février 2025 !\"
   - \"L'Écrin est de ces réhabilitations d'envergure de très belle facture, qui respectent l'environnement et l'histoire des lieux...\" → \"L'Écrin est une réhabilitation d'envergure de grande qualité, respectant à la fois l'environnement et l'histoire des lieux...\"
   - \"Découvrez nos hébergements au meilleur tarif !\" → \"Explorez nos hébergements à des tarifs imbattables !\"
   - \"Le service haut de gamme de Val d’Isère, qui vous propose d’organiser votre séjour avant et pendant, de gérer votre bien tout au long de l’année, ainsi que des aménagements selon vos envies.\" → \"Notre service haut de gamme à Val d’Isère vous permet d'organiser votre séjour avant et pendant votre visite, de gérer votre bien tout au long de l'année et de réaliser des aménagements selon vos souhaits.\"

Suggestions SEO

1. Optimisation des titres :
   - Utiliser des titres H1, H2 et H3 de manière cohérente pour structurer le contenu. Par exemple, le titre principal pourrait être \"Offres Spéciales et Nouveautés à Val d'Isère\" pour mieux refléter le contenu.
   - Ajouter des mots-clés pertinents dans les titres, comme \"Chalets à Val d'Isère\", \"Programmes Neufs\", \"Appartements à vendre\", etc.

2. Mots-clés :
   - Intégrer des mots-clés tels que \"location de chalet\", \"appartements à vendre à Val d'Isère\", \"séjour à la montagne\", \"immobilier de luxe\", etc., dans le texte pour améliorer le référencement.
   - Utiliser des synonymes et des expressions connexes pour enrichir le contenu et attirer un public plus large.

3. Paragraphes :
   - Diviser les longs paragraphes en sections plus courtes pour améliorer la lisibilité. Par exemple, chaque offre spéciale pourrait être présentée dans un paragraphe distinct avec un sous-titre.
   - Ajouter des listes à puces pour les caractéristiques des biens, ce qui facilite la lecture et la compréhension.

En appliquant ces corrections, reformulations et suggestions SEO, le contenu sera non seulement plus clair et professionnel, mais également mieux optimisé pour les moteurs de recherche, ce qui peut contribuer à attirer davantage de clients potentiels."
    }
}

Analyze Image

POST /v1/run-tool HTTP/1.1
Host: prompt.agence-felix.fr
Content-Type: application/json
Authorization: Bearer *******************
JSON BODY
{
    "tool": 4,
    "mediaPath": "https://www.valdisere-agence.com/thumbnails/arkiane_big_card_mobile/rc/5LotTkTs/arkiane/rentals/2340271/6720c0bbe5193-0002340271_01.jpg"
}

        OR
{
    "tool": 4,
    "base64": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABgAAAAYCAYAAADgdz34AAAABHNCSVQICAgIfAhkiAAAAAlwSFlzAAAApgAAAKYB3X3/OAAAABl0RVh0U29mdHdhcmUAd3d3Lmlua3NjYXBlLm9yZ5vuPBoAAANCSURBVEiJtZZPbBtFFMZ/M7ubXdtdb1xSFyeilBapySVU8h8OoFaooFSqiihIVIpQBKci6KEg9Q6H9kovIHoCIVQJJCKE1ENFjnAgcaSGC6rEnxBwA04Tx43t2FnvDAfjkNibxgHxnWb2e/u992bee7tCa00YFsffekFY+nUzFtjW0LrvjRXrCDIAaPLlW0nHL0SsZtVoaF98mLrx3pdhOqLtYPHChahZcYYO7KvPFxvRl5XPp1sN3adWiD1ZAqD6XYK1b/dvE5IWryTt2udLFedwc1+9kLp+vbbpoDh+6TklxBeAi9TL0taeWpdmZzQDry0AcO+jQ12RyohqqoYoo8RDwJrU+qXkjWtfi8Xxt58BdQuwQs9qC/afLwCw8tnQbqYAPsgxE1S6F3EAIXux2oQFKm0ihMsOF71dHYx+f3NND68ghCu1YIoePPQN1pGRABkJ6Bus96CutRZMydTl+TvuiRW1m3n0eDl0vRPcEysqdXn+jsQPsrHMquGeXEaY4Yk4wxWcY5V/9scqOMOVUFthatyTy8QyqwZ+kDURKoMWxNKr2EeqVKcTNOajqKoBgOE28U4tdQl5p5bwCw7BWquaZSzAPlwjlithJtp3pTImSqQRrb2Z8PHGigD4RZuNX6JYj6wj7O4TFLbCO/Mn/m8R+h6rYSUb3ekokRY6f/YukArN979jcW+V/S8g0eT/N3VN3kTqWbQ428m9/8k0P/1aIhF36PccEl6EhOcAUCrXKZXXWS3XKd2vc/TRBG9O5ELC17MmWubD2nKhUKZa26Ba2+D3P+4/MNCFwg59oWVeYhkzgN/JDR8deKBoD7Y+ljEjGZ0sosXVTvbc6RHirr2reNy1OXd6pJsQ+gqjk8VWFYmHrwBzW/n+uMPFiRwHB2I7ih8ciHFxIkd/3Omk5tCDV1t+2nNu5sxxpDFNx+huNhVT3/zMDz8usXC3ddaHBj1GHj/As08fwTS7Kt1HBTmyN29vdwAw+/wbwLVOJ3uAD1wi/dUH7Qei66PfyuRj4Ik9is+hglfbkbfR3cnZm7chlUWLdwmprtCohX4HUtlOcQjLYCu+fzGJH2QRKvP3UNz8bWk1qMxjGTOMThZ3kvgLI5AzFfo379UAAAAASUVORK5CYII="
}

{
    "httpCode": 200,
    "tool": 4,
    "message": "success",
    "response": {
        "alt": "Intérieur d'un salon moderne et chaleureux avec un canapé en L, des coussins en fourrure, une table basse en bois, un lustre élégant et de grandes fenêtres offrant une vue sur la nature."
    }
}

Spelling correction

POST /v1/run-tool HTTP/1.1 Host: prompt.agence-felix.fr Content-Type: application/json Authorization: Bearer ******************* JSON BODY { "tool": 5, "userMessage": "

Je suis un texte aaa corrigé

" }

{
    "httpCode": 200,
    "tool": 5,
    "message": "success",
    "response": {
        "correction": "Je suis un texte a corriger"
    }
}

Embedding generator

POST /v1/run-tool HTTP/1.1
Host: prompt.agence-felix.fr
Content-Type: application/json
Authorization: Bearer *******************
JSON BODY
{
    "tool": 8,
    "userkeyword": "Je suis un titre h2"
}

{
    "httpCode": 200,
    "tool": 8,
    "message": "success",
    "response": {
         0.03815756,
         0.026415724,
        -0.04481263,
        -0.09186181,
        -0.0009870098,
        -0.020906197,
        -0.048685666,
    }
}

Tools

Tool ID	Description
1	Chatbot
2	SEO Meta Title and Description
3	Analyze Page
4	Analyze Image
5	Spelling correction
8	Embedding generator

Tool-Specific Errors

SEO Meta Title and Description: Missing urlPath
Analyze Page: Missing urlPath
Generate ALT img : Missing mediaPath or base64
Spelling correction: Missing userMessage
Embedding generator: Missing userkeyword

Error Responses

HTTP Code	Message
401	Not authorized
400	Depends on the error