Producto
CLI

Exportar agente

Exporta la configuración limpia de un agente en JSON.

Exportar agente

Exporta la configuración de un agente como JSON limpio, compatible con create, update y la importación de JSON en la plataforma. Por defecto no incluye los canales ni la configuración de IA (que contiene API keys de terceros): agrégalos con --channels y --ai.

bash
01plazbot agent export <agentId> [options]

Parámetros

ParámetroFlagRequeridoDescripción
agentId(posicional)SíID del agente a exportar.
Archivo-o, --output <path>NoEscribe el JSON en este archivo en lugar de stdout.
Canales--channelsNoIncluye los canales (son propios del workspace). Por defecto: false.
IA--aiNoIncluye la configuración de IA propia (customAIConfig, aiProviders) y la clave del avatar (avatarApiKey). Contiene API keys de terceros. Por defecto: false.
JSON--jsonNoCon -o, imprime {"output","id","name"}. Sin -o, el JSON del agente se imprime igual. Por defecto: false.

Qué incluye

  • Solo los campos de primer nivel que admite el schema del agente (sin id, fechas ni campos internos), sin valores null.
  • Sin --channels, la clave channels se omite. Sin --ai, se omiten customAIConfig, aiProviders y avatarApiKey. Las claves se omiten (no se ponen vacías) para que el flujo exportar, editar y update no borre los canales ni la IA del agente.

Ejemplos

bash
01# Imprimir el JSON limpio en stdout
02plazbot agent export age_AbcDef123
03 
04# Guardarlo en un archivo
05plazbot agent export age_AbcDef123 -o ./agent.json
06 
07# Incluir canales y configuración de IA (contiene API tokens)
08plazbot agent export age_AbcDef123 -o ./agent.json --channels --ai

Resultado

Sin -o, stdout solo contiene el JSON, así que puedes redirigirlo (plazbot agent export age_AbcDef123 > agent.json). Los mensajes informativos van a stderr:

text
01✔ Agent fetched: Sales Plazbot
02{
03 "name": "Sales Plazbot",
04 "description": "Asistente virtual de ventas",
05 "prompt": "...",
06 "zone": "LA",
07 "buffer": 5,
08 ...
09}
10 
11 This JSON is compatible with:
12 - plazbot agent create <file.json>
13 - plazbot agent update <agentId> <file.json>
14 - Importing JSON in the platform (AgentTraining)
15 Not included: channels (--channels), AI configuration (--ai)

Con -o:

text
01✔ Agent fetched: Sales Plazbot
02 
03 Exported to: /home/user/agent.json

Salida JSON

Con -o y --json:

json
01{
02 "output": "/home/user/agent.json",
03 "id": "age_AbcDef123",
04 "name": "Sales Plazbot"
05}

Con --ai el archivo contiene los API tokens de tus proveedores de IA en texto plano. No lo compartas ni lo subas a un repositorio.

Errores comunes

MensajeCausaSolución
Agent age_AbcDef123 was not found in workspace wok_AbcDef123.El ID no existe en ese workspace.Revisa el ID con plazbot agent list.
--zone must be LA or EU (got "<valor>").-z no es LA ni EU.Usa -z LA o -z EU.
You are not signed in.No hay sesión activa.Ejecuta plazbot login.
¿Quieres probar la API en vivo? Abre el Playground.