Developer Documentation

Integrate the ramen ai policy execution layer through the Node SDK or REST API, then verify every enforcement decision with a signed receipt.

Authentication

Create scoped API keys and secure production requests with Bearer authentication.

Core Concepts

Understand the policy, steering, and enforcement primitives behind the runtime.

Node SDK

Install @ramen-ai/node-core and evaluate model output with locally verified receipts.

PaaS Endpoints

Call the evaluation and audit APIs directly from any server-side application.

Quickstart with Node.js

Install the published Node client. It requires Node.js 24 or newer and uses the platform's native fetch and Web Crypto implementations.

npm install @ramen-ai/node-core

Evaluate model output

import { RamenClient } from '@ramen-ai/node-core';

const ramen = new RamenClient({
  apiKey: process.env.RAMEN_API_KEY!,
});

const verdict = await ramen.evaluateCompliance(candidateOutput, {
  bundleIds: ['ramen__shield_core_it'],
});

if (!verdict.allowed || !verdict.receiptVerified) {
  throw new Error(verdict.steering ?? verdict.receiptReason ?? 'Evaluation failed');
}

Choose your integration path

Node SDK — typed client methods and local Ed25519 receipt verification.
PaaS Endpoints — direct HTTP integration for any backend stack.
Authentication — API key handling and least-privilege scopes.
Core Concepts — the architecture behind policy execution.