Quickstart

Get up and running with SignalVault in under 5 minutes.

1. Create an account

Sign up for free and create your first app from the dashboard.

2. Get your API key

In your app's Settings tab, create an API key. Copy it — you'll only see it once.

3. Send events

Pick whichever approach fits your stack:

Option A: Use an SDK (Node.js / Python)

Our SDKs wrap the OpenAI client and automatically send audit events for every request. Install and use as a drop-in replacement:

npm install @signalvaultio/node openai

import SignalVaultClient from '@signalvaultio/node';

const client = new SignalVaultClient({
  apiKey: 'sk_live_...',
  openaiApiKey: process.env.OPENAI_API_KEY,
  baseUrl: 'https://api.signalvault.io',
});

const response = await client.chat.completions.create({
  model: 'gpt-4',
  messages: [{ role: 'user', content: 'Hello!' }],
});

See the Node.js SDK or Python SDK docs for full details.

Option B: Call the REST API directly

No SDK needed. Send events to the POST /v1/events endpoint from any language or tool. Here's a curl example:

curl -X POST https://api.signalvault.io/v1/events \
  -H "Authorization: Bearer sk_live_..." \
  -H "Content-Type: application/json" \
  -d '{
    "type": "ai.request",
    "request_id": "req_abc123",
    "environment": "production",
    "provider": "openai",
    "model": "gpt-4",
    "payload": {
      "messages": [{"role": "user", "content": "Hello!"}]
    }
  }'

This works from Go, Rust, Java, Ruby, PHP — anything that can make an HTTP request. See the API Reference for the full endpoint documentation.

That's it! All events are logged in your dashboard with guardrail checks applied automatically.