Create a policy

POST

policies

Create a policy

curl --request POST \
  --url https://api-sandbox.featherhq.com/v1/policies \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "enabled": true,
  "scope": "attachable",
  "metadata": {},
  "check_config": {},
  "action_config": {},
  "tool_target": "<string>",
  "mode": "monitor",
  "timeout_ms": 2,
  "strictness": "relaxed",
  "priority": 0
}
'

import requests

url = "https://api-sandbox.featherhq.com/v1/policies"

payload = {
    "name": "<string>",
    "description": "<string>",
    "enabled": True,
    "scope": "attachable",
    "metadata": {},
    "check_config": {},
    "action_config": {},
    "tool_target": "<string>",
    "mode": "monitor",
    "timeout_ms": 2,
    "strictness": "relaxed",
    "priority": 0
}
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    description: '<string>',
    enabled: true,
    scope: 'attachable',
    metadata: {},
    check_config: {},
    action_config: {},
    tool_target: '<string>',
    mode: 'monitor',
    timeout_ms: 2,
    strictness: 'relaxed',
    priority: 0
  })
};

fetch('https://api-sandbox.featherhq.com/v1/policies', 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-sandbox.featherhq.com/v1/policies",
  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' => '<string>',
    'description' => '<string>',
    'enabled' => true,
    'scope' => 'attachable',
    'metadata' => [
        
    ],
    'check_config' => [
        
    ],
    'action_config' => [
        
    ],
    'tool_target' => '<string>',
    'mode' => 'monitor',
    'timeout_ms' => 2,
    'strictness' => 'relaxed',
    'priority' => 0
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-api-key: <api-key>"
  ],
]);

$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-sandbox.featherhq.com/v1/policies"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"enabled\": true,\n  \"scope\": \"attachable\",\n  \"metadata\": {},\n  \"check_config\": {},\n  \"action_config\": {},\n  \"tool_target\": \"<string>\",\n  \"mode\": \"monitor\",\n  \"timeout_ms\": 2,\n  \"strictness\": \"relaxed\",\n  \"priority\": 0\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-api-key", "<api-key>")
	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-sandbox.featherhq.com/v1/policies")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"enabled\": true,\n  \"scope\": \"attachable\",\n  \"metadata\": {},\n  \"check_config\": {},\n  \"action_config\": {},\n  \"tool_target\": \"<string>\",\n  \"mode\": \"monitor\",\n  \"timeout_ms\": 2,\n  \"strictness\": \"relaxed\",\n  \"priority\": 0\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api-sandbox.featherhq.com/v1/policies")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"enabled\": true,\n  \"scope\": \"attachable\",\n  \"metadata\": {},\n  \"check_config\": {},\n  \"action_config\": {},\n  \"tool_target\": \"<string>\",\n  \"mode\": \"monitor\",\n  \"timeout_ms\": 2,\n  \"strictness\": \"relaxed\",\n  \"priority\": 0\n}"

response = http.request(request)
puts response.read_body

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "organization_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "enabled": true,
  "scope": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "description": "<string>",
  "active_revision_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "active_revision": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "policy_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "check_type": "<string>",
    "enforcement_point": "<string>",
    "action": "<string>",
    "mode": "<string>",
    "on_error": "<string>",
    "strictness": "<string>",
    "priority": 123,
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "description": "<string>",
    "check_config": {},
    "action_config": {},
    "tool_target": "<string>",
    "timeout_ms": 123,
    "created_by": "<string>"
  },
  "metadata": {}
}

{
  "error": "<string>",
  "message": "<string>",
  "retryable": true,
  "retry_after": 123
}

