Developer Docs & API Reference

⚡ Quickstart Guide

Rivenstack AI allows you to deploy and trigger autonomous enterprise AI agents using REST endpoints, Python, or Node.js. All API requests require a valid Bearer token provided in your enterprise dashboard.

Authentication Header

Authorization: Bearer rs_live_prod_991823x

📦 SDK Installation & Setup

Install the official Rivenstack client library to trigger AI agent pipelines directly within your application backend.

Python SDK Example

Python pip

# Install Rivenstack Python SDK
pip install rivenstack-ai

# Trigger Veronica Voice AI Receptionist Agent
from rivenstack import RivenEngine

engine = RivenEngine(api_key="rs_live_prod_991823x")

# Dispatch Inbound Call Agent
session = engine.agents.veronica.dispatch_call(
    phone_number="+1 (800) 555-0199",
    clinic_id="AUC_CLINIC_901",
    patient_id="PATIENT_88129",
    action="APPOINTMENT_REBOOK"
)

print("Call Session Status:", session.status)
# Output: ACTIVE_TALKING (Veronica speaking)

Node.js / TypeScript SDK Example

Node.js npm

// Install Rivenstack Node SDK
npm install @rivenstack/sdk

import { RivenClient } from '@rivenstack/sdk';

const client = new RivenClient({ apiKey: process.env.RIVENSTACK_API_KEY });

// Trigger Samantha Document Allocator
const document = await client.documents.process({
  fileUrl: 'https://storage.enterprise.com/scans/patient_record_991.pdf',
  autoVerify: true,
  complianceLevel: 'ISO27001_STRICT'
});

console.log('Filing Verification:', document.verificationScore); // 99.99%

POST Veronica Voice AI Dispatch

Trigger an inbound or outbound voice call session managed by Veronica AI receptionist.

HTTP Request Payload & Schema POST /v2/agents/veronica/dispatch

{
  "agent_id": "Veronica-AI-Voice",
  "mode": "OUTBOUND_RESCHEDULE",
  "recipient": {
    "name": "Marsha S Denton",
    "phone": "+1-555-0149",
    "doctor_assigned": "Dr. Smith"
  },
  "guardrails": {
    "approved_script_only": true,
    "privacy_protection": "HIPAA_STRICT",
    "max_duration_sec": 300
  }
}

Expected Response 200 OK

{ "status": "QUEUED", "call_id": "call_v2_88912", "estimated_dial_time": "1.2s" }

🛡️ SOC2 Type II & Zero Data Retention

Rivenstack AI provides enterprise-grade infrastructure with AES-256 encryption at rest, TLS 1.3 in transit, and Zero Data Retention (ZDR) architecture for clinical and financial compliance.

ISO27001 Certified onshore cloud infrastructure
Zero Data Retention: Customer data is never stored for public AI model training
HIPAA & GDPR compliance ready with automated audit logging
Multi-Factor Authentication (MFA) and single sign-on (SSO/SAML 2.0)