Edit a rule
curl --request POST \
--url http://localhost:8787/api/maps/{workflow_id}/guardrails/{gid} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"text": "<string>",
"owner": "<string>",
"fix": "<string>"
}
'import requests
url = "http://localhost:8787/api/maps/{workflow_id}/guardrails/{gid}"
payload = {
"text": "<string>",
"owner": "<string>",
"fix": "<string>"
}
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({text: '<string>', owner: '<string>', fix: '<string>'})
};
fetch('http://localhost:8787/api/maps/{workflow_id}/guardrails/{gid}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "8787",
CURLOPT_URL => "http://localhost:8787/api/maps/{workflow_id}/guardrails/{gid}",
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([
'text' => '<string>',
'owner' => '<string>',
'fix' => '<string>'
]),
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 := "http://localhost:8787/api/maps/{workflow_id}/guardrails/{gid}"
payload := strings.NewReader("{\n \"text\": \"<string>\",\n \"owner\": \"<string>\",\n \"fix\": \"<string>\"\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("http://localhost:8787/api/maps/{workflow_id}/guardrails/{gid}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"text\": \"<string>\",\n \"owner\": \"<string>\",\n \"fix\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:8787/api/maps/{workflow_id}/guardrails/{gid}")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"text\": \"<string>\",\n \"owner\": \"<string>\",\n \"fix\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Rules
Edit a rule
The expert rewords a rule, changes what happens when it is broken (stop / ask / nudge / hold: from then on an explicit response, so a taste rule set to stop stops), who to ask, taste or compliance, prevents or detects, or the suggested fix. The source sentence and the predicate stay (a reworded precise rule keeps its check; remove it and capture again to change that).
POST
/
api
/
maps
/
{workflow_id}
/
guardrails
/
{gid}
Edit a rule
curl --request POST \
--url http://localhost:8787/api/maps/{workflow_id}/guardrails/{gid} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"text": "<string>",
"owner": "<string>",
"fix": "<string>"
}
'import requests
url = "http://localhost:8787/api/maps/{workflow_id}/guardrails/{gid}"
payload = {
"text": "<string>",
"owner": "<string>",
"fix": "<string>"
}
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({text: '<string>', owner: '<string>', fix: '<string>'})
};
fetch('http://localhost:8787/api/maps/{workflow_id}/guardrails/{gid}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "8787",
CURLOPT_URL => "http://localhost:8787/api/maps/{workflow_id}/guardrails/{gid}",
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([
'text' => '<string>',
'owner' => '<string>',
'fix' => '<string>'
]),
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 := "http://localhost:8787/api/maps/{workflow_id}/guardrails/{gid}"
payload := strings.NewReader("{\n \"text\": \"<string>\",\n \"owner\": \"<string>\",\n \"fix\": \"<string>\"\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("http://localhost:8787/api/maps/{workflow_id}/guardrails/{gid}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"text\": \"<string>\",\n \"owner\": \"<string>\",\n \"fix\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:8787/api/maps/{workflow_id}/guardrails/{gid}")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"text\": \"<string>\",\n \"owner\": \"<string>\",\n \"fix\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Authorizations
API key clr_... or browser session token clt_...
Body
application/json
Response
Successful Response
The response is of type Response Rule Ep Api Maps Workflow Id Guardrails Gid Post · object.