@noirstack/openaiguardrails

Official JavaScript/TypeScript client for the Open AI Guardrails runtime governance API.

Install

npm install @noirstack/openaiguardrails

Usage

import { createClient } from '@noirstack/openaiguardrails';

const guardrails = createClient({
  baseUrl: 'https://openaiguardrails.org',
  token: process.env.OPENAIGUARDRAILS_API_TOKEN
});

const policy = await guardrails.getPolicy('prod-safety-alpha');
const audit = await guardrails.exportAudit('prod-safety-alpha');

API surface

• health()
• listPolicies()
• getPolicy(policyId)
• togglePolicyControl(policyId, key, value)
• runPolicyAction(policyId, action, payload)
• exportAudit(policyId)
• listOpaImports()
• importOpaPolicy(payload)
• simulateOpaImport(importId, input)
• exportOpaImport(importId, target)
• publishOpaImport(importId, payload)

The client is dependency-free and uses the platform fetch API available in modern browsers and Node.js 18+.

Links

• Documentation: https://openaiguardrails.org/docs/
• Runtime reference: https://openaiguardrails.org/api/reference/
• Packages: https://openaiguardrails.org/projects/pypi-packages.html