Vue d'ensemble

L'API Chat facilite la récupération des chatbots et permet aux utilisateurs d'interagir avec eux en postant des messages.

URL de base

https://app.openspokenai.com/api

Authentification

Les clients doivent s'authentifier avec un en-tête Basic Authorization pour chaque requête :

Autorisation : Basic {authString}

Où {authString} est la chaîne encodée en base64 du format nom d'utilisateur:mot de passe.

Exemple d'utilisation : 

curl -X GET "https://app.openspokenai.com/api/chat" -H "Authorization : Basic {authString}"

Points finaux

GET /chat

Récupère une liste des chats actifs disponibles pour l'interaction.

Paramètres d'interrogation :

groupe (facultatif) : Filtrer les chats en fonction d'un groupe spécifique.

Réponse positive :

{

    "message" : "succès",

    "données" : [

        {

            "nom" : "string",

            "chat_code" : "string",

            "description" : "string",

            "groupe" : "string"

        }

    ]

}

Aucun contenu n'a été trouvé :

{

    "message" : "erreur",

    "données" : {

        "message" : "Aucun chatbot n'a été trouvé pour le groupe spécifié".

    }

}

POST /chat

Envoyer un message à un chat spécifique et recevoir une réponse.

En-têtes :

Content-Type : application/json

Autorisation : Basic {authString}

Charge utile requise :

prompt : (string) Le texte d'entrée pour la réponse du chat.

request_id : (string) Un identifiant unique pour suivre la demande.

webhook_url (facultatif) : (URL) Point d'arrivée auquel la réponse doit être envoyée via le webhook.

Réponse positive :

{

    "message" : "succès",

    "données" : {

        "request_id" : "string",

        "message" : "chaîne"

    }

}

Réponses aux erreurs :

Crédits insuffisants :

{

    "message" : "erreur",

    "données" : {

        "message" : "Vous n'avez plus de crédits pour générer des mots. Veuillez recharger et réessayer."

    }

}

Chatbot introuvable :

{

    "message" : "erreur",

    "données" : {

        "message" : "Chatbot not found".

    }

}

Échec du webhook :

{

    "message" : "erreur",

    "données" : {

        "message" : "Failed to send response to webhook".

    }

}