{
  "error": "<string>",
  "message": "<string>",
  "retryable": true,
  "retry_after": 123
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

Authorizations

x-api-key

string

header

required

Body

application/json

Create a policy + its initial main revision in one call.

Identity fields (name/description/metadata) plus the full revision config. The initial revision is created and set active.

name

string

required

Required string length: 1 - 255

check_type

enum<string>

required

How a policy decides whether content/state violates it.

expression: a PolicyExprEvaluator boolean over turn state.
llm_judge: a secondary LLM (via model_router) judges against guardrail_text.

Available options:

expression,

llm_judge

enforcement_point

enum<string>

required

Where in a turn a policy's check fires (v2: one point per policy).

agent_response is the single author-facing reply point — the v1 response (per-streamed-unit) + post_response (complete reply) split is an internal runtime detail now, selected by the platform-derived enforcement strategy (buffer-and-gate vs per-unit), not an authored distinction.

Available options:

input,

pre_tool,

post_tool,

agent_response

action

enum<string>

required

What happens when a check fails.

block: emit a canned safe message, raise PolicyViolationError, short-circuit.
redact: deterministic regex/truncate (NO LLM rewrite).
append: append a disclaimer.
require_approval: route through the HITL approval seam (pre_tool only).
handoff: hand off via HandoffService (source="policy").

The v1 monitor action is gone — observe-only is the monitor mode now.

Available options:

block,

redact,

append,

require_approval,

handoff

description

string | null

enabled

boolean

default:true

scope

enum<string>

default:attachable

Who the policy applies to.

organization policies auto-apply to every assistant in the org (NOT listed in an assistant's policy_refs). attachable policies apply only where an assistant revision opts in via policy_refs.

Available options:

organization,

attachable

metadata

Metadata · object | null

check_config

Check Config · object

action_config

Action Config · object | null

tool_target

string | null

mode

enum<string>

default:monitor

The author's INTENT dial — act vs observe. Channel-independent.

enforce: the policy acts on a violation (block / redact / append / require_approval / handoff) per the platform-derived strategy.
monitor: shadow/canary — the check runs and records would_be_action but never affects the turn. The safe-rollout default.

The TRANSPORT property v2 conflated into enforcement_mode (buffer-and-gate vs best-effort) is now platform-derived from transport_class at runtime (:func:src.policy.resolution.resolve_strategy), never authored. New-policy default selection is monitor (shadow-first; set at the schema layer).

Available options:

enforce,

monitor

on_error

enum<string> | null

What to do when a check errors/times out.

Action-derived default (v2): block action → fail_closed; else fail_open.

Available options:

fail_open,

fail_closed

timeout_ms

integer | null

Required range: x >= 1

strictness

enum<string>

default:relaxed

The streaming latency/guarantee dial (renamed from the v2 severity).

strict: always enforce before the user sees anything. On a STREAMING transport this holds/buffers (or incrementally gates), accepting brief added latency; on a BLOCKING transport gating is free.
relaxed: enforce without slowing the conversation — best-effort on streaming transports (content may stream while the check runs), but still a FULL gate on blocking transports (gating is free there). relaxed never means "off".

Configurable only at input·llm_judge and agent_response·expression; forced (and hidden in the UI) elsewhere. New-policy default is relaxed.

Available options:

strict,

relaxed

priority

integer

default:0

Response

Successful Response

string<uuid>

required

organization_id

string<uuid>

required

name

string

required

enabled

boolean

required

scope

string

required

created_at

string<date-time>

required

updated_at

string<date-time>

required

description

string | null

active_revision_id

string<uuid> | null

active_revision

PolicyRevisionResponse · object | null

Show child attributes

metadata

Metadata · object

Create a policy

curl --request POST \
  --url https://api-sandbox.featherhq.com/v1/policies \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "enabled": true,
  "scope": "attachable",
  "metadata": {},
  "check_config": {},
  "action_config": {},
  "tool_target": "<string>",
  "mode": "monitor",
  "timeout_ms": 2,
  "strictness": "relaxed",
  "priority": 0
}
'

import requests

url = "https://api-sandbox.featherhq.com/v1/policies"

payload = {
    "name": "<string>",
    "description": "<string>",
    "enabled": True,
    "scope": "attachable",
    "metadata": {},
    "check_config": {},
    "action_config": {},
    "tool_target": "<string>",
    "mode": "monitor",
    "timeout_ms": 2,
    "strictness": "relaxed",
    "priority": 0
}
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    description: '<string>',
    enabled: true,
    scope: 'attachable',
    metadata: {},
    check_config: {},
    action_config: {},
    tool_target: '<string>',
    mode: 'monitor',
    timeout_ms: 2,
    strictness: 'relaxed',
    priority: 0
  })
};

fetch('https://api-sandbox.featherhq.com/v1/policies', 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-sandbox.featherhq.com/v1/policies",
  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' => '<string>',
    'description' => '<string>',
    'enabled' => true,
    'scope' => 'attachable',
    'metadata' => [
        
    ],
    'check_config' => [
        
    ],
    'action_config' => [
        
    ],
    'tool_target' => '<string>',
    'mode' => 'monitor',
    'timeout_ms' => 2,
    'strictness' => 'relaxed',
    'priority' => 0
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-api-key: <api-key>"
  ],
]);

$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-sandbox.featherhq.com/v1/policies"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"enabled\": true,\n  \"scope\": \"attachable\",\n  \"metadata\": {},\n  \"check_config\": {},\n  \"action_config\": {},\n  \"tool_target\": \"<string>\",\n  \"mode\": \"monitor\",\n  \"timeout_ms\": 2,\n  \"strictness\": \"relaxed\",\n  \"priority\": 0\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-api-key", "<api-key>")
	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-sandbox.featherhq.com/v1/policies")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"enabled\": true,\n  \"scope\": \"attachable\",\n  \"metadata\": {},\n  \"check_config\": {},\n  \"action_config\": {},\n  \"tool_target\": \"<string>\",\n  \"mode\": \"monitor\",\n  \"timeout_ms\": 2,\n  \"strictness\": \"relaxed\",\n  \"priority\": 0\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api-sandbox.featherhq.com/v1/policies")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"enabled\": true,\n  \"scope\": \"attachable\",\n  \"metadata\": {},\n  \"check_config\": {},\n  \"action_config\": {},\n  \"tool_target\": \"<string>\",\n  \"mode\": \"monitor\",\n  \"timeout_ms\": 2,\n  \"strictness\": \"relaxed\",\n  \"priority\": 0\n}"

response = http.request(request)
puts response.read_body

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "organization_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "enabled": true,
  "scope": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "description": "<string>",
  "active_revision_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "active_revision": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "policy_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "check_type": "<string>",
    "enforcement_point": "<string>",
    "action": "<string>",
    "mode": "<string>",
    "on_error": "<string>",
    "strictness": "<string>",
    "priority": 123,
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "description": "<string>",
    "check_config": {},
    "action_config": {},
    "tool_target": "<string>",
    "timeout_ms": 123,
    "created_by": "<string>"
  },
  "metadata": {}
}

{
  "error": "<string>",
  "message": "<string>",
  "retryable": true,
  "retry_after": 123
}

{
  "error": "<string>",
  "message": "<string>",
  "retryable": true,
  "retry_after": 123
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}