Producto
CLI

Obtener agente

Muestra la configuración completa de un agente.

Obtener agente

Muestra la configuración de un agente en un formato legible: información básica, prompt, ejemplos, instrucciones, persona, fallbacks, reglas, servicios, acciones, canales y modelo de IA. Con --json imprime el documento completo del agente.

bash
01plazbot agent get <agentId> [options]

Parámetros

ParámetroFlagRequeridoDescripción
agentId(posicional)SíID del agente, por ejemplo age_AbcDef123.
JSON--jsonNoImprime el agente completo como JSON. Por defecto: false.

Ejemplos

bash
01# Ver el agente en formato legible
02plazbot agent get age_AbcDef123
03 
04# Obtener el JSON completo (útil con jq)
05plazbot agent get age_AbcDef123 --json

Resultado

text
01 ┌──────────────────────────────────────────────────────────┐
02 │ Sales Plazbot │
03 │ age_AbcDef123 │
04 └──────────────────────────────────────────────────────────┘
05 
06 Basic Information
07 ────────────────────────────────────────
08 ID: age_AbcDef123
09 Name: Sales Plazbot
10 Description: Asistente virtual de ventas
11 Status: Active
12 Zone: LA
13 Buffer: 5
14 Color: blue
15 Initial question: ¿En qué te puedo ayudar?
16 Timezone: America/Lima
17 Show in chat: Yes
18 Tool Calling: Enabled
19 
20 Prompt
21 ────────────────────────────────────────
22 Eres un asesor comercial que ayuda a los clientes...
23 
24 Instructions
25 ────────────────────────────────────────
26 Tone: amigable
27 Style: conciso
28 ...
29 
30 Services (1)
31 ────────────────────────────────────────
32 1. check_order_status
33 Reference: Cuando el cliente pregunta por su pedido
34 Enabled: Yes
35 Method: GET
36 Endpoint: https://api.example.com/orders/{{orderId}}
37 
38 Use --json to see the full JSON

Salida JSON

Con --json se imprime el documento del agente tal como lo devuelve la API (todos sus campos: name, prompt, instructions, person, services, actions, channels, aiProviders, etc.). Para obtener un JSON limpio y listo para create o update, usa plazbot agent export.

Errores comunes

MensajeCausaSolución
Agent "age_AbcDef123" was not found in workspace wok_AbcDef123 (zone LA).El ID no existe en el workspace o la zona activa.Revisa con plazbot whoami y plazbot agent list; cambia de workspace con plazbot workspace use <workspaceId>.
Invalid zone "XX".-z no es LA ni EU.Usa -z LA o -z EU.
You do not have permission to access agent "age_AbcDef123" in workspace wok_AbcDef123.Tu sesión no tiene acceso a ese workspace.Cambia al workspace correcto.
You are not signed in.No hay sesión activa.Ejecuta plazbot login.
¿Quieres probar la API en vivo? Abre el Playground.