Documentación 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 autenticación.
Base URLs
La API está disponible en dos regiones. Usa la base URL que corresponde a la zona de tu workspace.
| Zona | Región | Base URL |
|---|---|---|
| LA | Latinoamérica | https://api.plazbot.com |
| EU | Europa | https://apieu.plazbot.com |
Autenticación
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 sección de configuración del workspace.
01curl https://api.plazbot.com/api/contact/list?workspaceId=wok_XXXXXXXXXXXXXXXXXXXXXX \02 -H "Authorization: Bearer eyJhbGciOiJIUzI1NiIs..." \03 -H "x-workspace-id: wok_XXXXXXXXXXXXXXXXXXXXXX"
Formato de respuesta
Todos los endpoints responden con el mismo envelope JSON, tanto en exitos como en errores.
01{02 "success": true,03 "code": 200,04 "errorCode": null,05 "message": "Operación realizada correctamente",06 "data": { }07}
| Campo | Tipo | Descripción |
|---|---|---|
| success | boolean | Indica si la operación fue exitosa. |
| code | number | Código HTTP de la respuesta. |
| errorCode | string | null | Código interno del error; null si no hubo error. |
| message | string | Mensaje descriptivo de la operación. |
| data | object | array | null | Payload de la respuesta. |
Herramientas
- API REST: 111 endpoints organizados en 11 módulos, documentados y ejecutables desde el Playground.
- SDK de TypeScript: el paquete npm plazbot con módulos para agentes, contactos, mensajes, portal y widget, más componentes React.
- CLI: la línea de comandos de Plazbot para crear agentes, portales, workers y flujos de WhatsApp desde la terminal.