Official SDKs
Get started with PrivaiShield in your language of choice. Our SDKs wrap the REST API with idiomatic interfaces, type safety, and built-in best practices.
Overview
All SDKs provide the same core functionality: text redaction, document processing, streaming, and batch operations. Choose the SDK that best fits your stack.
@privaishield/sdkFull-featured SDK for Node.js and browser environments with TypeScript support.
- TypeScript types included
- Promise-based async API
- Streaming support
- Browser & Node.js compatible
privaishieldPythonic SDK with both synchronous and async interfaces, plus pandas integration.
- Sync and async clients
- Type hints throughout
- Pandas DataFrame support
- Context manager support
com.privaishield:sdkEnterprise-grade SDK with builder pattern, reactive streams, and Spring Boot integration.
- Builder pattern API
- Reactive streams (Project Reactor)
- Spring Boot starter
- Comprehensive Javadoc
Installation
Install the SDK for your language using your package manager.
npm install @privaishield/sdk # or yarn add @privaishield/sdk # or pnpm add @privaishield/sdk
pip install privaishield # or poetry add privaishield
implementation 'com.privaishield:sdk:1.0.0'
<dependency> <groupId>com.privaishield</groupId> <artifactId>sdk</artifactId> <version>1.0.0</version> </dependency>
SDK Comparison
All SDKs support the full API feature set. Here's a quick comparison of language-specific features.
| Feature | JavaScript | Python | Java |
|---|---|---|---|
| Text Redaction | |||
| Document Processing | |||
| Streaming | |||
| Batch Processing | |||
| TypeScript Types | — | — | |
| Type Hints | — | — | |
| Async/Await | — | ||
| Reactive Streams | — | — | |
| Browser Support | — | — | |
| Spring Boot Starter | — | — |
Quick Start
Here's a minimal example in each language to get you started.
import { PrivaiShield } from '@privaishield/sdk';
const client = new PrivaiShield({ apiKey: process.env.PRIVAISHIELD_API_KEY });
const result = await client.redact({ text: 'Email: john@example.com' });
console.log(result.redacted); // "Email: [EMAIL_1]"from privaishield import PrivaiShield client = PrivaiShield(api_key=os.environ["PRIVAISHIELD_API_KEY"]) result = client.redact(text="Email: john@example.com") print(result.redacted) # "Email: [EMAIL_1]"
PrivaiShield client = PrivaiShield.builder()
.apiKey(System.getenv("PRIVAISHIELD_API_KEY"))
.build();
RedactResult result = client.redact()
.text("Email: john@example.com")
.execute();
System.out.println(result.getRedacted()); // "Email: [EMAIL_1]"