VB-OS Node.js SDK Complete Reference

The VBOSClient exposes 27 resource namespaces as readonly properties, plus 5 top-level convenience methods. All methods return Promise<unknown>.

Top-Level Methods

Method	Signature	Description
`verify`	`(kwargs)`	Submit workload for evaluation
`verifyBatch`	`(kwargs)`	Submit multiple workloads
`validate`	`(kwargs)`	Validate workload without recording
`certify`	`(projectId, kwargs)`	Initiate certification run
`replay`	`(projectId, evaluationId)`	Replay evaluation (delegates to `evaluations.replay`)

Resource Namespaces

`account`

Method	Signature
`delete`	`()`
`cancelDelete`	`()`
`deletionStatus`	`()`
`export`	`()`
`exportLatest`	`()`
`exportStatus`	`(exportId)`
`exportDownload`	`(exportId)`

`alertRules`

Method	Signature
`create`	`(projectId, kwargs)`
`list`	`(projectId, opts?)`
`get`	`(projectId, ruleId)`
`update`	`(projectId, ruleId, kwargs)`
`delete`	`(projectId, ruleId)`

`analytics`

Method	Signature
`assertionRate`	`(projectId, kwargs)`
`deferralRate`	`(projectId, kwargs)`
`evaluations`	`(projectId, kwargs)`
`failureReasons`	`(projectId, kwargs)`
`latency`	`(projectId, kwargs)`

`auditLog`

Method	Signature
`list`	`(opts?)`
`export`	`(kwargs)`
`exportStatus`	`(exportId)`

`billing`

Method	Signature
`usage`	`(kwargs)`
`subscription`	`()`
`invoices`	`(kwargs)`

`boundaries`

Method	Signature
`list`	`(projectId, opts?)`
`create`	`(projectId, kwargs)`
`get`	`(projectId, boundaryRef)`
`updateDraft`	`(projectId, boundaryRef, kwargs)`
`submit`	`(projectId, boundaryRef)`
`versions`	`(projectId, boundaryRef, opts?)`
`getVersion`	`(projectId, boundaryRef, versionId)`
`approve`	`(projectId, boundaryRef, versionId)`
`reject`	`(projectId, boundaryRef, versionId)`
`diff`	`(projectId, boundaryRef, kwargs)`

`certificationModels`

Method	Signature
`list`	`(projectId, opts?)`
`create`	`(projectId, kwargs)`
`createVersion`	`(projectId, modelId, kwargs)`

`certifications`

Method	Signature
`list`	`(projectId, opts?)`
`get`	`(projectId, runId)`
`getReport`	`(projectId, runId)`
`wait`	`(projectId, runId, opts?)`

`connectorProviders`

Method	Signature
`list`	`(opts?)`
`schema`	`(providerId)`

`connectors`

Method	Signature
`create`	`(projectId, kwargs)`
`list`	`(projectId, opts?)`
`get`	`(projectId, connectorId)`
`update`	`(projectId, connectorId, kwargs)`
`delete`	`(projectId, connectorId)`
`test`	`(projectId, connectorId)`
`gather`	`(projectId, connectorId, kwargs)`
`analytics`	`(projectId, kwargs)`
`resources`	`(projectId, connectorId, opts?)`
`schema`	`(projectId, connectorId)`
`getSchedule`	`(projectId, connectorId)`
`setSchedule`	`(projectId, connectorId, kwargs)`
`listGathers`	`(projectId, connectorId, opts?)`

`deployments`

Method	Signature
`list`	`(projectId, environmentId, opts?)`
`create`	`(projectId, environmentId, kwargs)`
`active`	`(projectId, environmentId)`
`approve`	`(projectId, environmentId, deploymentId)`
`reject`	`(projectId, environmentId, deploymentId)`
`promote`	`(projectId, environmentId, kwargs)`
`rollback`	`(projectId, environmentId, kwargs)`

`environments`

Method	Signature
`list`	`(projectId, opts?)`
`create`	`(projectId, kwargs)`
`get`	`(projectId, environmentId)`
`update`	`(projectId, environmentId, kwargs)`
`deactivate`	`(projectId, environmentId)`
`reactivate`	`(projectId, environmentId)`

`evaluations`

Method	Signature
`list`	`(projectId, opts?)`
`get`	`(projectId, evaluationId)`
`replay`	`(projectId, evaluationId)`
`export`	`(projectId, kwargs)`
`share`	`(projectId, evaluationId)`
`getShared`	`(token)`

`flowTemplates`

Method	Signature
`list`	`(opts?)`
`get`	`(slug)`

`flows`

