Aperçu
Postman
Postman est un outil puissant pour le développement et le test d'API. Il vous permet de créer, gérer et tester des API en toute simplicité. GPTBots fournit des collections Postman pour faciliter les tests d'API.
Collections Postman GPTBots
Contraintes de base
L'API GPTBots est conçue pour être conforme aux spécifications HTTP et REST. Les requêtes de consultation utilisent la méthode GET, tandis que les requêtes de soumission utilisent la méthode POST. Une erreur sera retournée si une requête n'utilise pas la méthode HTTP appropriée.
Sauf indication contraire, les valeurs des paramètres doivent être encodées en UTF-8 avec encodage URL.
Authentification
L'API REST GPTBots utilise l'authentification HTTP Basic. Ajoutez l'en-tête Authorization suivant :
Authorization: Bearer ${API_Key}
Activation de l'API
- Pour activer le service API, rendez-vous sur le tableau de bord GPTBots, accédez à "Intégration d'Agent", sélectionnez "Service de développement-API" et cliquez sur le bouton "Activer" pour activer le service API.
- Après avoir activé le service API, cliquez sur la carte "API" pour accéder à la page de gestion de l'API. Cliquez sur le bouton "Créer une APIKey" pour générer une APIKey qui pourra être utilisée pour appeler les API GPTBots.
URLs de base de l'API
Format de l'URL API :
https://api-${endpoint}.gptbots.ai/
Le {endpoint} représente le centre de données sélectionné lors de la création de votre organisation. Les développeurs doivent choisir le {endpoint} approprié en fonction de leurs besoins spécifiques.
Liste des centres de données
Les centres de données disponibles pour la plateforme GPTBots sont listés ci-dessous :
| Centre de données | Endpoint | URL de base de l'API |
|---|---|---|
| Singapour | sg | https://api-sg.gptbots.ai/ |
| Japon | jp | https://api-jp.gptbots.ai/ |
| Thaïlande | th | https://api-th.gptbots.ai/ |
Si les développeurs ne spécifient pas
-{endpoint}dans l'URL de requête API, le centre de données par défaut sera Singapour.
Toutes les requêtes API doivent inclure le chemin d'endpoint approprié. Par exemple, pour une organisation utilisant le centre de données de Singapour, l'URL de la requête API serait :https://api-sg.gptbots.ai/v2/conversation
Catégories d'API
La plateforme GPTBots propose un ensemble complet d'interfaces API pour répondre aux besoins métier des développeurs. Les développeurs peuvent choisir les API adaptées à leurs besoins. Les catégories d'API sont les suivantes :
| Catégorie d'API | Description |
|---|---|
| API de conversation | Interagissez et conversez avec les Agents via cette API. |
| API de workflow | Envoyez des requêtes et recevez des réponses des workflows via cette API. |
| API de connaissances | Gérez les bases de connaissances sur la plateforme GPTBots via cette API. |
| API de base de données | Gérez les bases de données sur la plateforme GPTBots via cette API. |
| API de modèles | Accédez aux différentes capacités de modèles de la plateforme GPTBots via cette API. |
| API utilisateur | Configurez les informations utilisateur, les attributs et les coordonnées via cette API. |
| API d'analyse | Interrogez les données d'utilisation des crédits et des tokens via cette API. |
| API de compte | Récupérez les informations sur les Agents, les organisations, etc. du compte via cette API. |
Limites de débit de l'API
La plateforme GPTBots applique des limites de débit pour les appels API, avec des limites différentes selon les catégories d'API. Le dépassement de ces limites entraînera un message de dépassement de quota. Les limites spécifiques sont les suivantes :
- Formule gratuite : Toutes les catégories d'API sont limitées par défaut à 3 requêtes par minute.
- Formule entreprise personnalisée : Contactez les représentants commerciaux de GPTBots pour obtenir des privilèges personnalisés de limite de débit API.