Skip to content
VB-OSVB-OSVB-OS Docs

VB-OS REST API Reference

The VB-OS Cloud API is a RESTful API that provides programmatic access to the entire verification platform. This reference is auto-generated from the canonical OpenAPI specification exported from the running API server.

Base URL

Section titled “Base URL”
https://api.vb-os.org/v1

Authentication

Section titled “Authentication”

All API requests require authentication via API key or session token:

Authorization: Bearer vbos_your_api_key_here

API keys are scoped to an organization and project. See API Keys for CI/CD for key management.

Endpoint Reference

Section titled “Endpoint Reference”

The complete API reference is organized by domain. Each page documents every operation including path parameters, query parameters, request bodies, and response schemas.

Domain Description
Account Management User account operations
Alert Alert rules and notifications
API Keys API key management
Architect AI governance architect
Audit Audit log operations
Auth Authentication and sessions
Boundary Boundary management
Boundary Version Boundary version lifecycle
Certification Certification models and runs
Connectors Connector management and evidence gathering
Deployment Environment deployments
Environment Environment management
Evaluation Evaluation records and search
Flows Flow definitions and executions
Flow Templates Flow template browsing
Git Git integration
Governed Workspace Governed workspace operations
Named Sets Named set management
Notifications Notification preferences
Organization Organization and member management
Project Project management
Replay Analysis Replay evaluation analysis
Template Template browsing and forking
Template Management Template administration
Users User profile operations
Webhooks Webhook configuration

Error Format

Section titled “Error Format”

All errors return a structured response:

{
  "error": "VALIDATION_ERROR",
  "message": "Human-readable description",
  "details": {}
}

HTTP Status Codes

Section titled “HTTP Status Codes”
Code Meaning
400 Bad request: invalid input
401 Unauthenticated: missing or invalid credentials
403 Unauthorized: insufficient permissions
404 Not found
409 Conflict: resource already exists or state conflict
422 Validation error: input failed validation
429 Rate limited
500 Server error

Pagination

Section titled “Pagination”

All list endpoints use cursor-based pagination:

{
  "items": [],
  "next_cursor": "cursor_value",
  "has_more": true
}

Pass cursor and limit as query parameters.

Idempotency

Section titled “Idempotency”

Mutating endpoints support idempotency via the Idempotency-Key header:

Idempotency-Key: unique-request-id

Next Steps

Section titled “Next Steps”