Importar y crear Agent

Permite subir un archivo .bot e importarlo como Agent de una organización.

Mediante esta interfaz, se puede subir un archivo .bot e importarlo como Agent de una organización. Tras una importación correcta, se crea automáticamente una API Key, pero dicha Key tiene la gestión de versiones deshabilitada de forma predeterminada.

Método de solicitud

POST

URL de la solicitud

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

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' \ -H 'Authorization: Basic ${BASIC_TOKEN}' \ -F 'file=@/path/to/agent.bot' \ -F 'org_id=p-xxxx' \ -F 'custom_name=Imported Agent' \ -F 'enable_api=true' \ -F 'group_id=group-xxxx'

                      
                      curl -X POST 'https://api.${endpoint}/v1/org/agent/import' \
  -H 'Authorization: Basic ${BASIC_TOKEN}' \
  -F 'file=@/path/to/agent.bot' \
  -F 'org_id=p-xxxx' \
  -F 'custom_name=Imported Agent' \
  -F 'enable_api=true' \
  -F 'group_id=group-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`. Los archivos MultiAgent no son compatibles.	true
org_id	String	ID de la organización.	true
custom_name	String	Nombre personalizado del Agent tras la importación.	false
enable_api	Boolean	Indica si se intenta habilitar la API; el valor predeterminado es `true`. Si el plan no admite la API, la importación se realiza igualmente y se devuelve `api_enabled=false`.	false
group_id	String	Grupo de Agent al que se añade tras una importación correcta.	false

Respuesta

Ejemplo de respuesta

{ "code": 0, "message": "OK", "data": { "agent_id": "bot-xxxx", "name": "Imported Agent", "bot_type": "AGENT", "api_key": "app-xxxx", "api_enabled": true, "version_manage_enabled": false, "warning": null } }

                      
                      {
  "code": 0,
  "message": "OK",
  "data": {
    "agent_id": "bot-xxxx",
    "name": "Imported Agent",
    "bot_type": "AGENT",
    "api_key": "app-xxxx",
    "api_enabled": true,
    "version_manage_enabled": false,
    "warning": null
  }
}

Este bloque de código en una ventana flotante

Respuesta correcta

Campo	Tipo	Descripción
agent_id	String	ID del Agent tras la importación.
name	String	Nombre del Agent.
bot_type	String	Tipo de Agent: `Agent`, `FlowAgent`, `LoopAgent`, `Audio`.
api_key	String	API Key creada automáticamente, que solo se devuelve una vez. Esta key no tiene permiso de publicación; si necesita publicar, debe crear una Key manualmente.
api_enabled	Boolean	Indica si la API está habilitada.
version_manage_enabled	Boolean	Indica si se permite la gestión de versiones; deshabilitada de forma predeterminada al importar.
warning	String	Advertencia de la importación.

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