Documentation

PaywallOS Documentation

Everything you need to build AI-native paywalls with OpenVerb

Quick Start

1. Get API Keys

Sign up at PaywallOS, create an app, and copy your API Key and App ID.

2. Initialize

import { initPaywallOS } from './paywall-sdk'

// Call once at app startup (copy paywall-sdk from our repo)
initPaywallOS(apiKey, appId, user.id, user.tier)

<App />

3. Add Verb Attributes

<button verb="export_data">Export</button>
<button verb="generate_report">Reports</button>
<div verb="ai_suggestions">
  <AISuggestionsPanel />
</div>

4. Done! ✨

PaywallOS now automatically checks user tiers and enforces access. No button logic needed.

Additional Resources

OpenVerb Spec
Learn about the universal action language
GitHub Repository
View source code and examples
Research Paper
Read about AI-native access control
Video Tutorial
Watch the OpenVerb introduction

Need Help?

Our team is here to help you succeed with PaywallOS

PaywallOS Sandbox

The OpenVerb JSON library defines what actions exist in the app.

Analytics
dashboard.view
Access to the main analytics dashboard and basic metrics.
data.export
Export reports and raw data to CSV or PDF formats.
data.streaming
Access to real-time websocket data and live feed updates.
AI
ai.insights
Generate automated summaries and trend detection from datasets.
ai.forecast
Access to predictive modeling and future trend forecasting.
Collaborate
team.collaboration
Shared workspaces, comments, and team-based tagging.
Developer
api.custom_keys
Generate and manage programmatic API keys for data integration.
Service
support.priority
Priority ticket handling and 24/7 technical support access.
8 verbs loaded from openverb.core.json

Subscription tiers determine pricing. Each tier unlocks specific verbs.

Free
Free
dashboard.view
1 verb included
Pro
$29/mo
dashboard.view
data.export
ai.insights
3 verbs included
Business
$99/mo
dashboard.view
data.export
data.streaming
ai.insights
ai.forecast
team.collaboration
api.custom_keys
support.priority
8 verbs included

The access control matrix. Which verbs are allowed on which tiers.

VerbFreeProBusiness
dashboard.view
data.export
50/monthly
data.streaming
ai.insights
20/monthly
ai.forecast
team.collaboration
api.custom_keys
support.priority
Active User
Try an Action