Visión general
Postman
Postman es una herramienta potente para el desarrollo y las pruebas de API. Permite crear, gestionar y probar API con facilidad. GPTBots proporciona colecciones de Postman para facilitar las pruebas de API.
Colecciones de Postman de GPTBots
Restricciones básicas
La API de GPTBots está diseñada para cumplir las especificaciones HTTP y REST. Las solicitudes de consulta utilizan el método GET, mientras que las solicitudes de envío utilizan el método POST. Si una solicitud no utiliza el método HTTP adecuado, se devolverá un error.
A menos que se indique lo contrario, los valores de los parámetros deben codificarse en UTF-8 con codificación de URL.
Autenticación
La API REST de GPTBots utiliza autenticación mediante token Bearer en el encabezado HTTP Authorization. Añadir el encabezado Authorization siguiente:
Authorization: Bearer ${API_Key}
Activación de la API
- Habilitar el servicio de API: acceder al panel de GPTBots, ir a «Agent Integration», seleccionar «Development-API Service» y hacer clic en «Enable».
- Tras habilitar el servicio de API, hacer clic en la tarjeta «API» para acceder a la página de gestión de API. Hacer clic en el botón «Create APIKey» para generar una API key (APIKey) que pueda utilizarse para llamar a las API de GPTBots.
URL base de la API
Formato de URL de la API:
https://api-${endpoint}.gptbots.ai/
{endpoint}representa el centro de datos seleccionado al crear la organización. Los desarrolladores deben elegir el{endpoint}adecuado según sus requisitos específicos.
Lista de centros de datos
A continuación se enumeran los centros de datos disponibles para la plataforma GPTBots:
| Centro de datos | Endpoint | URL base de la API |
|---|---|---|
| Singapur | sg | https://api-sg.gptbots.ai/ |
| Japón | jp | https://api-jp.gptbots.ai/ |
| Tailandia | th | https://api-th.gptbots.ai/ |
Si los desarrolladores no especifican
-{endpoint}en la URL de la solicitud de API, el centro de datos predeterminado será Singapur.
Todas las solicitudes de API deben incluir la ruta del endpoint adecuada. Por ejemplo, para una organización que utiliza el centro de datos de Singapur, la URL de solicitud de API sería:https://api-sg.gptbots.ai/v2/conversation
Categorías de API
La plataforma GPTBots proporciona un conjunto completo de interfaces de API para satisfacer las necesidades empresariales de los desarrolladores. Los desarrolladores pueden elegir las API adecuadas en función de sus requisitos. Las categorías de API son las siguientes:
| Categoría de API | Descripción |
|---|---|
| API de conversación | Interactuar y conversar con agentes a través de esta API. |
| API de flujo de trabajo | Enviar solicitudes y recibir respuestas de flujos de trabajo a través de esta API. |
| API de conocimiento | Gestionar bases de conocimiento en la plataforma GPTBots a través de esta API. |
| API de base de datos | Gestionar bases de datos en la plataforma GPTBots a través de esta API. |
| API de modelos | Acceder a diversas capacidades de modelos de la plataforma GPTBots a través de esta API. |
| API de usuario | Configurar información, atributos y detalles de contacto del usuario a través de esta API. |
| API de analítica | Consultar datos de uso de créditos y tokens a través de esta API. |
| API de cuenta | Recuperar información sobre agentes, organizaciones, etc., dentro de la cuenta a través de esta API. |
Límites de velocidad de la API
La plataforma GPTBots implementa límites de velocidad para las llamadas a la API, con límites diferentes según la categoría de API. Si se superan estos límites, se devolverá un mensaje de límite de velocidad excedido. Los límites específicos son:
- Plan gratuito: todos los tipos de API están limitados a 3 solicitudes por minuto de forma predeterminada.
- Plan empresarial personalizado: ponerse en contacto con los representantes comerciales de GPTBots para obtener privilegios de límite de velocidad de API personalizados.