Skip to main content

Squillify development is paused indefinitely. Read why, and discover what this experiment achieved. Read the story

MicroSkills Reference

Schema Sample Redactor

schema.redact_schema_samples

ProductionBounded custom (Class B)Deterministicbest-effortfastv1.0.0
No network

Overview

You send a JSON Schema, an OpenAPI document, or any JSON object, and we replace the values that look sensitive — addresses, JWTs, AWS keys, private keys, card and IBAN numbers, and anything under a credential-sounding field name — with a safe placeholder or a mask. The structure, the keys, and the schema constraints all stay exactly as they were, so the document still validates and still reads the same. This catches the common shapes rather than everything, so it is a strong safety net before you publish and not a compliance guarantee.

Example values are written in a hurry against a real account, and then they live in the docs forever. Reading a whole document looking for the one address or token that should not be public is exactly the job a machine should do.

Reliability

Best-effort by design, and repeatable: the same document and options always produce the same replacements in the same order. We match on known shapes, so an unusual secret format can slip through, and in strict mode a long random-looking identifier that is perfectly public can be redacted anyway — read the findings before you trust the output. Masking keeps the first and last two characters, which reveals a little; use the placeholder style when even that is too much. We reject the call, and an unchanged retry will not help, when document is missing or is not an object, when documentKind, policy, or replacementStyle is not one of the listed values, or when maxFindings falls outside 1 to 10000.

Context footprint

The document is capped at 2000000 bytes and comes back once in full; the report adds one short row per replacement, up to maxFindings. A successful call costs 2 execution credits.

When to use it

Just before a schema, OpenAPI document, or sample payload leaves your control — published, attached to a ticket, or handed to another tool.

When you need an auditable guarantee that no personal data remains, or when the secrets live in prose or source code rather than in JSON values.

Scope

Note
We replace sensitive-looking string values in a schema, OpenAPI document, or JSON object with a placeholder or a mask, and report every replacement we made.

Non-goals

  • We never promise complete removal; this catches known shapes, not everything
  • We never touch schema constraints, so a format of email still says email
  • We never scan free-running prose for secrets — that is security.detect_secrets

Properties

IdempotentRetry safeStreaming supportedFile input supportedRequires external service

Capabilities

analysisdata-transformation

Cost & billing

Flat rate per invocation

MetercallsBillable onsuccessCost per call2 credits

File handling

Accepts file_refProduces file_refMax input1.9 MB

How we handle your data

Sensitive processing
What this means

This skill is designed to detect, mask, redact, validate, or otherwise process sensitive data.

Squillify guarantees
  • Runs inside Squillify
  • This skill runs inside Squillify.
  • Payloads are not sent to an external service by this skill.
  • Squillify does not permanently store submitted payloads.
  • Telemetry records metadata only, not submitted content.
  • Submitted payloads are not used for training.
  • Submitted payloads are not reviewed by humans.
  • Targets sensitive data
  • The response does not contain submitted content.
Your responsibility

Squillify does not determine whether submitted content is sensitive. Your application is responsible for deciding what data it is allowed to submit. Your application is responsible for securing the response.

Read the Microskill Data Handling Policy

Input schema

FieldTypeRequiredDescription
documentobjectYesJSON object to clean; extra keys are document fields and only string values are ever replaced. — unconstrained RFC 8259 JSON items.
documentKindstringNoHow widely to look for sensitive strings; omit it for generic_json.
policystringNoHow aggressively to match secrets; omit it for standard.
replacementStylestringNoWhether to swap a labelled placeholder or a length-preserving mask; omit it for placeholder.
includeReportbooleanNoWhether the findings list is returned; omit it for true.
maxFindingsintegerNoHow many findings to list, 1 through 10000; omit it for 1000.

Output schema

FieldTypeRequiredDescription
redactedobjectYesDocument with sensitive strings replaced and key order unchanged; extra keys are the original fields. — unconstrained RFC 8259 JSON items.
findingCountintegerYesHow many values were replaced in total, including those past maxFindings.
findingsarrayNoReplaced values in walk order, 0 through 10000 closed objects; omit the field entirely when includeReport is false.

API contract

POST /v1/execute
curl
curl -sS -X POST "$BASE/v1/execute" -H "Authorization: Bearer $KEY" -H 'Content-Type: application/json' -d '{"skillKey":"schema.redact_schema_samples","input":{"document":{"example":"[email protected]"}}}'
Integrations
TypeScript SDK
import { Squillify } from "@squillify/sdk";

const sq = new Squillify({ apiKey: process.env.SQUILLIFY_API_KEY });

const { output } = await sq.execute("schema.redact_schema_samples", {"document":{"example":"[email protected]"},"documentKind":"generic_json"});

Errors

CodeHTTPRetryableDescription
VALIDATION_ERROR400NoThe request payload failed schema validation.
UNAUTHORIZED401NoMissing or invalid API key.
SKILL_NOT_ACCESSIBLE403NoThe API key is not granted access to this skill.
SKILL_NOT_AVAILABLE_FOR_PLAN403NoThis skill is not included in your current plan.
PLAN_ELIGIBILITY_UNAVAILABLE503YesPlan eligibility could not be decided. Retry after backoff.
SKILL_NOT_FOUND404NoThe requested skill or version does not exist.
TENANT_RATE_LIMITED429YesRequest rate limit exceeded. Retry after backoff.
QUOTA_EXCEEDED429YesPlan quota exhausted. Retryable once the quota period resets.
EXECUTION_TIMEOUT504YesExecution exceeded the allowed time budget.

Other limits

LimitValue
Recommended inline bytes32 KiB

Limitations

  • We never promise complete removal; this catches known shapes, not everything
  • We never touch schema constraints, so a format of email still says email
  • We never scan free-running prose for secrets — that is security.detect_secrets
  • Anything that needs a guarantee of complete personal-data removal
  • Scanning free text or source files for secrets (security.detect_secrets)

How to call

POST /v1/execute (requires authentication)

Request bodyjson
{
  "skillKey": "schema.redact_schema_samples",
  "input": {
    "document": {
      "example": "[email protected]"
    },
    "documentKind": "generic_json"
  }
}

Examples

Redact an email example

Inputjson
{
  "document": {
    "example": "[email protected]"
  },
  "documentKind": "generic_json"
}
Expected outputjson
{
  "redacted": {
    "example": "<REDACTED:email>"
  },
  "findings": [
    {
      "kind": "email",
      "path": "/example",
      "confidence": 0.8,
      "replacement": "<REDACTED:email>"
    }
  ],
  "findingCount": 1
}

Strict policy with mask style

Inputjson
{
  "includeReport": false,
  "replacementStyle": "mask",
  "policy": "strict",
  "document": {
    "token": "sk_live_abc123"
  }
}
Expected outputjson
{
  "findingCount": 1,
  "redacted": {
    "token": "sk**********23"
  }
}
  • Clean the example values before you publish API documentation
  • Share a schema or payload with an outside tool without shipping real data
  • Catch the credential someone pasted into an OpenAPI example months ago

Avoid for

  • Anything that needs a guarantee of complete personal-data removal
  • Scanning free text or source files for secrets (security.detect_secrets)

Composable with

Safety & privacy

  • Runs without calling any external service.
  • Your payloads are never stored permanently.
  • Telemetry captures metadata only — never your payload contents.
  • We never train models on your payloads.
  • No human reviews your payloads.

Tags

schemasecuritytransformation