Cyphrex (JavaScript / TypeScript)

Official SDK for Cyphrex — call check() before every agent action to enforce policies and log violations.

Installation

npm install cyphrex

Quick start

import { Cyphrex } from 'cyphrex';

const cyphrex = new Cyphrex({
  apiKey: process.env.CYPHREX_API_KEY!,
  agentId: 'your-agent-uuid',
  // apiUrl optional; defaults to production API
});

const result = await cyphrex.check({
  actionType: 'http_call',
  url: 'https://api.example.com/data',
});

if (!result.allowed) {
  console.error(result.reason, result.violations);
  return;
}
// proceed with the action

Constructor

| Option | Required | Description | |--------|----------|-------------| | apiKey | Yes | Account API key from Dashboard → API Keys | | agentId | Yes | UUID of the agent | | apiUrl | No | API base URL (default: https://cyphrexapi-production.up.railway.app) | | timeoutMs | No | Request timeout in ms (default: 10000) | | failOpen | No | If true, allow actions when Cyphrex is unreachable (default: false) |

check(params)

| Param | Type | Description | |-------|------|-------------| | actionType | string | e.g. http_call, llm_input, llm_response, data_access | | url | string? | For http_call | | payload | any? | Text or object (e.g. LLM prompt snippet) | | metadata | object? | Optional extra context |

Response (CheckResponse)

• allowed: boolean
• reason?: string — when blocked or error
• violations?: string[] — e.g. severity codes
• severity?: string — P1 / P2 / P3 from API
• spend?: { amount, currency } — reserved for future use

HTTP

Requests use POST {apiUrl}/v1/check with:

• Authorization: Bearer <apiKey>
• Body: { "agentId": "...", "action": { "type": "...", "url"?, "payload"? } }

Build from source

cd packages/sdk-js && npm install && npm run build

Output: dist/index.js, dist/index.d.ts.

License

MIT