Create a PII Recognizer

POST

ai-gateway

pii-recognizers

Create a custom PII recognizer

curl --request POST \
  --url https://api.knoxcall.com/v1/ai-gateway/pii-recognizers \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "employee_id",
  "pattern": "EMP-[0-9]{6}",
  "context_words": [
    "<string>"
  ],
  "confidence": 0.85,
  "action": "redact",
  "format": "<string>",
  "enabled": true
}
'

import requests

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

payload = {
    "name": "employee_id",
    "pattern": "EMP-[0-9]{6}",
    "context_words": ["<string>"],
    "confidence": 0.85,
    "action": "redact",
    "format": "<string>",
    "enabled": 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: 'employee_id',
    pattern: 'EMP-[0-9]{6}',
    context_words: ['<string>'],
    confidence: 0.85,
    action: 'redact',
    format: '<string>',
    enabled: true
  })
};

fetch('https://api.knoxcall.com/v1/ai-gateway/pii-recognizers', 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-recognizers",
  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' => 'employee_id',
    'pattern' => 'EMP-[0-9]{6}',
    'context_words' => [
        '<string>'
    ],
    'confidence' => 0.85,
    'action' => 'redact',
    'format' => '<string>',
    'enabled' => 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://api.knoxcall.com/v1/ai-gateway/pii-recognizers"

	payload := strings.NewReader("{\n  \"name\": \"employee_id\",\n  \"pattern\": \"EMP-[0-9]{6}\",\n  \"context_words\": [\n    \"<string>\"\n  ],\n  \"confidence\": 0.85,\n  \"action\": \"redact\",\n  \"format\": \"<string>\",\n  \"enabled\": 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://api.knoxcall.com/v1/ai-gateway/pii-recognizers")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"employee_id\",\n  \"pattern\": \"EMP-[0-9]{6}\",\n  \"context_words\": [\n    \"<string>\"\n  ],\n  \"confidence\": 0.85,\n  \"action\": \"redact\",\n  \"format\": \"<string>\",\n  \"enabled\": true\n}")
  .asString();

require 'uri'
require 'net/http'

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

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\": \"employee_id\",\n  \"pattern\": \"EMP-[0-9]{6}\",\n  \"context_words\": [\n    \"<string>\"\n  ],\n  \"confidence\": 0.85,\n  \"action\": \"redact\",\n  \"format\": \"<string>\",\n  \"enabled\": true\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>",
    "kind": "regex",
    "pattern": "<string>",
    "context_words": [
      "<string>"
    ],
    "confidence": 123,
    "action": "redact",
    "format": "<string>",
    "enabled": true,
    "created_at": "2023-11-07T05:31:56Z"
  },
  "meta": {
    "request_id": "550e8400-e29b-41d4-a716-446655440000"
  }
}

Creates a recognizer. The pattern is compiled through a safe-regex validator at write time, so a pattern that could backtrack catastrophically is refused here rather than discovered on the hot path. Dry-run it first with Test a recognizer pattern — the tester compiles through the same validator, so a pattern it accepts can actually run. A recognizer that fails to compile at request time is a fail-closed condition on the data plane: the request is refused with 503 pii_policy_degraded rather than forwarded with part of the policy silently not running. 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

Example:

"employee_id"

kind

enum<string>

required

Available options:

regex,

aho_corasick,

presidio_pattern,

presidio_ner,

presidio_custom

pattern

string

required

Maximum string length: 4096

Example:

"EMP-[0-9]{6}"

context_words

string[]

confidence

number<float>

default:0.85

Required range: 0 <= x <= 1

action

enum<string>

default:redact

Available options:

redact,

tokenize,

whitelist,

warn

format

string | null

enabled

boolean

default:true

Response

The created recognizer.

data

object

One tenant-defined PII detector.

Show child attributes

meta

object

Metadata included with every API response.

Show child attributes

Create a custom PII recognizer

curl --request POST \
  --url https://api.knoxcall.com/v1/ai-gateway/pii-recognizers \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "employee_id",
  "pattern": "EMP-[0-9]{6}",
  "context_words": [
    "<string>"
  ],
  "confidence": 0.85,
  "action": "redact",
  "format": "<string>",
  "enabled": true
}
'

import requests

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

payload = {
    "name": "employee_id",
    "pattern": "EMP-[0-9]{6}",
    "context_words": ["<string>"],
    "confidence": 0.85,
    "action": "redact",
    "format": "<string>",
    "enabled": 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: 'employee_id',
    pattern: 'EMP-[0-9]{6}',
    context_words: ['<string>'],
    confidence: 0.85,
    action: 'redact',
    format: '<string>',
    enabled: true
  })
};

fetch('https://api.knoxcall.com/v1/ai-gateway/pii-recognizers', 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-recognizers",
  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' => 'employee_id',
    'pattern' => 'EMP-[0-9]{6}',
    'context_words' => [
        '<string>'
    ],
    'confidence' => 0.85,
    'action' => 'redact',
    'format' => '<string>',
    'enabled' => 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://api.knoxcall.com/v1/ai-gateway/pii-recognizers"

	payload := strings.NewReader("{\n  \"name\": \"employee_id\",\n  \"pattern\": \"EMP-[0-9]{6}\",\n  \"context_words\": [\n    \"<string>\"\n  ],\n  \"confidence\": 0.85,\n  \"action\": \"redact\",\n  \"format\": \"<string>\",\n  \"enabled\": 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://api.knoxcall.com/v1/ai-gateway/pii-recognizers")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"employee_id\",\n  \"pattern\": \"EMP-[0-9]{6}\",\n  \"context_words\": [\n    \"<string>\"\n  ],\n  \"confidence\": 0.85,\n  \"action\": \"redact\",\n  \"format\": \"<string>\",\n  \"enabled\": true\n}")
  .asString();

require 'uri'
require 'net/http'

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

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\": \"employee_id\",\n  \"pattern\": \"EMP-[0-9]{6}\",\n  \"context_words\": [\n    \"<string>\"\n  ],\n  \"confidence\": 0.85,\n  \"action\": \"redact\",\n  \"format\": \"<string>\",\n  \"enabled\": true\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>",
    "kind": "regex",
    "pattern": "<string>",
    "context_words": [
      "<string>"
    ],
    "confidence": 123,
    "action": "redact",
    "format": "<string>",
    "enabled": true,
    "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