Redact String • AI Agent SDK

</div>

This function is defined in the redact module.

Redact potential secrets from a string.

This is a best-effort function that looks for common patterns like “api_key=xxx” or “password: xxx” in strings, plus secrets carried in URLs (`scheme://user:pass@host userinfo, ?token=xxx query params and /bot<id>:<token>/` path segments).

Signature

def redact_string(text: str, enabled: bool) -> str

Parameters

Returns

Uses

• _URL_USERINFO_PATTERN.sub
• _URL_BOT_TOKEN_PATTERN.sub
• _REDACT_KV_PATTERN.sub

Used By

• scrub_pii_text

Source