Docs — VODR Organism

01

Quick start

Install the CLI, run vodr init in your project directory. The Organism registers your system in under two minutes.

pip install vodr-cli cd your-project vodr init

02

vodr init — the four questions

$ vodr init

🔍 VODR Organism — System Registration

1. What does your system do?
   > AI-powered resume screening tool that ranks job applicants

2. What's your role?
   [1] I built this (provider)
   [2] I use this (deployer)
   [3] Both
   > 1

3. Where does it operate? [default: global]
   > eu, us-california

4. What does it do? (press Enter to auto-detect)
   >

✅ System registered.

   System ID:   sys_7kx9m2p4
   Risk Level:  HIGH
   Frameworks:  EU AI Act, GDPR, CCPA
   Score:       0/100 — no controls completed yet

   → vodr.yml        (commit this)
   → .vodr/config    (add to .gitignore)

1Description — plain language, one sentence. The classifier does the rest.

2Role — provider, deployer, or both. Determines which obligations apply.

3Jurisdictions — narrows geographic scope. Global if unsure.

4Functions — optional. Auto-detected from description. Provide for higher precision.

03

GitHub Action

Add compliance checking to every pull request. Store VODR_API_KEY and VODR_SYSTEM_ID as GitHub repository secrets.

Workflow file — .github/workflows/compliance.yml

        
name: VODR Compliance Check
on: [pull_request]
jobs:
  compliance:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: vodr-ai/compliance-check@v1
        with:
          api_key: ${ secrets.VODR_API_KEY }
          system_id: ${ secrets.VODR_SYSTEM_ID }
          fail_threshold: '70'
          fail_on_high_risk: 'true'

Free tier PR comment

╔══════════════════════════════════════════════════╗
║  VODR Compliance Check                           ║
║  Score: 71/100 — 4 gaps detected                 ║
╠══════════════════════════════════════════════════╣
║  AI Compliance    ██████████░░░░  67%             ║
║  Data Privacy     ████████████░░  82%             ║
║  Cybersecurity    █████████░░░░░  71%             ║
║  ⚠ 2 high-risk gaps require attention            ║
║  ⚠ EU AI Act enforcement: 129 days               ║
║  → Upgrade to Pro for full breakdown             ║
╚══════════════════════════════════════════════════╝

04

vodr.yml reference

        
version: 1
system:
  id: sys_7kx9m2p4         # set by vodr init — do not change
  name: "my-ai-project"
  description: "AI-powered resume screening tool"
  role: provider           # provider | deployer | both
  industry: employment     # optional
  jurisdictions:
    - eu
    - us-california
  functions:              # optional — auto-detected if omitted
    - decides_about_people
    - processes_personal_data
ci:
  fail_threshold: 0
  fail_on_high_risk: false
  comment: true

Field	Required	Description
`system.id`	Yes	Set by vodr init. Permanent. Never change.
`system.description`	Yes	One to two sentences. Primary input to the classifier.
`system.role`	Yes	provider — you built it. deployer — you use it. both — you built and deploy it.
`system.industry`	No	Narrows framework selection. Examples: employment, healthcare, finance, education.
`system.jurisdictions`	No	Regions: eu, us, us-california, uk, global. Defaults to global.
`system.functions`	No	Auto-detected. Options: decides_about_people, monitors_people, processes_personal_data, generates_content, controls_physical, analyzes_data.
`ci.fail_threshold`	No	Score below this value fails the build. Default 0.
`ci.fail_on_high_risk`	No	Exit 1 if high-risk gaps exist. Default false.

05

API reference

Base URL: https://api.vodr.ai. All endpoints return JSON.

Method	Endpoint	Auth	Description
POST	`/api/v1/classify`	None	Classify a system description. Free. No key required.
POST	`/api/v1/keys`	None	Create a free API key.
GET	`/api/v1/systems/{id}/status`	Bearer	Get current compliance posture.
POST	`/api/v1/systems/{id}/sync`	Bearer	Sync manifest changes.
GET	`/api/v1/systems/{id}/ci-check`	Bearer	CI/CD gate endpoint.
GET	`/api/v1/health`	None	Organism health and stats.

Rate limits by tier

Tier	Calls / Day	Rate (/ min)	Systems
Free	50	5	1
Dev	100	10	1
Pro	1,000	50	3
Team	10,000	200	25
Enterprise	Unlimited	1,000	Unlimited

06

CLI commands

Command	Tier	Description
`vodr init`	Free	Register system. Creates vodr.yml and .vodr/config.
`vodr status`	Free	Score, domain breakdown, risk level, next deadline.
`vodr gaps`	Free (2) / Dev+	Top 2 gaps free. Full list behind Dev tier with article references.
`vodr upgrade`	Free	Opens vodr.ai/pricing in browser. Stripe checkout. Under 60 seconds.