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>"
}
'import requests
url = "https://api.plazbot.com/api/agent/on-message-portal"
payload = {
"message": "<string>",
"from": "<string>",
"agentId": "<string>",
"workspaceId": "<string>",
"portalId": "<string>",
"conversationId": "<string>"
}
headers = {
"x-workspace-id": "<x-workspace-id>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'x-workspace-id': '<x-workspace-id>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
message: '<string>',
from: '<string>',
agentId: '<string>',
workspaceId: '<string>',
portalId: '<string>',
conversationId: '<string>'
})
};
fetch('https://api.plazbot.com/api/agent/on-message-portal', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.plazbot.com/api/agent/on-message-portal",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'message' => '<string>',
'from' => '<string>',
'agentId' => '<string>',
'workspaceId' => '<string>',
'portalId' => '<string>',
'conversationId' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"x-workspace-id: <x-workspace-id>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.plazbot.com/api/agent/on-message-portal"
payload := strings.NewReader("{\n \"message\": \"<string>\",\n \"from\": \"<string>\",\n \"agentId\": \"<string>\",\n \"workspaceId\": \"<string>\",\n \"portalId\": \"<string>\",\n \"conversationId\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-workspace-id", "<x-workspace-id>")
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.plazbot.com/api/agent/on-message-portal")
.header("x-workspace-id", "<x-workspace-id>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"message\": \"<string>\",\n \"from\": \"<string>\",\n \"agentId\": \"<string>\",\n \"workspaceId\": \"<string>\",\n \"portalId\": \"<string>\",\n \"conversationId\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.plazbot.com/api/agent/on-message-portal")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-workspace-id"] = '<x-workspace-id>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"message\": \"<string>\",\n \"from\": \"<string>\",\n \"agentId\": \"<string>\",\n \"workspaceId\": \"<string>\",\n \"portalId\": \"<string>\",\n \"conversationId\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"code": 123,
"errorCode": "<string>",
"message": "<string>",
"data": {}
}{
"success": true,
"code": 123,
"message": "<string>",
"errorCode": "<string>"
}{
"success": true,
"code": 123,
"message": "<string>",
"errorCode": "<string>"
}{
"success": true,
"code": 123,
"message": "<string>",
"errorCode": "<string>"
}{
"success": true,
"code": 123,
"message": "<string>",
"errorCode": "<string>"
}Agent
Enviar Mensaje al Agente (Portal)
Envia mensajes al Agente de IA a traves del portal para obtener respuestas.
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>"
}
'import requests
url = "https://api.plazbot.com/api/agent/on-message-portal"
payload = {
"message": "<string>",
"from": "<string>",
"agentId": "<string>",
"workspaceId": "<string>",
"portalId": "<string>",
"conversationId": "<string>"
}
headers = {
"x-workspace-id": "<x-workspace-id>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'x-workspace-id': '<x-workspace-id>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
message: '<string>',
from: '<string>',
agentId: '<string>',
workspaceId: '<string>',
portalId: '<string>',
conversationId: '<string>'
})
};
fetch('https://api.plazbot.com/api/agent/on-message-portal', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.plazbot.com/api/agent/on-message-portal",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'message' => '<string>',
'from' => '<string>',
'agentId' => '<string>',
'workspaceId' => '<string>',
'portalId' => '<string>',
'conversationId' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"x-workspace-id: <x-workspace-id>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.plazbot.com/api/agent/on-message-portal"
payload := strings.NewReader("{\n \"message\": \"<string>\",\n \"from\": \"<string>\",\n \"agentId\": \"<string>\",\n \"workspaceId\": \"<string>\",\n \"portalId\": \"<string>\",\n \"conversationId\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-workspace-id", "<x-workspace-id>")
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.plazbot.com/api/agent/on-message-portal")
.header("x-workspace-id", "<x-workspace-id>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"message\": \"<string>\",\n \"from\": \"<string>\",\n \"agentId\": \"<string>\",\n \"workspaceId\": \"<string>\",\n \"portalId\": \"<string>\",\n \"conversationId\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.plazbot.com/api/agent/on-message-portal")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-workspace-id"] = '<x-workspace-id>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"message\": \"<string>\",\n \"from\": \"<string>\",\n \"agentId\": \"<string>\",\n \"workspaceId\": \"<string>\",\n \"portalId\": \"<string>\",\n \"conversationId\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"code": 123,
"errorCode": "<string>",
"message": "<string>",
"data": {}
}{
"success": true,
"code": 123,
"message": "<string>",
"errorCode": "<string>"
}{
"success": true,
"code": 123,
"message": "<string>",
"errorCode": "<string>"
}{
"success": true,
"code": 123,
"message": "<string>",
"errorCode": "<string>"
}{
"success": true,
"code": 123,
"message": "<string>",
"errorCode": "<string>"
}Streaming SSE
Este endpoint soporta streaming SSE. Enviastream: 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
Token de autenticacion Bearer. Obtenga el token usando el endpoint /api/user/login
Headers
Identificador del workspace
Body
application/json
Response
Respuesta del agente obtenida exitosamente
⌘I

