Create a PII Policy

POST

ai-gateway

pii-policies

Create a PII redaction policy

curl --request POST \
  --url https://api.knoxcall.com/v1/ai-gateway/pii-policies \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "HIPAA",
  "recognizer_ids": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "default_action": "redact",
  "description": "<string>"
}
'

import requests

url = "https://api.knoxcall.com/v1/ai-gateway/pii-policies"

payload = {
    "name": "HIPAA",
    "recognizer_ids": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
    "default_action": "redact",
    "description": "<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({
    name: 'HIPAA',
    recognizer_ids: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
    default_action: 'redact',
    description: '<string>'
  })
};

fetch('https://api.knoxcall.com/v1/ai-gateway/pii-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.knoxcall.com/v1/ai-gateway/pii-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' => 'HIPAA',
    'recognizer_ids' => [
        '3c90c3cc-0d44-4b50-8888-8dd25736052a'
    ],
    'default_action' => 'redact',
    'description' => '<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 := "https://api.knoxcall.com/v1/ai-gateway/pii-policies"

	payload := strings.NewReader("{\n  \"name\": \"HIPAA\",\n  \"recognizer_ids\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ],\n  \"default_action\": \"redact\",\n  \"description\": \"<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("https://api.knoxcall.com/v1/ai-gateway/pii-policies")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"HIPAA\",\n  \"recognizer_ids\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ],\n  \"default_action\": \"redact\",\n  \"description\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.knoxcall.com/v1/ai-gateway/pii-policies")

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\": \"HIPAA\",\n  \"recognizer_ids\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ],\n  \"default_action\": \"redact\",\n  \"description\": \"<string>\"\n}"

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

{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "tenant_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "version": 123,
    "recognizer_ids": [
      "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    ],
    "default_action": "redact",
    "description": "<string>",
    "created_at": "2023-11-07T05:31:56Z"
  },
  "meta": {
    "request_id": "550e8400-e29b-41d4-a716-446655440000"
  }
}

Creates a policy. Until this endpoint shipped, PII policies could only be created in the dashboard — so a pii_redact_policy_id was obtainable only by a UI detour, and a compliance-shaped setup could not be scripted end to end from an API key. It can now. Attach the policy by setting an agent’s pii_redact_policy_id with Update agent. Requires the create capability on ai_gateway. See the control-plane overview for authentication, the {data, meta} envelope, pagination and error types.

Authorizations

Authorization

string

header

required

OAuth 2.1 authentication — recommended for new integrations. Access tokens (kc_ prefix) are minted at the root-host token endpoint https://api.knoxcall.com/oauth/token and passed as Authorization: Bearer <access_token>. Public clients must use PKCE with the authorization_code grant; confidential clients may use client_credentials. The first-party SDKs and the knoxcall login CLI handle token minting, caching, refresh, and DPoP for you.

Body

application/json

name

string

required

2-64 chars (letters, digits, space, underscore, hyphen). Unique per tenant.

Example:

"HIPAA"

recognizer_ids

string<uuid>[]

Must all be recognizers this tenant owns; a foreign id is a 400 recognizer_not_found.

default_action

enum<string>

default:redact

Available options:

redact,

tokenize,

whitelist,

warn

description

string

Maximum string length: 1000

Response

The created policy.

data

object

A tenant-scoped bundle of PII recognizers plus a default action, attached to an agent through pii_redact_policy_id.

Show child attributes

meta

object

Metadata included with every API response.

Show child attributes

Create a PII redaction policy

curl --request POST \
  --url https://api.knoxcall.com/v1/ai-gateway/pii-policies \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "HIPAA",
  "recognizer_ids": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "default_action": "redact",
  "description": "<string>"
}
'

import requests

url = "https://api.knoxcall.com/v1/ai-gateway/pii-policies"

payload = {
    "name": "HIPAA",
    "recognizer_ids": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
    "default_action": "redact",
    "description": "<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({
    name: 'HIPAA',
    recognizer_ids: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
    default_action: 'redact',
    description: '<string>'
  })
};

fetch('https://api.knoxcall.com/v1/ai-gateway/pii-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.knoxcall.com/v1/ai-gateway/pii-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' => 'HIPAA',
    'recognizer_ids' => [
        '3c90c3cc-0d44-4b50-8888-8dd25736052a'
    ],
    'default_action' => 'redact',
    'description' => '<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 := "https://api.knoxcall.com/v1/ai-gateway/pii-policies"

	payload := strings.NewReader("{\n  \"name\": \"HIPAA\",\n  \"recognizer_ids\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ],\n  \"default_action\": \"redact\",\n  \"description\": \"<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("https://api.knoxcall.com/v1/ai-gateway/pii-policies")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"HIPAA\",\n  \"recognizer_ids\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ],\n  \"default_action\": \"redact\",\n  \"description\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.knoxcall.com/v1/ai-gateway/pii-policies")

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\": \"HIPAA\",\n  \"recognizer_ids\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ],\n  \"default_action\": \"redact\",\n  \"description\": \"<string>\"\n}"

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

{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "tenant_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "version": 123,
    "recognizer_ids": [
      "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    ],
    "default_action": "redact",
    "description": "<string>",
    "created_at": "2023-11-07T05:31:56Z"
  },
  "meta": {
    "request_id": "550e8400-e29b-41d4-a716-446655440000"
  }
}

Overview

Routes

Secrets

Clients

Environments

API Keys

Webhooks

Ephemeral Proxy

AI Gateway

Audit Logs

Account

Tenant KMS

Secret Store Migrations

Changelog

Authorizations

Body

Response