Skip to main content
POST
/
api
/
agent
/
on-message-portal
Enviar Mensaje al Portal
curl --request POST \
  --url https://api.plazbot.com/api/agent/on-message-portal \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-workspace-id: <x-workspace-id>' \
  --data '
{
  "message": "<string>",
  "from": "<string>",
  "agentId": "<string>",
  "workspaceId": "<string>",
  "portalId": "<string>",
  "conversationId": "<string>"
}
'
{
  "success": true,
  "code": 123,
  "errorCode": "<string>",
  "message": "<string>",
  "data": {}
}

Documentation Index

Fetch the complete documentation index at: https://docs.plazbot.com/llms.txt

Use this file to discover all available pages before exploring further.

​
Streaming SSE

Este endpoint soporta streaming SSE. Envia stream: true en el body para recibir la respuesta como text/event-stream con chunks progresivos. Requisito: El agente debe tener useToolCalling: true activado. Tipos de chunks: text, tool_call, tool_result, done, error. Consulta la documentacion completa de streaming para mas detalles y ejemplos de consumo.

Authorizations

​
Authorization
string
header
required

Token de autenticacion Bearer. Obtenga el token usando el endpoint /api/user/login

Headers

​
x-workspace-id
string
required

Identificador del workspace

Body

application/json
​
message
string
required

Mensaje a enviar al agente

​
from
string
required

Identificador del remitente

​
agentId
string
required

ID del Agente de IA

​
workspaceId
string
required

Identificador del workspace

​
portalId
string
required

ID del portal

​
conversationId
string | null

ID de la conversacion

Response

Respuesta del agente obtenida exitosamente

​
success
boolean
required

Indica si la operacion fue exitosa

​
code
integer
required

Codigo HTTP de la respuesta

​
errorCode
string | null
required

Codigo de error, null si no hay error

​
message
string
required

Mensaje descriptivo del resultado

​
data
object
required

Datos de la respuesta