API Reference
API docs coming in Phase 3
The VORO REST API is under active development. This page will be updated with full endpoint documentation, authentication details, and rate limit information once the API is publicly available.
Planned Endpoints
| Endpoint | Method | Description |
|---|---|---|
/api/scan | POST | Submit a repository or code archive for scanning |
/api/scan/:id | GET | Retrieve scan status and results |
/api/report/:id | GET | Fetch the full threat report (voro-brain output) |
/api/findings/:id | GET | List individual findings with filters |
Authentication
API access will require an API key, included as a Bearer token:
curl -H "Authorization: Bearer YOUR_API_KEY" \
https://scan.voro.security/api/scan/abc123
API keys will be available through the Team and Enterprise tiers.
CLI Output Format
In the meantime, the agent-builder CLI produces structured JSON output that can be consumed programmatically:
# Run a scan and capture output
agent-builder audit /path/to/project
# Output location
cat ~/.agent-builder/audit/audit-{id}.json
The audit JSON schema includes:
findings[]— array ofScanFindingobjects withfile,line,pattern_id,severity,category,sourcemetadata— scan duration, languages detected, scanners used, pattern count
See the Quick Start for usage examples.