Generate a business policy description
curl --request POST \
--url https://api.ruleengine.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/business-policies/generate-description \
--header 'Content-Type: application/json' \
--data '
{
"context": "PAYMENT",
"name": "Payments over R$ 5,000",
"description": "<string>",
"order": 10,
"status": "ACTIVE",
"actions": {
"hierarchy": false,
"autoAction": "NONE",
"moveBalance": {},
"approvals": [
{
"type": "GROUP",
"id": "8b0e4c2a-1f6d-4e3b-a9c7-2d5f8e1b6c30",
"name": "<string>"
}
]
},
"conditions": "<unknown>"
}
'import requests
url = "https://api.ruleengine.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/business-policies/generate-description"
payload = {
"context": "PAYMENT",
"name": "Payments over R$ 5,000",
"description": "<string>",
"order": 10,
"status": "ACTIVE",
"actions": {
"hierarchy": False,
"autoAction": "NONE",
"moveBalance": {},
"approvals": [
{
"type": "GROUP",
"id": "8b0e4c2a-1f6d-4e3b-a9c7-2d5f8e1b6c30",
"name": "<string>"
}
]
},
"conditions": "<unknown>"
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
context: 'PAYMENT',
name: 'Payments over R$ 5,000',
description: '<string>',
order: 10,
status: 'ACTIVE',
actions: {
hierarchy: false,
autoAction: 'NONE',
moveBalance: {},
approvals: [{type: 'GROUP', id: '8b0e4c2a-1f6d-4e3b-a9c7-2d5f8e1b6c30', name: '<string>'}]
},
conditions: '<unknown>'
})
};
fetch('https://api.ruleengine.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/business-policies/generate-description', 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.ruleengine.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/business-policies/generate-description",
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([
'context' => 'PAYMENT',
'name' => 'Payments over R$ 5,000',
'description' => '<string>',
'order' => 10,
'status' => 'ACTIVE',
'actions' => [
'hierarchy' => false,
'autoAction' => 'NONE',
'moveBalance' => [
],
'approvals' => [
[
'type' => 'GROUP',
'id' => '8b0e4c2a-1f6d-4e3b-a9c7-2d5f8e1b6c30',
'name' => '<string>'
]
]
],
'conditions' => '<unknown>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$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.ruleengine.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/business-policies/generate-description"
payload := strings.NewReader("{\n \"context\": \"PAYMENT\",\n \"name\": \"Payments over R$ 5,000\",\n \"description\": \"<string>\",\n \"order\": 10,\n \"status\": \"ACTIVE\",\n \"actions\": {\n \"hierarchy\": false,\n \"autoAction\": \"NONE\",\n \"moveBalance\": {},\n \"approvals\": [\n {\n \"type\": \"GROUP\",\n \"id\": \"8b0e4c2a-1f6d-4e3b-a9c7-2d5f8e1b6c30\",\n \"name\": \"<string>\"\n }\n ]\n },\n \"conditions\": \"<unknown>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
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.ruleengine.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/business-policies/generate-description")
.header("Content-Type", "application/json")
.body("{\n \"context\": \"PAYMENT\",\n \"name\": \"Payments over R$ 5,000\",\n \"description\": \"<string>\",\n \"order\": 10,\n \"status\": \"ACTIVE\",\n \"actions\": {\n \"hierarchy\": false,\n \"autoAction\": \"NONE\",\n \"moveBalance\": {},\n \"approvals\": [\n {\n \"type\": \"GROUP\",\n \"id\": \"8b0e4c2a-1f6d-4e3b-a9c7-2d5f8e1b6c30\",\n \"name\": \"<string>\"\n }\n ]\n },\n \"conditions\": \"<unknown>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.ruleengine.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/business-policies/generate-description")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"context\": \"PAYMENT\",\n \"name\": \"Payments over R$ 5,000\",\n \"description\": \"<string>\",\n \"order\": 10,\n \"status\": \"ACTIVE\",\n \"actions\": {\n \"hierarchy\": false,\n \"autoAction\": \"NONE\",\n \"moveBalance\": {},\n \"approvals\": [\n {\n \"type\": \"GROUP\",\n \"id\": \"8b0e4c2a-1f6d-4e3b-a9c7-2d5f8e1b6c30\",\n \"name\": \"<string>\"\n }\n ]\n },\n \"conditions\": \"<unknown>\"\n}"
response = http.request(request)
puts response.read_body{
"description": "Pagamentos acima de R$ 5.000,00 precisam da aprovação do grupo Financeiro, com saldo da conta principal."
}{
"traceId": "1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b",
"code": "BUSINESS_POLICY_FORBIDDEN",
"origin": "RULE_ENGINE",
"message": "You do not have permission to manage business policies"
}{
"traceId": "1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b",
"code": "BAD_REQUEST",
"origin": "RULE_ENGINE",
"message": "Bad Request: Your request is invalid or incomplete. Please make sure you are requesting with the right fields.",
"fields": [
{
"field": "order",
"message": "Invalid input: expected number, received string",
"code": "ORDER_TYPE_ERROR"
}
]
}{
"traceId": "1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b",
"code": "DESCRIPTION_GENERATION_FAILED",
"origin": "RULE_ENGINE",
"message": "Description generation failed"
}Generate a business policy description
Writes a short description of a business policy, with AI. Nothing is saved.
POST
/
realms
/
{realmId}
/
organizations
/
{organizationId}
/
business-policies
/
generate-description
Generate a business policy description
curl --request POST \
--url https://api.ruleengine.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/business-policies/generate-description \
--header 'Content-Type: application/json' \
--data '
{
"context": "PAYMENT",
"name": "Payments over R$ 5,000",
"description": "<string>",
"order": 10,
"status": "ACTIVE",
"actions": {
"hierarchy": false,
"autoAction": "NONE",
"moveBalance": {},
"approvals": [
{
"type": "GROUP",
"id": "8b0e4c2a-1f6d-4e3b-a9c7-2d5f8e1b6c30",
"name": "<string>"
}
]
},
"conditions": "<unknown>"
}
'import requests
url = "https://api.ruleengine.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/business-policies/generate-description"
payload = {
"context": "PAYMENT",
"name": "Payments over R$ 5,000",
"description": "<string>",
"order": 10,
"status": "ACTIVE",
"actions": {
"hierarchy": False,
"autoAction": "NONE",
"moveBalance": {},
"approvals": [
{
"type": "GROUP",
"id": "8b0e4c2a-1f6d-4e3b-a9c7-2d5f8e1b6c30",
"name": "<string>"
}
]
},
"conditions": "<unknown>"
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
context: 'PAYMENT',
name: 'Payments over R$ 5,000',
description: '<string>',
order: 10,
status: 'ACTIVE',
actions: {
hierarchy: false,
autoAction: 'NONE',
moveBalance: {},
approvals: [{type: 'GROUP', id: '8b0e4c2a-1f6d-4e3b-a9c7-2d5f8e1b6c30', name: '<string>'}]
},
conditions: '<unknown>'
})
};
fetch('https://api.ruleengine.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/business-policies/generate-description', 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.ruleengine.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/business-policies/generate-description",
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([
'context' => 'PAYMENT',
'name' => 'Payments over R$ 5,000',
'description' => '<string>',
'order' => 10,
'status' => 'ACTIVE',
'actions' => [
'hierarchy' => false,
'autoAction' => 'NONE',
'moveBalance' => [
],
'approvals' => [
[
'type' => 'GROUP',
'id' => '8b0e4c2a-1f6d-4e3b-a9c7-2d5f8e1b6c30',
'name' => '<string>'
]
]
],
'conditions' => '<unknown>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$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.ruleengine.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/business-policies/generate-description"
payload := strings.NewReader("{\n \"context\": \"PAYMENT\",\n \"name\": \"Payments over R$ 5,000\",\n \"description\": \"<string>\",\n \"order\": 10,\n \"status\": \"ACTIVE\",\n \"actions\": {\n \"hierarchy\": false,\n \"autoAction\": \"NONE\",\n \"moveBalance\": {},\n \"approvals\": [\n {\n \"type\": \"GROUP\",\n \"id\": \"8b0e4c2a-1f6d-4e3b-a9c7-2d5f8e1b6c30\",\n \"name\": \"<string>\"\n }\n ]\n },\n \"conditions\": \"<unknown>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
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.ruleengine.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/business-policies/generate-description")
.header("Content-Type", "application/json")
.body("{\n \"context\": \"PAYMENT\",\n \"name\": \"Payments over R$ 5,000\",\n \"description\": \"<string>\",\n \"order\": 10,\n \"status\": \"ACTIVE\",\n \"actions\": {\n \"hierarchy\": false,\n \"autoAction\": \"NONE\",\n \"moveBalance\": {},\n \"approvals\": [\n {\n \"type\": \"GROUP\",\n \"id\": \"8b0e4c2a-1f6d-4e3b-a9c7-2d5f8e1b6c30\",\n \"name\": \"<string>\"\n }\n ]\n },\n \"conditions\": \"<unknown>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.ruleengine.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/business-policies/generate-description")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"context\": \"PAYMENT\",\n \"name\": \"Payments over R$ 5,000\",\n \"description\": \"<string>\",\n \"order\": 10,\n \"status\": \"ACTIVE\",\n \"actions\": {\n \"hierarchy\": false,\n \"autoAction\": \"NONE\",\n \"moveBalance\": {},\n \"approvals\": [\n {\n \"type\": \"GROUP\",\n \"id\": \"8b0e4c2a-1f6d-4e3b-a9c7-2d5f8e1b6c30\",\n \"name\": \"<string>\"\n }\n ]\n },\n \"conditions\": \"<unknown>\"\n}"
response = http.request(request)
puts response.read_body{
"description": "Pagamentos acima de R$ 5.000,00 precisam da aprovação do grupo Financeiro, com saldo da conta principal."
}{
"traceId": "1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b",
"code": "BUSINESS_POLICY_FORBIDDEN",
"origin": "RULE_ENGINE",
"message": "You do not have permission to manage business policies"
}{
"traceId": "1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b",
"code": "BAD_REQUEST",
"origin": "RULE_ENGINE",
"message": "Bad Request: Your request is invalid or incomplete. Please make sure you are requesting with the right fields.",
"fields": [
{
"field": "order",
"message": "Invalid input: expected number, received string",
"code": "ORDER_TYPE_ERROR"
}
]
}{
"traceId": "1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b",
"code": "DESCRIPTION_GENERATION_FAILED",
"origin": "RULE_ENGINE",
"message": "Description generation failed"
}Send the policy as it stands — finished or still being written — with its fields at the top level of the body, as you would send them to the create endpoint. Every field is optional, but at least one of
name, actions and conditions must be present; unknown fields are ignored. The answer is a short text in Portuguese, at most 160 characters, ready to use as the policy’s description.
Approvers are described by their current names, and each condition by its catalog label. The AI model never receives the value of a condition on the payment’s counterparty (its document, name, Pix key or account), on a Pix copy-and-paste code, on user or wallet IDs, on a field outside the catalog or on a field with a maskType — the description only says such a condition exists. Other values are sent cleaned of invisible characters and shortened — text to 500 characters, and a very large policy is described from a shortened copy of its conditions.
It takes a few seconds. Only organization admins can generate descriptions.Path Parameters
ID of your realm.
Format: UUID
ID of the organization the policy belongs to.
Format: UUID
Body
application/json
The policy's context, which decides how its condition fields are named in the description. Defaults to PAYMENT.
Example:
"PAYMENT"
The policy's name.
Example:
"Payments over R$ 5,000"
The current description, if any. It is not reused.
The policy's evaluation order.
Example:
10
The policy's status.
Example:
"ACTIVE"
The policy's actions, as on create.
Show child attributes
Show child attributes
The policy's conditions, as on create. Incomplete conditions are fine: each item is described as far as it goes.
Response
Successful response
A generated description of the policy.
A short description of the policy in Portuguese, at most 160 characters.
Example:
"Pagamentos acima de R$ 5.000,00 precisam da aprovação do grupo Financeiro, com saldo da conta principal."