Developer Documentation

Create an account

Sign up at /signup with Google, GitHub, or email. No credit card. After you create an account you complete a short company profile, then land in the dashboard.

Quick Start

Installation

Install the Cyphrex SDK for JavaScript/TypeScript or Python:

# JavaScript / TypeScript
npm install cyphrex

# Python
pip install cyphrex

Get your API key

An API key is created at signup. POST /v1/auth/register returns apiKey once. The web signup UI discards that value, so you never see it on screen. After that the dashboard shows only the last 4 characters.

The only way to see a plaintext key is to rotate it: sign in at the dashboard, go to API Keys, and click Rotate API key. Rotation is owner-only (account admin). The new key is shown once — copy it immediately. Members cannot rotate. Keys start with cprx_live_. There is no generate button.

Register your first agent

In the dashboard, go to Agents → Add Agent. Give it a name and optional behavior profile. Copy the Agent ID.

Make your first check() call

Before your agent performs an action (e.g. an HTTP request or LLM call), call the SDK. The SDK actionType argument is sent on the wire as action.type — do not POST a top-level actionType field; the API rejects that body.

// JavaScript
const { Cyphrex } = require('cyphrex');
const cyphrex = new Cyphrex({
  apiKey: process.env.CYPHREX_API_KEY,
  agentId: 'your-agent-uuid'
});

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

if (!result.allowed) {
  console.error('Blocked:', result.reason, result.severity);
  return;
}
// Proceed with the action

View results in the audit log

Go to Audit Log in the dashboard to see every check: allowed/blocked, action type, spend, and timestamps.

Team Access

Invite teammates to your Cyphrex account from Settings → Team. Invited members share the same agents, reports, and audit log.

Roles:

• Admin — full access including billing, settings, and team management
• Member — can view and generate reports and manage agents
• Viewer — read only

Invites are sent by email and expire in 48 hours. Invited members complete their own profile on signup but inherit your company account.