Producto
CLI

Crear Portal

Crea el portal web del workspace, donde tus clientes conversan con tus agentes de IA

Crear un portal

Crea el portal público del workspace activo: una URL donde tus clientes conversan con tus agentes de IA. Cada workspace puede tener un solo portal.

bash
01plazbot portal create -n <nombre> -t <título> [opciones]

Parámetros

ParámetroFlagRequeridoDescripción
Nombre-n, --name <name>SíNombre del portal
Título-t, --title <title>SíTítulo de bienvenida que se muestra en el portal
Subtítulo-s, --subtitle <subtitle>NoTexto que aparece debajo del título
Logo-l, --logo <url>NoURL del logo (.png o .jpg)
Logo modo oscuro-d, --logo-dark <url>NoURL del logo para modo oscuro (.png o .jpg)
Acceso-a, --access <type>Nodirect (abierto) o form (pide los datos de contacto antes de chatear). Por defecto direct
JSON--jsonNoImprime solo {"id","url"} en JSON

Ejemplos

bash
01# Portal con nombre y título de bienvenida
02plazbot portal create -n "Help Center" -t "¿En qué podemos ayudarte?"
03 
04# Con subtítulo y logos
05plazbot portal create -n "Help Center" -t "Bienvenido" -s "Pregunta a nuestros agentes" -l https://files.example.com/logo.png -d https://files.example.com/logo-dark.png
06 
07# Pedir los datos del visitante antes de chatear
08plazbot portal create -n "Soporte" -t "Bienvenido" -a form
09 
10# Crear y capturar el ID en un script
11plazbot portal create -n "Help Center" -t "Bienvenido" --json | jq -r '.id'

Resultado

text
01✔ Portal "Help Center" created
02 ID: por_AbcDef123
03 URL: https://la.plazbot.com/portal?id=por_AbcDef123&workspaceId=wok_AbcDef123
04 
05 Next: plazbot portal add-agent por_AbcDef123 -a <agentId>

El siguiente paso es asociar un agente con plazbot portal add-agent.

Salida JSON

json
01{
02 "id": "por_AbcDef123",
03 "url": "https://la.plazbot.com/portal?id=por_AbcDef123&workspaceId=wok_AbcDef123"
04}

Errores comunes

MensajeCausaSolución
This workspace already has a portal (only one is allowed).El workspace ya tiene portalMíralo con plazbot portal list o cámbialo con plazbot portal update
Invalid logo for --logo: "..."El logo no termina en .png/.jpg o no es una URL https:// ni una ruta que empiece con /Usa una URL .png o .jpg
Invalid access type "..."-a distinto de direct o formUsa direct o form
Portal name is required. / Portal title is required.-n o -t vacíosPasa un valor no vacío
You are not signed in.No hay sesiónEjecuta plazbot login

Los logos deben ser .png o .jpg, como URL https:// o como ruta que empiece con /.

¿Quieres probar la API en vivo? Abre el Playground.