Obtener información del agente

Obtener la información básica del agente.

Método de solicitud

GET

URL de la solicitud

https://api-${endpoint}.gptbots.ai/v1/bot/detail

Autenticación de la solicitud

Consulte Visión general para obtener los detalles de autenticación.

Solicitud

Ejemplo de solicitud

curl -X GET 'https://api-${endpoint}.gptbots.ai/v1/bot/detail' \ -H 'Authorization: Bearer ${API Key}'

                      
                      curl -X GET 'https://api-${endpoint}.gptbots.ai/v1/bot/detail' \
-H 'Authorization: Bearer ${API Key}'

Este bloque de código en una ventana flotante

Cabeceras de la solicitud

Campo	Valor	Descripción
Authorization	Bearer ${API Key}	Utilice `Authorization: Bearer ${API Key}` para la autenticación. Obtenga la clave de API en la página `API Key`.

Parámetros de la solicitud

Ninguno.

Respuesta

Ejemplo de respuesta

{ "bot_id": "645dd86606931c4a9e0ffb1e", "name": "Conversational App", "logo": "https://res.gptbots.ai/ailab/images/default_avatar.png", "bot_type": "QuestionAnswer", "welcome_message": "Welcome message when user first uses the bot", "introduction": "Introduction of the agent", "tags": "Tags of the agent", "identity_prompt": "Identity prompt of the agent", "creativity_level": 0.3, "doc_correlation": 0.2, "irrelevant_questions": true, "question_limit": 100, "long_term_memory": true }

                      
                      {
  "bot_id": "645dd86606931c4a9e0ffb1e",
  "name": "Conversational App",
  "logo": "https://res.gptbots.ai/ailab/images/default_avatar.png",
  "bot_type": "QuestionAnswer",
  "welcome_message": "Welcome message when user first uses the bot",
  "introduction": "Introduction of the agent",
  "tags": "Tags of the agent",
  "identity_prompt": "Identity prompt of the agent",
  "creativity_level": 0.3,
  "doc_correlation": 0.2,
  "irrelevant_questions": true,
  "question_limit": 100,
  "long_term_memory": true
}

Este bloque de código en una ventana flotante

Respuesta correcta

Campo	Tipo	Descripción
bot_id	string	ID del agente.
name	string	Nombre del agente.
logo	string	Avatar del agente.
bot_type	string	Tipo de agente; valores: `QuestionAnswer`, `Flow`.
welcome_message	string	Mensaje de bienvenida cuando el usuario utiliza el agente por primera vez.
introduction	string	Introducción del agente.
tags	array	Etiquetas del agente.
identity_prompt	string	Prompt de identidad del agente.
creativity_level	float	Nivel de creatividad; valor: 0-1.
doc_correlation	float	Correlación de documentos; valor: 0-1.
irrelevant_questions	boolean	Indica si se responden preguntas no relacionadas con el conjunto de datos; valores: `true`, `false`.
question_limit	int	Límite de longitud (tokens) de las preguntas del usuario.
long_term_memory	boolean	Indica si la memoria a largo plazo está habilitada.

Respuesta fallida

Campo	Tipo	Descripción
code	int	Código de error.
message	string	Detalles del error.

Códigos de error

Código	Mensaje
40127	Error de autenticación del desarrollador
20059	Agent eliminado