Documentation de l’API Ai-Sista

Intégrez votre chatbot d’entreprise avec n’importe quelle application.

Authentification

Toutes les requêtes API nécessitent une clé API pour l’authentification. Vous pouvez générer et gérer votre clé API depuis la page 'Connexion' de votre tableau de bord d’entreprise.

La clé API doit être incluse dans l’en-tête de chaque requête comme suit :

api-key: YOUR_API_KEY

URL de base : https://Aisista.com/api/

GET Voir l’historique de discussion

/api/?method=gethistory

Ce point de terminaison récupère l’historique de conversation pour un utilisateur spécifique, identifié par un `chat_id` unique.

Paramètres

Paramètre Type Description
method String Obligatoire. Doit être 'gethistory'.
chat_id String | Integer Obligatoire. Un identifiant unique pour votre utilisateur final (par exemple, identifiant utilisateur de votre système, identifiant de session).

Exemple de requête (kurl)

curl -X GET "https://Aisista.com/api/?method=gethistory&chat_id=USER12345" \
-H "api-key: YOUR_API_KEY"

Exemple de réponse

[
    {
        "user": "Hello, what are your opening hours?",
        "chatbot": "We are open from 9 AM to 5 PM on weekdays.",
        "to_follow": null,
        "time": "2024-08-15 10:30:00"
    },
    {
        "user": "Thanks!",
        "chatbot": "You're welcome! Is there anything else I can help with?",
        "to_follow": null,
        "time": "2024-08-15 10:30:15"
    }
]

POST Envoyer un nouveau message

/api/?method=newmessage

Ce point de terminaison envoie un nouveau message d’un utilisateur au chatbot et retourne la réponse générée par l’IA.

Paramètres

Paramètre Type Description
method String Obligatoire. Doit être 'newmessage'.
chat_id String | Integer Obligatoire. Un identifiant unique pour votre utilisateur final. Cela garantit la continuité de la conversation.
message String Obligatoire. Le texte du message de l’utilisateur.
system_prompt String Optionnel. Instructions supplémentaires et temporaires pour l’IA concernant ce message spécifique. Par exemple, vous pouvez transmettre des données spécifiques à l’utilisateur comme 'Le nom de l’utilisateur est John Doe.'

Exemple de requête (kurl)

curl -X POST "https://Aisista.com/api/" \
-H "api-key: YOUR_API_KEY" \
-d "method=newmessage" \
-d "chat_id=USER12345" \
-d "message=Do you ship to Canada?" \
-d "system_prompt=The user is currently viewing the 'Leather Watch' product page."

Exemple de réponse

{
    "ok": true,
    "response": "Yes, we ship to Canada! Shipping for the Leather Watch takes about 5-7 business days."
}

Gestion des erreurs

Si une requête échoue, l’API retournera un objet JSON avec une clé `error` contenant un message descriptif.

Exemple de réponse d’erreur

{
    "error": "Invalid API key"
}