Redact personal information

Suggest redactions in English text using a local entity model and contact patterns.

POST/api/v1/tools/redact-personal-information/run

Base URL: https://happytails.ai · public API not connected

Overview

Suggest redactions in English text using a local entity model and contact patterns. Review names, emails, phone numbers and street addresses in the JSON preview. Private details may be missed and public text may be flagged. Up to 16,000 characters. This does not guarantee anonymization.

All API requests process supplied data on the server.

Request parameters

Send a JSON object. Unknown properties are rejected. Omitted options use the defaults below; enter numbers and booleans as JSON values, not quoted text.

input is a string, empty by default, up to 1,000,000 characters. Up to 1,000,000 characters. Review the settings before running.

This endpoint does not accept a files array.

Options

No options are needed. Omit options or send an empty object.

Success response

HTTP 200 returns tool and result. Text is in result.text; parsed JSON may also appear in result.data. Generated files are in result.files with name, mime, bytes and base64. Decode the bytes before saving. Empty file arrays and null text are valid for operations returning another result type.

Complete output schema

{
  "type": "object",
  "required": [
    "tool",
    "result"
  ],
  "properties": {
    "tool": {
      "type": "string"
    },
    "result": {
      "type": "object",
      "required": [
        "text",
        "files"
      ],
      "properties": {
        "text": {
          "type": [
            "string",
            "null"
          ]
        },
        "data": {
          "description": "Parsed JSON when the textual result is JSON."
        },
        "name": {
          "type": "string"
        },
        "mime": {
          "type": "string"
        },
        "files": {
          "type": "array",
          "items": {
            "type": "object",
            "required": [
              "name",
              "mime",
              "bytes",
              "base64"
            ],
            "properties": {
              "name": {
                "type": "string"
              },
              "mime": {
                "type": "string"
              },
              "bytes": {
                "type": "integer"
              },
              "base64": {
                "type": "string",
                "contentEncoding": "base64"
              }
            }
          }
        }
      }
    }
  }
}

Limits and failures

Limits below are enforced by this endpoint. Additional format, page, duration and model limits in the behavior notes also apply. Browser UI limits can differ from API limits.

request_bytes: 31457280
input_characters: 1000000
files_bytes: 20971520
max_files: 0
timeout_seconds: 90

Invalid requests return an error object with code and message. Read HTTP statuses, retries, timeouts and concurrency. Execution is synchronous and results are returned in the response.

Complete request schema

Expand the JSON schema

{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "input": {
      "type": "string",
      "maxLength": 1000000,
      "default": "",
      "description": "Plain text input. File tools use files instead unless otherwise documented."
    },
    "options": {
      "type": "object",
      "additionalProperties": false,
      "properties": {}
    }
  }
}

For browser automation, use the central WebMCP guidance and discover the tools actually exposed by the browser.

Request example

curl https://happytails.ai/api/v1/tools/redact-personal-information/run \
  -H "Content-Type: application/json" \
  --data '{"options": {}, "input": "Your input"}'

const payload = {
  "options": {},
  "input": "Your input"
};

const response = await fetch(
  "https://happytails.ai/api/v1/tools/redact-personal-information/run",
  {
    method: "POST",
    headers: { "Content-Type": "application/json" },
    body: JSON.stringify(payload)
  }
);
const data = await response.json();
if (!response.ok) throw new Error(data.error.message);
console.log(data.result);

import json
from urllib.request import Request, urlopen

payload = json.loads('{"options": {}, "input": "Your input"}')

request = Request(
    "https://happytails.ai/api/v1/tools/redact-personal-information/run",
    data=json.dumps(payload).encode(),
    headers={"Content-Type": "application/json"},
)
with urlopen(request, timeout=200) as response:
    result = json.load(response)
    print(result)

{
  "options": {},
  "input": "Your input"
}

Replace the API origin and input values for your application.

200 OK · response structure

{
  "tool": "redact-personal-information",
  "result": {
    "text": null,
    "files": []
  }
}

Illustrative envelope. Actual text, filename, MIME type and bytes depend on the result. See the complete output schema.

400 Bad Request

{
  "error": {
    "code": "INVALID_INPUT",
    "message": "Unknown request property. See the tool input schema."
  }
}