@arcshield-ai/sdk
v2.4.1
Published
ArcShield AI platform SDK - integrate threat detection and model security into your applications
Downloads
1,986
Maintainers
Readme
@arcshield-ai/sdk
Official Node.js SDK for the ArcShield AI security platform.
Installation
npm install @arcshield-ai/sdkQuick Start
const { ArcShieldClient } = require("@arcshield-ai/sdk");
const client = new ArcShieldClient({
apiKey: process.env.ARCSHIELD_API_KEY,
});
// Scan a prompt for injection attacks
const result = await client.scanPrompt("Summarize this document", {
model: "gpt-4",
threshold: 0.9,
});
if (result.blocked) {
console.log(`Threat detected: ${result.threat_type}`);
}Express Middleware
const { ArcShieldClient, ArcShieldMiddleware } = require("@arcshield-ai/sdk");
const client = new ArcShieldClient();
const shield = new ArcShieldMiddleware(client);
app.use("/api/chat", shield.expressMiddleware({ policies: ["prompt-injection", "data-exfil"] }));Configuration
| Option | Environment Variable | Default |
|--------|---------------------|---------|
| apiKey | ARCSHIELD_API_KEY | — |
| baseUrl | ARCSHIELD_BASE_URL | https://api.arcshield.ai/v2 |
| timeout | — | 30000 |
License
MIT - ArcShield AI, Inc.