Method	Signature
`create`	`(projectId, kwargs)`
`list`	`(projectId, opts?)`
`get`	`(projectId, flowId)`
`update`	`(projectId, flowId, kwargs)`
`delete`	`(projectId, flowId)`
`export`	`(projectId, flowId)`
`importFlow`	`(projectId, kwargs)`
`fromTemplate`	`(projectId, kwargs)`
`createVersion`	`(projectId, flowId, kwargs)`
`listVersions`	`(projectId, flowId, opts?)`
`getVersion`	`(projectId, flowId, versionId)`
`updateVersion`	`(projectId, flowId, versionId, kwargs)`
`deleteVersion`	`(projectId, flowId, versionId)`
`approveVersion`	`(projectId, flowId, versionId)`
`deploy`	`(projectId, flowId, versionId, kwargs)`
`suspend`	`(projectId, flowId, deploymentId)`
`dryRun`	`(projectId, flowId, versionId, kwargs)`
`listExecutions`	`(projectId, flowId, opts?)`
`reconstructExecution`	`(projectId, flowId, executionId)`

`governedWorkspaces`

Method	Signature
`create`	`(projectId, kwargs)`
`list`	`(projectId, opts?)`
`get`	`(projectId, workspaceId)`
`createVersion`	`(projectId, workspaceId, kwargs)`
`getVersion`	`(projectId, workspaceId, versionId)`
`submit`	`(projectId, workspaceId, versionId)`
`approve`	`(projectId, workspaceId, versionId)`
`deploy`	`(projectId, workspaceId, versionId)`
`archive`	`(projectId, workspaceId, versionId)`
`createInstance`	`(projectId, workspaceId, kwargs)`
`submitInstance`	`(projectId, workspaceId, instanceId)`
`getInstance`	`(projectId, workspaceId, instanceId)`

`keys`

Method	Signature
`list`	`(projectId, environmentId, opts?)`
`create`	`(projectId, environmentId, kwargs)`
`get`	`(projectId, environmentId, keyId)`
`rotate`	`(projectId, environmentId, keyId)`
`revoke`	`(projectId, environmentId, keyId)`
`disable`	`(projectId, environmentId, keyId)`
`enable`	`(projectId, environmentId, keyId)`

`members`

Method	Signature
`list`	`(opts?)`
`invite`	`(kwargs)`
`setRole`	`(userId, kwargs)`
`remove`	`(userId)`
`suspend`	`(userId)`
`reactivate`	`(userId)`
`revokeInvitation`	`(userId)`

`namedSets`

Method	Signature
`create`	`(projectId, kwargs)`
`list`	`(projectId, opts?)`
`get`	`(projectId, namedSetId)`
`update`	`(projectId, namedSetId, kwargs)`
`delete`	`(projectId, namedSetId)`
`usage`	`(projectId, namedSetId)`

`notifications`

Method	Signature
`list`	`(opts?)`
`read`	`(notificationId)`
`unread`	`(notificationId)`

`org`

Method	Signature
`get`	`()`
`update`	`(kwargs)`
`getSettings`	`()`
`updateSettings`	`(kwargs)`
`getAiPolicy`	`()`
`updateAiPolicy`	`(kwargs)`
`transferOwnership`	`(kwargs)`
`acceptTransfer`	`(transferId)`
`cancelTransfer`	`(transferId)`
`getTransfer`	`()`

`projects`

Method	Signature
`list`	`(opts?)`
`create`	`(kwargs)`
`get`	`(projectId)`
`update`	`(projectId, kwargs)`
`archive`	`(projectId)`
`delete`	`(projectId)`
`listMembers`	`(projectId, opts?)`
`addMember`	`(projectId, kwargs)`
`removeMember`	`(projectId, assignmentId)`
`updateMember`	`(projectId, assignmentId, kwargs)`

`serviceAccounts`

Method	Signature
`list`	`(opts?)`
`create`	`(kwargs)`
`update`	`(accountId, kwargs)`
`disable`	`(accountId)`
`enable`	`(accountId)`

`templates`

Method	Signature
`list`	`(opts?)`
`get`	`(slug)`
`fork`	`(slug, kwargs)`

`users`

Method	Signature
`me`	`()`
`organizations`	`()`

`webhooks`

Method	Signature
`list`	`(projectId, opts?)`
`create`	`(projectId, kwargs)`
`update`	`(projectId, webhookId, kwargs)`
`delete`	`(projectId, webhookId)`
`rotateSecret`	`(projectId, webhookId)`
`deliveries`	`(projectId, webhookId, opts?)`
`listOrg`	`(opts?)`
`createOrg`	`(kwargs)`

`workspaces`

Method	Signature
`list`	`(opts?)`
`create`	`(kwargs)`
`get`	`(workspaceId)`
`update`	`(workspaceId, kwargs)`
`archive`	`(workspaceId)`
`delete`	`(workspaceId)`
`listMembers`	`(workspaceId, opts?)`
`addMember`	`(workspaceId, kwargs)`
`removeMember`	`(workspaceId, assignmentId)`

Pagination

All list methods accept an optional opts object with:

Field	Type	Default	Description
`limit`	`number`	`20`	Maximum items per page
`cursor`	`string`		Cursor for the next page

const page = await client.projects.list({ limit: 10 });
// Use page.cursor for the next page

Parameter Conventions

kwargs: Object with snake_case fields. Positional parameters are path parameters; remaining fields are sent as body for mutating methods and as query parameters for read methods.
opts: Pagination options ({ limit?, cursor? })
Positional parameters (projectId, boundaryRef, etc.) are path parameters