Plazbot Developers

Documentacion de Plazbot

Integra agentes de IA, contactos, conversaciones y WhatsApp en tu producto con la API REST, el SDK de TypeScript y la CLI de Plazbot.

Plazbot expone una API REST sobre HTTPS con la que puedes gestionar workspaces, agentes de IA, contactos, conversaciones, mensajes, oportunidades, tareas y plantillas. Todas las respuestas son JSON y todos los endpoints requieren autenticacion.

Prueba la API en vivo

El Playground te permite ejecutar los 111 endpoints directamente desde el navegador con tu propia API Key. Las credenciales se guardan solo en tu navegador.

Base URLs

La API esta disponible en dos regiones. Usa la base URL que corresponde a la zona de tu workspace.

Zona	Region	Base URL
LA	Latinoamerica	https://api.plazbot.com
EU	Europa	https://apieu.plazbot.com

Autenticacion

Todas las requests requieren dos headers: la API Key como Bearer token y el identificador del workspace. Puedes generar tu API Key desde la app de Plazbot, en la seccion de configuracion del workspace.

Ejemplo con curl·bash

01curl https://api.plazbot.com/api/contact/list?workspaceId=wok_XXXXXXXXXXXXXXXXXXXXXX \
02  -H "Authorization: Bearer eyJhbGciOiJIUzI1NiIs..." \
03  -H "x-workspace-id: wok_XXXXXXXXXXXXXXXXXXXXXX"

Protege tu API Key

La API Key da acceso completo a tu workspace. No la expongas en codigo del frontend ni la subas a repositorios; usala solo desde tu backend o desde el Playground.

Formato de respuesta

Todos los endpoints responden con el mismo envelope JSON, tanto en exitos como en errores.

json

01{
02  "success": true,
03  "code": 200,
04  "errorCode": null,
05  "message": "Operacion realizada correctamente",
06  "data": { }
07}

Campo	Tipo	Descripcion
success	boolean	Indica si la operacion fue exitosa.
code	number	Codigo HTTP de la respuesta.
errorCode	string \| null	Codigo interno del error; null si no hubo error.
message	string	Mensaje descriptivo de la operacion.
data	object \| array \| null	Payload de la respuesta.

Herramientas

API REST: 111 endpoints organizados en 11 modulos, documentados y ejecutables desde el Playground.
SDK de TypeScript: el paquete npm plazbot con modulos para agentes, contactos, mensajes, portal y widget, mas componentes React.
CLI: la linea de comandos de Plazbot para crear agentes, portales, workers y flujos de WhatsApp desde la terminal.

API Playground

Explora y ejecuta los 111 endpoints de la API con tu propia API Key, sin salir del navegador.

SDK de TypeScript

Instala el paquete plazbot y usa los modulos de agentes, contactos, mensajes y React.

CLI

Crea agentes, portales, workers y flujos de WhatsApp desde la terminal.