ViriSIM · Quick Start Guide

Activate Your Plan

Before generating API keys, you need an active plan. ViriSIM offers a Free Plan to get started with 2,000 tokens.

Free Plan includes: 2,000 tokens, standard log retention, basic compliance checks (GDPR, EU AI Act)

How to activate:

Open the ViriSIM dashboard
Navigate to Pricing → Buy Tokens
Select Free Plan or choose a Premium plan
Complete checkout (Free Plan requires no payment)

Already have tokens? Your API toggle in the dashboard header should be ready. Skip to Step 2.

Generate Your API Key

API keys authenticate your requests. Each key follows the format: sk-viri-xxxxxxxxxxxxxxxxxxxx

Security Note: Your API key is only visible ONCE upon creation. Copy and store it securely immediately.

Steps:

In the dashboard, go to Integration → API Keys
Click "Create new API key"
Enter a descriptive name (e.g., "Production API", "Development")
Click Create API key
COPY THE KEY IMMEDIATELY — you won't see it again!

sk-viri-a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6q7r8s9t0u1v2

Enable API Monitoring

Toggle the API monitoring switch in your dashboard header to start receiving audit events.

Locate the toggle switch in the top header — switch to "Active"

When you activate: You'll see a confirmation lightbox. Your webhook endpoint is now ready to receive audit data.

Integrate the Webhook

Send your AI's input/output pairs to ViriSIM for compliance auditing. Use this endpoint:

https://analyzecompliance-vrbinbrbkq-uc.a.run.app

Required Headers:

X-API-Key: sk-viri-your-api-key-here
Content-Type: application/json

// ViriSIM Webhook Integration - JavaScript
async function auditCompliance(userInput, aiOutput) {
    const response = await fetch('https://analyzecompliance-vrbinbrbkq-uc.a.run.app', {
        method: 'POST',
        headers: {
            'X-API-Key': 'sk-viri-your-api-key-here',
            'Content-Type': 'application/json'
        },
        body: JSON.stringify({
            user_id: "your-user-id",
            company_name: "Your Company",
            use_case: "Customer Support",
            timestamp: new Date(),
            your_company_user_id: "user_12345",
            your_company_user_session_id: "session_67890",
            model_version: "gpt-4",
            input: {
                value: userInput,
                format: "text",
                country: "global"
            },
            output: {
                value: aiOutput,
                format: "text",
                country: "global"
            }
        })
    });
    
    const result = await response.json();
    console.log("Audit submission:", result.submission_id);
    return result;
}

// Example usage
auditCompliance(
    "What's the best way to handle customer data?",
    "We recommend following GDPR guidelines for data protection."
);

curl -X POST https://analyzecompliance-vrbinbrbkq-uc.a.run.app \
  -H "X-API-Key: sk-viri-your-api-key-here" \
  -H "Content-Type: application/json" \
  -d '{
    "user_id": "your-user-id",
    "company_name": "Your Company",
    "use_case": "Customer Support",
    "timestamp": new Date(),
    "your_company_user_id": "user_12345",
    "your_company_user_session_id": "session_67890",
    "model_version": "gpt-4",
    "input": {
        "value": "What is GDPR?",
        "format": "text",
        "country": "global"
    },
    "output": {
        "value": "GDPR is the General Data Protection Regulation...",
        "format": "text",
        "country": "global"
    }
}'

import requests
from datetime import datetime

def audit_compliance(user_input, ai_output):
    url = "https://analyzecompliance-vrbinbrbkq-uc.a.run.app"
    headers = {
        "X-API-Key": "sk-viri-your-api-key-here",
        "Content-Type": "application/json"
    }
    payload = {
        "user_id": "your-user-id",
        "company_name": "Your Company",
        "use_case": "Customer Support",
        "timestamp": new Date(),
        "your_company_user_id": "user_12345",
        "your_company_user_session_id": "session_67890",
        "model_version": "gpt-4",
        "input": {
            "value": user_input,
            "format": "text",
            "country": "global"
        },
        "output": {
            "value": ai_output,
            "format": "text",
            "country": "global"
        }
    }
    
    response = requests.post(url, json=payload, headers=headers)
    return response.json()

# Example
result = audit_compliance(
    "How do I delete user data?",
    "You can request deletion through your account settings."
)
print(result["submission_id"])

const https = require('https');

function auditCompliance(userInput, aiOutput) {
    const data = JSON.stringify({
        user_id: "your-user-id",
        company_name: "Your Company",
        use_case: "Customer Support",
        timestamp: new Date(),
        your_company_user_id: "user_12345",
        your_company_user_session_id: "session_67890",
        model_version: "gpt-4",
        input: { value: userInput, format: "text", country: "global" },
        output: { value: aiOutput, format: "text", country: "global" }
    });

    const options = {
        hostname: 'analyzecompliance-vrbinbrbkq-uc.a.run.app',
        method: 'POST',
        headers: {
            'X-API-Key': 'sk-viri-your-api-key-here',
            'Content-Type': 'application/json',
            'Content-Length': data.length
        }
    };

    const req = https.request(options, (res) => {
        let body = '';
        res.on('data', chunk => body += chunk);
        res.on('end', () => console.log(JSON.parse(body)));
    });
    req.write(data);
    req.end();
}

// Example
auditCompliance(
    "How do I delete user data?",
    "You can request deletion through your account settings."
);

Monitor Your First Audit

Once you send your first request, ViriSIM immediately begins processing the audit. Here's what happens:

Your request receives a submission_id (e.g., VIRI-0001234Xabcde)
The audit runs asynchronously in our compliance engine
Results appear in your dashboard under I/O Logs
Each log includes: compliance status, risk score, violated regulations, and remediation steps

First audit complete? Check your dashboard's Overview tab for health scores and compliance metrics.

Notifications: You'll receive in-app notifications for high-risk violations. Configure integrations in Settings → Help & Support → Integration.

📦 Request Payload Reference

Field	Type	Required	Description
`user_id`	string	✓	Your unique user identifier
`company_name`	string	✓	Your organization name
`use_case`	string	✓	Primary use of your AI (e.g., "Customer Support")
`timestamp`	ISO date	✓	Do not modify — ensures log accuracy (new Date())
`your_company_user_id`	string	✗	Your internal user ID for filtering
`your_company_user_session_id`	string	✗	Session ID for context analysis
`model_version`	string	✗	Your AI model version for traceability
`input.value`	string	✓	Raw user input to your AI
`input.format`	string	✓	`"text"` or `"json"`
`input.country`	string	✓	User's country or `"global"`
`output.value`	string	✓	Raw AI-generated output
`output.format`	string	✓	`"text"` or `"json"`
`output.country`	string	✓	Your country of business or `"global"`

✅ Success Response

{
  "submission_id": "VIRI-0001234Xabcde",
  "message": "Success, entry undergoing audit.",
  "status": "success"
}

❌ Common Errors

Error	Solution
`API key required in X-API-Key header`	Add your API key to the request header
`Unauthorized access!`	Invalid or missing API key — generate a new one
`Insufficient Tokens`	Purchase more tokens or switch to a higher plan
`Tokens above the limit of 2k`	Your input+output exceeds 2,000 tokens — truncate before sending
`No Subscription`	Activate a plan (Free or Premium) first

🎉 You're all set!

Now that your first audit is running, explore these advanced features:

Configure Webhooks Full API Reference Compliance Engine Best Practices

Ready to Start Auditing?

Go to ViriSIM, get your API key and run your first compliance audit in under 30 minutes.

Go to ViriSIM