Verificación previa del archivo de importación de Agent

Permite verificar previamente si un archivo .bot se puede importar, sin escribir recursos de negocio.

Mediante esta interfaz, se puede verificar previamente si un archivo .bot se puede importar. La verificación previa solo analiza y escanea el archivo en busca de amenazas de seguridad, sin escribir el Agent, la API Key, las habilidades, los grupos de datos ni las relaciones de plugins.

Método de solicitud

POST

URL de la solicitud

https://api.${endpoint}/v1/org/agent/import/precheck

Autenticación de la solicitud

Utiliza la autenticación Basic con DevKey / DevSecret a nivel de cuenta y requiere que la cuenta que realiza la llamada tenga permiso de creación de Agent de la organización.

Solicitud

Ejemplo de solicitud

curl -X POST 'https://api.${endpoint}/v1/org/agent/import/precheck' \ -H 'Authorization: Basic ${BASIC_TOKEN}' \ -F 'file=@/path/to/agent.bot' \ -F 'org_id=p-xxxx'

                      
                      curl -X POST 'https://api.${endpoint}/v1/org/agent/import/precheck' \
  -H 'Authorization: Basic ${BASIC_TOKEN}' \
  -F 'file=@/path/to/agent.bot' \
  -F 'org_id=p-xxxx'

Este bloque de código en una ventana flotante

Cabeceras de la solicitud

Campo	Tipo	Descripción
Authorization	Basic ${BASIC_TOKEN}	Basic Token resultante de codificar `DevKey:DevSecret` en Base64.
Content-Type	multipart/form-data	Formulario de carga de archivos.

Parámetros de la solicitud (Form Data)

Campo	Tipo	Descripción	Obligatorio
file	File	Archivo `.bot`.	true
org_id	String	ID de la organización.	true

Respuesta

Ejemplo de respuesta

{ "code": 0, "message": "OK", "data": { "valid": true, "error_message": null, "export_type": "BOT", "bot_type": "Agent", "name": "Imported Agent", "logo": "https://cdn.example.com/agent.png", "introduction": "Agent introduction", "format_version": "1.0" } }

                      
                      {
  "code": 0,
  "message": "OK",
  "data": {
    "valid": true,
    "error_message": null,
    "export_type": "BOT",
    "bot_type": "Agent",
    "name": "Imported Agent",
    "logo": "https://cdn.example.com/agent.png",
    "introduction": "Agent introduction",
    "format_version": "1.0"
  }
}

Este bloque de código en una ventana flotante

Respuesta correcta

Campo	Tipo	Descripción
valid	Boolean	Indica si el archivo se puede importar.
error_message	String	Mensaje de error cuando no se puede importar.
export_type	String	Tipo de archivo exportado.
bot_type	String	Tipo de Agent: `Agent`, `FlowAgent`, `LoopAgent`, `Audio`.
name	String	Nombre del recurso dentro del archivo.
logo	String	URL del icono.
introduction	String	Introducción.
format_version	String	Versión del formato del archivo.

Respuesta fallida

Campo	Tipo	Descripción
code	Integer	Código de error.
message	String	Detalles del error.

Códigos de estado

Código de estado	Descripción
200	Correcto
400	Error de parámetros
401	No autorizado
403	Permisos insuficientes
429	Demasiadas solicitudes
500	Error del servidor