Skip to main content

Python SDK for Blindfold Gateway - Privacy API for AI

Project description

Blindfold Python SDK

The official Python SDK for Blindfold - The Privacy API for AI.

Securely tokenize, mask, redact, and encrypt sensitive data (PII) before sending it to LLMs or third-party services.

How to use it

1. Install SDK

pip install blindfold-sdk

2. Get Blindfold API key

  1. Sign up to Blindfold here.
  2. Get your API key here.
  3. Set environment variable with your API key
BLINDFOLD_API_KEY=sk-***

Initialization

from blindfold import Blindfold

client = Blindfold()

Tokenize (Reversible)

Replace sensitive data with reversible tokens (e.g., <Person_1>).

response = client.tokenize(
    text="Contact John Doe at john@example.com",
    policy="gdpr_eu",  # Optional: Use a pre-configured policy (e.g., 'hipaa_us', 'basic')
    entities=["person", "email address"],  # Optional: Filter specific entities
    score_threshold=0.4  # Optional: Set confidence threshold
)

print(response.text)
# "Contact <Person_1> at <Email Address_1>"

print(response.mapping)
# { "<Person_1>": "John Doe", "<Email Address_1>": "john@example.com" }

Detokenize

Restore original values from tokens.

⚡ Note: Detokenization is performed client-side for better performance, security, and offline support. No API call is made.

# Runs locally - no API call!
original = client.detokenize(
    text="AI response for <Person_1>",
    mapping=response.mapping
)

print(original.text)
# "AI response for John Doe"

print(original.replacements_made)
# 1

Mask

Partially hide sensitive data (e.g., ****-****-****-1234).

response = client.mask(
    text="Credit card: 4532-7562-9102-3456",
    masking_char="*",
    chars_to_show=4,
    from_end=True
)

print(response.text)
# "Credit card: ***************3456"

Redact

Permanently remove sensitive data.

response = client.redact(
    text="My password is secret123"
)

Hash

Replace data with deterministic hashes (useful for analytics/matching).

response = client.hash(
    text="User ID: 12345",
    hash_type="sha256",
    hash_prefix="ID_"
)

Synthesize

Replace real data with realistic fake data.

response = client.synthesize(
    text="John lives in New York",
    language="en"
)

print(response.text)
# "Michael lives in Boston" (example)

Encrypt

Encrypt sensitive data using AES (reversible with key).

response = client.encrypt(
    text="Secret message",
    encryption_key="your-secure-key-min-16-chars"
)

Async Usage

The SDK also supports asyncio:

import asyncio
from blindfold import AsyncBlindfold

async def main():
    async with AsyncBlindfold(api_key="...") as client:
        response = await client.tokenize("Hello John")
        print(response.text)

        # Note: detokenize is also synchronous in async client (no await)
        original = client.detokenize(response.text, response.mapping)
        print(original.text)

asyncio.run(main())

Configuration

Entity Types

Common supported entities:

  • person
  • email address
  • phone number
  • credit card number
  • ip address
  • address
  • date of birth
  • organization
  • iban
  • social security number
  • medical condition
  • passport number
  • driver's license number

Error Handling

The SDK raises specific exceptions:

from blindfold.errors import AuthenticationError, APIError, NetworkError

try:
    client.tokenize("...")
except AuthenticationError:
    # Handle invalid API key
    pass
except APIError as e:
    # Handle API error (e.g. validation)
    print(e)
except NetworkError:
    # Handle network issues
    pass

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

blindfold_sdk-1.1.0.tar.gz (22.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

blindfold_sdk-1.1.0-py3-none-any.whl (10.0 kB view details)

Uploaded Python 3

File details

Details for the file blindfold_sdk-1.1.0.tar.gz.

File metadata

  • Download URL: blindfold_sdk-1.1.0.tar.gz
  • Upload date:
  • Size: 22.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.2

File hashes

Hashes for blindfold_sdk-1.1.0.tar.gz
Algorithm Hash digest
SHA256 9cf5aecbe067760ed7d6712e5d88c57b12c2c7ab7d61b5c207770b7e3031b95f
MD5 30d3353e73afa7558966e80d003cad1a
BLAKE2b-256 161befed3010a9f8e650b441f7bcca699ac8e712ed915ae3900d125ca73b9ac2

See more details on using hashes here.

File details

Details for the file blindfold_sdk-1.1.0-py3-none-any.whl.

File metadata

  • Download URL: blindfold_sdk-1.1.0-py3-none-any.whl
  • Upload date:
  • Size: 10.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.2

File hashes

Hashes for blindfold_sdk-1.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 5ed5a32cd9c82556db07c6110b1c277813b60480c7d9ef48e480817f2bcd1768
MD5 0bba1d8c0f227b8cac9142ca715a5d81
BLAKE2b-256 698a34ba0736cb09d16adb81fdce8d9984216d6a4548a501693c0da33f660d39

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page