curl --request POST \
--url https://{subdomain}.mihu.ai/api/v1/agents/{uuid}/guard-rules \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "Compliance: PII over voice",
"when_condition": "Customer asks the agent to read back full credit card or social security numbers over the call.",
"example_phrases": [
"can you read my full card number",
"tell me my SSN"
],
"then_action": "forward",
"selected_channels": [
"phone"
],
"say_before_forwarding": "For security, I will transfer you to a verified human agent.",
"destination_type": "extension",
"destination": "210",
"is_active": true
}
'import requests
url = "https://{subdomain}.mihu.ai/api/v1/agents/{uuid}/guard-rules"
payload = {
"name": "Compliance: PII over voice",
"when_condition": "Customer asks the agent to read back full credit card or social security numbers over the call.",
"example_phrases": ["can you read my full card number", "tell me my SSN"],
"then_action": "forward",
"selected_channels": ["phone"],
"say_before_forwarding": "For security, I will transfer you to a verified human agent.",
"destination_type": "extension",
"destination": "210",
"is_active": True
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: 'Compliance: PII over voice',
when_condition: 'Customer asks the agent to read back full credit card or social security numbers over the call.',
example_phrases: ['can you read my full card number', 'tell me my SSN'],
then_action: 'forward',
selected_channels: ['phone'],
say_before_forwarding: 'For security, I will transfer you to a verified human agent.',
destination_type: 'extension',
destination: '210',
is_active: true
})
};
fetch('https://{subdomain}.mihu.ai/api/v1/agents/{uuid}/guard-rules', 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://{subdomain}.mihu.ai/api/v1/agents/{uuid}/guard-rules",
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([
'name' => 'Compliance: PII over voice',
'when_condition' => 'Customer asks the agent to read back full credit card or social security numbers over the call.',
'example_phrases' => [
'can you read my full card number',
'tell me my SSN'
],
'then_action' => 'forward',
'selected_channels' => [
'phone'
],
'say_before_forwarding' => 'For security, I will transfer you to a verified human agent.',
'destination_type' => 'extension',
'destination' => '210',
'is_active' => true
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"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://{subdomain}.mihu.ai/api/v1/agents/{uuid}/guard-rules"
payload := strings.NewReader("{\n \"name\": \"Compliance: PII over voice\",\n \"when_condition\": \"Customer asks the agent to read back full credit card or social security numbers over the call.\",\n \"example_phrases\": [\n \"can you read my full card number\",\n \"tell me my SSN\"\n ],\n \"then_action\": \"forward\",\n \"selected_channels\": [\n \"phone\"\n ],\n \"say_before_forwarding\": \"For security, I will transfer you to a verified human agent.\",\n \"destination_type\": \"extension\",\n \"destination\": \"210\",\n \"is_active\": true\n}")
req, _ := http.NewRequest("POST", url, payload)
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://{subdomain}.mihu.ai/api/v1/agents/{uuid}/guard-rules")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"Compliance: PII over voice\",\n \"when_condition\": \"Customer asks the agent to read back full credit card or social security numbers over the call.\",\n \"example_phrases\": [\n \"can you read my full card number\",\n \"tell me my SSN\"\n ],\n \"then_action\": \"forward\",\n \"selected_channels\": [\n \"phone\"\n ],\n \"say_before_forwarding\": \"For security, I will transfer you to a verified human agent.\",\n \"destination_type\": \"extension\",\n \"destination\": \"210\",\n \"is_active\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{subdomain}.mihu.ai/api/v1/agents/{uuid}/guard-rules")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"Compliance: PII over voice\",\n \"when_condition\": \"Customer asks the agent to read back full credit card or social security numbers over the call.\",\n \"example_phrases\": [\n \"can you read my full card number\",\n \"tell me my SSN\"\n ],\n \"then_action\": \"forward\",\n \"selected_channels\": [\n \"phone\"\n ],\n \"say_before_forwarding\": \"For security, I will transfer you to a verified human agent.\",\n \"destination_type\": \"extension\",\n \"destination\": \"210\",\n \"is_active\": true\n}"
response = http.request(request)
puts response.read_body{
"data": {
"agent_uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"description": "<string>",
"company_name": "<string>",
"role": "<string>",
"objective": "<string>",
"tone": "<string>",
"behavior_guidelines": "<string>",
"company_service": "<string>",
"topic": "<string>",
"length_detail": "<string>",
"interest_of_product": "<string>",
"negative_response": "<string>",
"custom_prompt": "<string>",
"language": "<string>",
"speed": "<string>",
"timezone": "<string>",
"appointment_scheduling_enabled": true,
"appointment_scheduling_randomly": true,
"custom_llm_url": "<string>",
"recommendations": "<string>",
"settings": {
"voice": {},
"text": {},
"memorize": {},
"evaluation": {}
},
"guidelines": [
{
"uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"content": "Always confirm vehicle VIN or license plate before creating a service appointment.",
"order": 0
}
],
"notes": [
{
"uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"content": "Service appointments take 60-90 minutes for standard maintenance, 2-4 hours for warranty work. Same-day pickup is available before 4 PM.",
"order": 0
}
],
"procedures": [
{
"uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "Book service appointment",
"description": "Used when the customer wants to schedule a service appointment for their vehicle.",
"steps": [
{
"order": 1,
"description": "Ask the customer for their vehicle license plate or VIN.",
"intent_uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
]
}
],
"training": [
{
"uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"content": "What does Volvo's standard warranty cover?",
"intent": "warranty_inquiry",
"response": "Volvo's standard warranty covers 4 years or 100,000 km, whichever comes first, including parts and labor at any authorized service center. Would you like the details for your specific model?"
}
],
"intents": [
{
"intent_uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"key": "<string>",
"name": "<string>",
"description": "<string>",
"recommendation_actions": "<string>",
"confidence_threshold": 123,
"is_system": true,
"intent_llm_handle_by_response": true,
"webhook": {
"url": "<string>",
"auth_token": "<string>"
},
"parameters": [
{
"key": "email",
"default": "<string>",
"type": "string",
"required": true
}
],
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
],
"webhooks": [
{
"webhook_uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"url": "<string>",
"events": [],
"is_active": true,
"has_secret": true,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
],
"appointments": {},
"routing_rules": [
{
"uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"detection_mode": "intent",
"trigger_keyword": "sales",
"department_name": "Sales Department",
"phrases": [
"I want to talk to sales"
],
"ai_prompt": "Detect when the customer wants to speak with the sales team — they may ask about pricing, new products, quotes, or directly mention sales.",
"voice_response": "Sure, I'll transfer you to our sales team now. One moment please.",
"voice_on_error": "I'm sorry, I couldn't reach sales right now. Please call back later or leave a message.",
"voice_on_success": "You've been successfully connected. Have a great day.",
"destination_type": "extension",
"destination": "101",
"destination_agent_uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"transfer_type": "transfer_call",
"transfer_config": {},
"priority": 1,
"is_active": true
}
],
"guard_rules": [
{
"uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "Legal complaint escalation",
"when_condition": "Customer mentions a legal complaint, lawyer, lawsuit, or threatens to take legal action.",
"example_phrases": [
"I'm calling my lawyer about this"
],
"then_action": "forward",
"selected_channels": [],
"say_before_forwarding": "I understand this is important — let me connect you with someone who can help.",
"say_before_end": "I'm sorry I couldn't help further. Please contact our team directly. Goodbye.",
"destination": "<string>",
"destination_agent_uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"is_active": true,
"is_default": false
}
],
"phone_numbers": [
{
"phone_number_uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"number": "<string>",
"country_code": "<string>",
"type": "<string>",
"capabilities": {
"call": true,
"sms": true,
"whatsapp": true,
"whatsapp_call": true
}
}
],
"channels": [
{}
],
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
}Add ONE guard rule (preserves existing rules)
Appends a guard rule. Existing guards are untouched. when_condition and then_action are required. If then_action=forward, also provide destination_type + destination (or destination_agent_uuid when destination_type=agent). If then_action=end_conversation, provide say_before_end for a polite closer.
curl --request POST \
--url https://{subdomain}.mihu.ai/api/v1/agents/{uuid}/guard-rules \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "Compliance: PII over voice",
"when_condition": "Customer asks the agent to read back full credit card or social security numbers over the call.",
"example_phrases": [
"can you read my full card number",
"tell me my SSN"
],
"then_action": "forward",
"selected_channels": [
"phone"
],
"say_before_forwarding": "For security, I will transfer you to a verified human agent.",
"destination_type": "extension",
"destination": "210",
"is_active": true
}
'import requests
url = "https://{subdomain}.mihu.ai/api/v1/agents/{uuid}/guard-rules"
payload = {
"name": "Compliance: PII over voice",
"when_condition": "Customer asks the agent to read back full credit card or social security numbers over the call.",
"example_phrases": ["can you read my full card number", "tell me my SSN"],
"then_action": "forward",
"selected_channels": ["phone"],
"say_before_forwarding": "For security, I will transfer you to a verified human agent.",
"destination_type": "extension",
"destination": "210",
"is_active": True
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: 'Compliance: PII over voice',
when_condition: 'Customer asks the agent to read back full credit card or social security numbers over the call.',
example_phrases: ['can you read my full card number', 'tell me my SSN'],
then_action: 'forward',
selected_channels: ['phone'],
say_before_forwarding: 'For security, I will transfer you to a verified human agent.',
destination_type: 'extension',
destination: '210',
is_active: true
})
};
fetch('https://{subdomain}.mihu.ai/api/v1/agents/{uuid}/guard-rules', 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://{subdomain}.mihu.ai/api/v1/agents/{uuid}/guard-rules",
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([
'name' => 'Compliance: PII over voice',
'when_condition' => 'Customer asks the agent to read back full credit card or social security numbers over the call.',
'example_phrases' => [
'can you read my full card number',
'tell me my SSN'
],
'then_action' => 'forward',
'selected_channels' => [
'phone'
],
'say_before_forwarding' => 'For security, I will transfer you to a verified human agent.',
'destination_type' => 'extension',
'destination' => '210',
'is_active' => true
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"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://{subdomain}.mihu.ai/api/v1/agents/{uuid}/guard-rules"
payload := strings.NewReader("{\n \"name\": \"Compliance: PII over voice\",\n \"when_condition\": \"Customer asks the agent to read back full credit card or social security numbers over the call.\",\n \"example_phrases\": [\n \"can you read my full card number\",\n \"tell me my SSN\"\n ],\n \"then_action\": \"forward\",\n \"selected_channels\": [\n \"phone\"\n ],\n \"say_before_forwarding\": \"For security, I will transfer you to a verified human agent.\",\n \"destination_type\": \"extension\",\n \"destination\": \"210\",\n \"is_active\": true\n}")
req, _ := http.NewRequest("POST", url, payload)
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://{subdomain}.mihu.ai/api/v1/agents/{uuid}/guard-rules")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"Compliance: PII over voice\",\n \"when_condition\": \"Customer asks the agent to read back full credit card or social security numbers over the call.\",\n \"example_phrases\": [\n \"can you read my full card number\",\n \"tell me my SSN\"\n ],\n \"then_action\": \"forward\",\n \"selected_channels\": [\n \"phone\"\n ],\n \"say_before_forwarding\": \"For security, I will transfer you to a verified human agent.\",\n \"destination_type\": \"extension\",\n \"destination\": \"210\",\n \"is_active\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{subdomain}.mihu.ai/api/v1/agents/{uuid}/guard-rules")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"Compliance: PII over voice\",\n \"when_condition\": \"Customer asks the agent to read back full credit card or social security numbers over the call.\",\n \"example_phrases\": [\n \"can you read my full card number\",\n \"tell me my SSN\"\n ],\n \"then_action\": \"forward\",\n \"selected_channels\": [\n \"phone\"\n ],\n \"say_before_forwarding\": \"For security, I will transfer you to a verified human agent.\",\n \"destination_type\": \"extension\",\n \"destination\": \"210\",\n \"is_active\": true\n}"
response = http.request(request)
puts response.read_body{
"data": {
"agent_uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"description": "<string>",
"company_name": "<string>",
"role": "<string>",
"objective": "<string>",
"tone": "<string>",
"behavior_guidelines": "<string>",
"company_service": "<string>",
"topic": "<string>",
"length_detail": "<string>",
"interest_of_product": "<string>",
"negative_response": "<string>",
"custom_prompt": "<string>",
"language": "<string>",
"speed": "<string>",
"timezone": "<string>",
"appointment_scheduling_enabled": true,
"appointment_scheduling_randomly": true,
"custom_llm_url": "<string>",
"recommendations": "<string>",
"settings": {
"voice": {},
"text": {},
"memorize": {},
"evaluation": {}
},
"guidelines": [
{
"uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"content": "Always confirm vehicle VIN or license plate before creating a service appointment.",
"order": 0
}
],
"notes": [
{
"uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"content": "Service appointments take 60-90 minutes for standard maintenance, 2-4 hours for warranty work. Same-day pickup is available before 4 PM.",
"order": 0
}
],
"procedures": [
{
"uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "Book service appointment",
"description": "Used when the customer wants to schedule a service appointment for their vehicle.",
"steps": [
{
"order": 1,
"description": "Ask the customer for their vehicle license plate or VIN.",
"intent_uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
]
}
],
"training": [
{
"uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"content": "What does Volvo's standard warranty cover?",
"intent": "warranty_inquiry",
"response": "Volvo's standard warranty covers 4 years or 100,000 km, whichever comes first, including parts and labor at any authorized service center. Would you like the details for your specific model?"
}
],
"intents": [
{
"intent_uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"key": "<string>",
"name": "<string>",
"description": "<string>",
"recommendation_actions": "<string>",
"confidence_threshold": 123,
"is_system": true,
"intent_llm_handle_by_response": true,
"webhook": {
"url": "<string>",
"auth_token": "<string>"
},
"parameters": [
{
"key": "email",
"default": "<string>",
"type": "string",
"required": true
}
],
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
],
"webhooks": [
{
"webhook_uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"url": "<string>",
"events": [],
"is_active": true,
"has_secret": true,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
],
"appointments": {},
"routing_rules": [
{
"uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"detection_mode": "intent",
"trigger_keyword": "sales",
"department_name": "Sales Department",
"phrases": [
"I want to talk to sales"
],
"ai_prompt": "Detect when the customer wants to speak with the sales team — they may ask about pricing, new products, quotes, or directly mention sales.",
"voice_response": "Sure, I'll transfer you to our sales team now. One moment please.",
"voice_on_error": "I'm sorry, I couldn't reach sales right now. Please call back later or leave a message.",
"voice_on_success": "You've been successfully connected. Have a great day.",
"destination_type": "extension",
"destination": "101",
"destination_agent_uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"transfer_type": "transfer_call",
"transfer_config": {},
"priority": 1,
"is_active": true
}
],
"guard_rules": [
{
"uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "Legal complaint escalation",
"when_condition": "Customer mentions a legal complaint, lawyer, lawsuit, or threatens to take legal action.",
"example_phrases": [
"I'm calling my lawyer about this"
],
"then_action": "forward",
"selected_channels": [],
"say_before_forwarding": "I understand this is important — let me connect you with someone who can help.",
"say_before_end": "I'm sorry I couldn't help further. Please contact our team directly. Goodbye.",
"destination": "<string>",
"destination_agent_uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"is_active": true,
"is_default": false
}
],
"phone_numbers": [
{
"phone_number_uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"number": "<string>",
"country_code": "<string>",
"type": "<string>",
"capabilities": {
"call": true,
"sms": true,
"whatsapp": true,
"whatsapp_call": true
}
}
],
"channels": [
{}
],
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
}Authorizations
Use a Bearer token to access these API endpoints. Example: "Bearer {your-token}"
Path Parameters
Body
Guard rules let the agent forward or end a conversation when a defined situation arises (compliance, safety, escalation). The runtime AI relies on when_condition and example_phrases to decide whether a customer utterance triggers the guard — rules without those fields filled cannot fire reliably.
Optional short name for the guard rule.
"Legal complaint escalation"
Required. Natural-language description of the situation that should trigger this guard. The runtime AI uses this as instructions when classifying customer utterances. Be specific — 'customer is angry' is too vague; 'customer uses profanity or threatens to escalate' is actionable.
"Customer mentions a legal complaint, lawyer, lawsuit, or threatens to take legal action."
Customer utterances that should trigger this guard. Provide 3-5 varied phrasings — the runtime AI uses these as positive examples when classifying.
What the runtime agent does when the guard fires. forward transfers to a human or another agent; end_conversation politely ends the call/chat.
forward, end_conversation "forward"
Channels where this guard is active. Defaults to phone-only.
phone, instagram, whatsapp, facebook_messenger Message spoken before the transfer when then_action=forward.
"I understand this is important — let me connect you with someone who can help."
Message spoken before ending when then_action=end_conversation.
"I'm sorry I couldn't help further. Please contact our team directly. Goodbye."
Where the call is sent when then_action=forward (same semantics as routing rules).
extension, phone, agent Destination value (extension, SIP URI, or E.164 phone) when then_action=forward.
Target agent UUID when destination_type=agent.
true
Marks this guard as a default that auto-applies to new agents in the workspace.
false
Response
Guard rule added
Show child attributes
Show child attributes