Docs
⌘K

JavaScript: Low-level API client

sovaria.api — every Sovaria REST endpoint as a typed method, generated from the API contract, for calls the area methods don't cover.

Updated Oct 16, 2026

sovaria.api exposes every REST endpoint as a typed method, generated from the API contract. Prefer the area methods (sovaria.auth, sovaria.data, …) — they add sessions, defaults and friendlier shapes — and use sovaria.api for endpoints they don't cover.

sovaria.api.auth

sovaria.api.auth.confirmVerificationEmail

Confirm an email verification token.

sovaria.api.auth.confirmVerificationEmail(args: { token: JsonValue }): Promise<JsonValue>

POST /api/v1/auth/verify-email/confirm

Parameters

args{ token: JsonValue }required
Returns
Promise<JsonValue>
HTTP
POST /api/v1/auth/verify-email/confirm

sovaria.api.auth.disableMfa

DELETE /api/v1/auth/mfa

sovaria.api.auth.disableMfa(args: { totpCode: JsonValue }): Promise<JsonValue>

Parameters

args{ totpCode: JsonValue }required
Returns
Promise<JsonValue>
HTTP
DELETE /api/v1/auth/mfa

sovaria.api.auth.enrollMfa

POST /api/v1/auth/mfa/enroll

sovaria.api.auth.enrollMfa(): Promise<JsonValue>
Returns
Promise<JsonValue>
HTTP
POST /api/v1/auth/mfa/enroll

sovaria.api.auth.getMfaStatus

GET /api/v1/auth/mfa/status

sovaria.api.auth.getMfaStatus(): Promise<JsonValue>
Returns
Promise<JsonValue>
HTTP
GET /api/v1/auth/mfa/status

sovaria.api.auth.getProvidersConfig

GET /api/v1/auth/providers/config

sovaria.api.auth.getProvidersConfig(): Promise<JsonValue>
Returns
Promise<JsonValue>
HTTP
GET /api/v1/auth/providers/config

sovaria.api.auth.getSessionsConfig

GET /api/v1/auth/sessions/config

sovaria.api.auth.getSessionsConfig(): Promise<JsonValue>
Returns
Promise<JsonValue>
HTTP
GET /api/v1/auth/sessions/config

sovaria.api.auth.listConsoleProductUsers

GET /api/v1/auth/product-users

sovaria.api.auth.listConsoleProductUsers(): Promise<JsonValue>
Returns
Promise<JsonValue>
HTTP
GET /api/v1/auth/product-users

sovaria.api.auth.listSessions

GET /api/v1/auth/sessions

sovaria.api.auth.listSessions(): Promise<JsonValue>
Returns
Promise<JsonValue>
HTTP
GET /api/v1/auth/sessions

sovaria.api.auth.revokeOtherSessions

POST /api/v1/auth/sessions/revoke-others

sovaria.api.auth.revokeOtherSessions(): Promise<JsonValue>
Returns
Promise<JsonValue>
HTTP
POST /api/v1/auth/sessions/revoke-others

sovaria.api.auth.revokeSession

DELETE /api/v1/auth/sessions/{session_id}

sovaria.api.auth.revokeSession(args: { sessionId: string }): Promise<JsonValue>

Parameters

args{ sessionId: string }required
Returns
Promise<JsonValue>
HTTP
DELETE /api/v1/auth/sessions/{…}

sovaria.api.auth.sendVerificationEmail

Trigger a verification email for the authenticated user.

sovaria.api.auth.sendVerificationEmail(): Promise<JsonValue>

POST /api/v1/auth/verify-email/send

Returns
Promise<JsonValue>
HTTP
POST /api/v1/auth/verify-email/send

sovaria.api.auth.updateProvidersConfig

PUT /api/v1/auth/providers/config

sovaria.api.auth.updateProvidersConfig(args: { body: JsonObject }): Promise<JsonValue>

Parameters

args{ body: JsonObject }required
Returns
Promise<JsonValue>
HTTP
PUT /api/v1/auth/providers/config

sovaria.api.auth.updateSessionsConfig

PUT /api/v1/auth/sessions/config

sovaria.api.auth.updateSessionsConfig(args: { body: JsonObject }): Promise<JsonValue>

Parameters

args{ body: JsonObject }required
Returns
Promise<JsonValue>
HTTP
PUT /api/v1/auth/sessions/config

sovaria.api.billing

sovaria.api.billing.buildInvoice

POST /api/v1/invoices/{org_id}/build

sovaria.api.billing.buildInvoice(
  args?: { orgId?: string; period?: JsonValue } = {},
): Promise<JsonValue>

Parameters

args{ orgId?: string; period?: JsonValue }optionaldefault {}
Returns
Promise<JsonValue>
HTTP
POST /api/v1/invoices/{…}/build

sovaria.api.billing.cancelAccount

POST /api/v1/accounts/{account_id}/cancel

sovaria.api.billing.cancelAccount(args: { accountId: string }): Promise<JsonValue>

Parameters

args{ accountId: string }required
Returns
Promise<JsonValue>
HTTP
POST /api/v1/accounts/{…}/cancel

sovaria.api.billing.checkout

POST /api/v1/billing/checkout

sovaria.api.billing.checkout(args: { body: JsonObject }): Promise<JsonValue>

Parameters

args{ body: JsonObject }required
Returns
Promise<JsonValue>
HTTP
POST /api/v1/billing/checkout

sovaria.api.billing.getAccount

GET /api/v1/accounts/{account_id}

sovaria.api.billing.getAccount(args: { accountId: string }): Promise<JsonValue>

Parameters

args{ accountId: string }required
Returns
Promise<JsonValue>
HTTP
GET /api/v1/accounts/{…}

sovaria.api.billing.getAccountOverage

GET /api/v1/billing/accounts/{account_id}/overage

sovaria.api.billing.getAccountOverage(args: { accountId: string }): Promise<JsonValue>

Parameters

args{ accountId: string }required
Returns
Promise<JsonValue>
HTTP
GET /api/v1/billing/accounts/{…}/overage

sovaria.api.billing.getAccountOveragePrefs

GET /api/v1/billing/accounts/{account_id}/overage-prefs

sovaria.api.billing.getAccountOveragePrefs(args: { accountId: string }): Promise<JsonValue>

Parameters

args{ accountId: string }required
Returns
Promise<JsonValue>
HTTP
GET /api/v1/billing/accounts/{…}/overage-prefs

sovaria.api.billing.getOrgOveragePrefs

The org's overage switches (one setting for the whole org) GET /api/v1/billing/orgs/{org_id}/overage-prefs

sovaria.api.billing.getOrgOveragePrefs(args?: { orgId?: string } = {}): Promise<JsonValue>

Parameters

args{ orgId?: string }optionaldefault {}
Returns
Promise<JsonValue>
HTTP
GET /api/v1/billing/orgs/{…}/overage-prefs

sovaria.api.billing.getCompute

GET /api/v1/compute/{org_id}

sovaria.api.billing.getCompute(
  args?: { orgId?: string; period?: JsonValue } = {},
): Promise<JsonValue>

Parameters

args{ orgId?: string; period?: JsonValue }optionaldefault {}
Returns
Promise<JsonValue>
HTTP
GET /api/v1/compute/{…}

sovaria.api.billing.getFx

GET /api/v1/billing/fx

sovaria.api.billing.getFx(): Promise<JsonValue>
Returns
Promise<JsonValue>
HTTP
GET /api/v1/billing/fx

sovaria.api.billing.getOpenInvoice

GET /api/v1/billing/invoices/open

sovaria.api.billing.getOpenInvoice(): Promise<JsonValue>
Returns
Promise<JsonValue>
HTTP
GET /api/v1/billing/invoices/open

sovaria.api.billing.getOverage

GET /api/v1/billing/overage/{org_id}

sovaria.api.billing.getOverage(args?: { orgId?: string } = {}): Promise<JsonValue>

Parameters

args{ orgId?: string }optionaldefault {}
Returns
Promise<JsonValue>
HTTP
GET /api/v1/billing/overage/{…}

sovaria.api.billing.getPlan

Fetch a billing plan by name.

sovaria.api.billing.getPlan(args: { name: string }): Promise<JsonValue>

GET /api/v1/plans/{name}

Parameters

args{ name: string }required
Returns
Promise<JsonValue>
HTTP
GET /api/v1/plans/{…}

sovaria.api.billing.getProvider

GET /api/v1/billing/provider

sovaria.api.billing.getProvider(): Promise<JsonValue>
Returns
Promise<JsonValue>
HTTP
GET /api/v1/billing/provider

sovaria.api.billing.getSubscription

Fetch the active subscription for an organisation.

sovaria.api.billing.getSubscription(args?: { orgId?: string } = {}): Promise<JsonValue>

GET /api/v1/subscriptions/{org_id}

Parameters

args{ orgId?: string }optionaldefault {}
Returns
Promise<JsonValue>
HTTP
GET /api/v1/subscriptions/{…}

sovaria.api.billing.getUsage

Fetch usage counters for an organisation.

sovaria.api.billing.getUsage(
  args?: { orgId?: string; period?: JsonValue } = {},
): Promise<JsonValue>

GET /api/v1/usage/{org_id}

Parameters

args{ orgId?: string; period?: JsonValue }optionaldefault {}
Returns
Promise<JsonValue>
HTTP
GET /api/v1/usage/{…}

sovaria.api.billing.getUsageHistory

Fetch historical usage for an organisation.

sovaria.api.billing.getUsageHistory(
  args?: { orgId?: string; months?: JsonValue } = {},
): Promise<JsonValue>

GET /api/v1/usage/{org_id}/history

Parameters

args{ orgId?: string; months?: JsonValue }optionaldefault {}
Returns
Promise<JsonValue>
HTTP
GET /api/v1/usage/{…}/history

sovaria.api.billing.listInvoices

GET /api/v1/invoices/{org_id}

sovaria.api.billing.listInvoices(args?: { orgId?: string } = {}): Promise<JsonValue>

Parameters

args{ orgId?: string }optionaldefault {}
Returns
Promise<JsonValue>
HTTP
GET /api/v1/invoices/{…}

sovaria.api.billing.listPlans

List public billing plans.

sovaria.api.billing.listPlans(): Promise<JsonValue>

GET /api/v1/plans

Returns
Promise<JsonValue>
HTTP
GET /api/v1/plans

sovaria.api.billing.listSubscriptions

List subscriptions visible to the authenticated caller.

sovaria.api.billing.listSubscriptions(): Promise<JsonValue>

GET /api/v1/subscriptions

Returns
Promise<JsonValue>
HTTP
GET /api/v1/subscriptions

sovaria.api.billing.payInvoice

POST /api/v1/billing/invoices/{org_id}/{period}/pay

sovaria.api.billing.payInvoice(args: { orgId?: string; period: string }): Promise<JsonValue>

Parameters

args{ orgId?: string; period: string }required
Returns
Promise<JsonValue>
HTTP
POST /api/v1/billing/invoices/{…}/{…}/pay

sovaria.api.billing.razorpayCreateOrder

POST /api/v1/billing/razorpay/create-order

sovaria.api.billing.razorpayCreateOrder(args: { body: JsonObject }): Promise<JsonValue>

Parameters

args{ body: JsonObject }required
Returns
Promise<JsonValue>
HTTP
POST /api/v1/billing/razorpay/create-order

sovaria.api.billing.razorpayVerifyPayment

POST /api/v1/billing/razorpay/verify-payment

sovaria.api.billing.razorpayVerifyPayment(args: { body: JsonObject }): Promise<JsonValue>

Parameters

args{ body: JsonObject }required
Returns
Promise<JsonValue>
HTTP
POST /api/v1/billing/razorpay/verify-payment

sovaria.api.billing.resumeAccount

POST /api/v1/accounts/{account_id}/resume

sovaria.api.billing.resumeAccount(args: { accountId: string }): Promise<JsonValue>

Parameters

args{ accountId: string }required
Returns
Promise<JsonValue>
HTTP
POST /api/v1/accounts/{…}/resume

sovaria.api.billing.setAccountOveragePrefs

PUT /api/v1/billing/accounts/{account_id}/overage-prefs

sovaria.api.billing.setAccountOveragePrefs(
  args: { accountId: string; services: JsonValue },
): Promise<JsonValue>

Parameters

args{ accountId: string; services: JsonValue }required
Returns
Promise<JsonValue>
HTTP
PUT /api/v1/billing/accounts/{…}/overage-prefs

sovaria.api.billing.setOrgOveragePrefs

Change the org's overage switches (org owners and admins) PUT /api/v1/billing/orgs/{org_id}/overage-prefs

sovaria.api.billing.setOrgOveragePrefs(
  args: { orgId?: string; services: JsonValue },
): Promise<JsonValue>

Parameters

args{ orgId?: string; services: JsonValue }required
Returns
Promise<JsonValue>
HTTP
PUT /api/v1/billing/orgs/{…}/overage-prefs

sovaria.api.data

sovaria.api.data.addColumn

Add a column to an existing table.

sovaria.api.data.addColumn(
  args: { tableName: JsonValue; columnName: JsonValue; dataType: JsonValue; isNullable?: JsonValue; isUnique?: JsonValue; defaultValue?: JsonValue },
): Promise<JsonValue>

POST /api/v1/data/rel/column/add

Parameters

args{ tableName: JsonValue; columnName: JsonValue; dataType: JsonValue; isNullable?: JsonValue; isUnique?: JsonValue; defaultValue?: JsonValue }required
Returns
Promise<JsonValue>
HTTP
POST /api/v1/data/rel/column/add

sovaria.api.data.addForeignKey

Add a foreign-key relation.

sovaria.api.data.addForeignKey(
  args: { tableName: JsonValue; columnName: JsonValue; referencedTable: JsonValue; referencedColumn: JsonValue },
): Promise<JsonValue>

POST /api/v1/data/rel/foreign-key/add

Parameters

args{ tableName: JsonValue; columnName: JsonValue; referencedTable: JsonValue; referencedColumn: JsonValue }required
Returns
Promise<JsonValue>
HTTP
POST /api/v1/data/rel/foreign-key/add

sovaria.api.data.beginTransaction

Start a table transaction and receive tx/snapshot IDs.

sovaria.api.data.beginTransaction(): Promise<JsonValue>

POST /api/v1/data/rel/transaction/begin

Returns
Promise<JsonValue>
HTTP
POST /api/v1/data/rel/transaction/begin

sovaria.api.data.commitTransaction

Commit a previously opened table transaction.

sovaria.api.data.commitTransaction(args: { txid: JsonValue }): Promise<JsonValue>

POST /api/v1/data/rel/transaction/commit

Parameters

args{ txid: JsonValue }required
Returns
Promise<JsonValue>
HTTP
POST /api/v1/data/rel/transaction/commit

sovaria.api.data.dropColumn

Drop a column from a table.

sovaria.api.data.dropColumn(
  args: { tableName: JsonValue; columnName: JsonValue },
): Promise<JsonValue>

POST /api/v1/data/rel/column/drop

Parameters

args{ tableName: JsonValue; columnName: JsonValue }required
Returns
Promise<JsonValue>
HTTP
POST /api/v1/data/rel/column/drop

sovaria.api.data.dropForeignKey

Drop a foreign-key relation.

sovaria.api.data.dropForeignKey(
  args: { tableName: JsonValue; columnName: JsonValue; referencedTable: JsonValue; referencedColumn: JsonValue },
): Promise<JsonValue>

POST /api/v1/data/rel/foreign-key/drop

Parameters

args{ tableName: JsonValue; columnName: JsonValue; referencedTable: JsonValue; referencedColumn: JsonValue }required
Returns
Promise<JsonValue>
HTTP
POST /api/v1/data/rel/foreign-key/drop

sovaria.api.data.dropTable

Drop a relational table.

sovaria.api.data.dropTable(args: { tableName: JsonValue }): Promise<JsonValue>

POST /api/v1/data/rel/drop

Parameters

args{ tableName: JsonValue }required
Returns
Promise<JsonValue>
HTTP
POST /api/v1/data/rel/drop

sovaria.api.data.rollbackTransaction

POST /api/v1/data/rel/transaction/rollback

sovaria.api.data.rollbackTransaction(args: { txid: JsonValue }): Promise<JsonValue>

Parameters

args{ txid: JsonValue }required
Returns
Promise<JsonValue>
HTTP
POST /api/v1/data/rel/transaction/rollback

sovaria.api.e2ee

sovaria.api.e2ee.bootstrapKey

Create (or fetch) the active e2ee channel key.

sovaria.api.e2ee.bootstrapKey(
  args: { channel: JsonValue; ttlSeconds?: JsonValue; forceNew?: JsonValue },
): Promise<JsonValue>

POST /api/v1/rt/e2ee/keys/bootstrap

Parameters

args{ channel: JsonValue; ttlSeconds?: JsonValue; forceNew?: JsonValue }required
Returns
Promise<JsonValue>
HTTP
POST /api/v1/rt/e2ee/keys/bootstrap

sovaria.api.e2ee.getActiveKey

Get the active e2ee key for a channel, wrapped for `client_public_key

sovaria.api.e2ee.getActiveKey(
  args: { channel: string; clientPublicKey?: JsonValue },
): Promise<JsonValue>

GET /api/v1/rt/e2ee/keys/active/{channel}

Parameters

args{ channel: string; clientPublicKey?: JsonValue }required
Returns
Promise<JsonValue>
HTTP
GET /api/v1/rt/e2ee/keys/active/{…}

sovaria.api.e2ee.getKey

Get key material by channel/key_id, wrapped for `client_public_key

sovaria.api.e2ee.getKey(
  args: { channel: string; keyId: string; clientPublicKey?: JsonValue },
): Promise<JsonValue>

GET /api/v1/rt/e2ee/keys/{channel}/{key_id}

Parameters

args{ channel: string; keyId: string; clientPublicKey?: JsonValue }required
Returns
Promise<JsonValue>
HTTP
GET /api/v1/rt/e2ee/keys/{…}/{…}

sovaria.api.e2ee.listKeys

List key metadata for a channel.

sovaria.api.e2ee.listKeys(args: { channel: string }): Promise<JsonValue>

GET /api/v1/rt/e2ee/keys/{channel}

Parameters

args{ channel: string }required
Returns
Promise<JsonValue>
HTTP
GET /api/v1/rt/e2ee/keys/{…}

sovaria.api.e2ee.revokeKey

Revoke an active or historical channel key.

sovaria.api.e2ee.revokeKey(
  args: { channel: JsonValue; keyId?: JsonValue; reason?: JsonValue },
): Promise<JsonValue>

POST /api/v1/rt/e2ee/keys/revoke

Parameters

args{ channel: JsonValue; keyId?: JsonValue; reason?: JsonValue }required
Returns
Promise<JsonValue>
HTTP
POST /api/v1/rt/e2ee/keys/revoke

sovaria.api.e2ee.rotateKey

Rotate e2ee key material for a channel.

sovaria.api.e2ee.rotateKey(
  args: { channel: JsonValue; ttlSeconds?: JsonValue },
): Promise<JsonValue>

POST /api/v1/rt/e2ee/keys/rotate

Parameters

args{ channel: JsonValue; ttlSeconds?: JsonValue }required
Returns
Promise<JsonValue>
HTTP
POST /api/v1/rt/e2ee/keys/rotate

sovaria.api.functions

sovaria.api.functions.delete

DELETE /api/v1/fn/functions/{function_name}

sovaria.api.functions.delete(args: { functionName: string }): Promise<JsonValue>

Parameters

args{ functionName: string }required
Returns
Promise<JsonValue>
HTTP
DELETE /api/v1/fn/functions/{…}

sovaria.api.functions.get

GET /api/v1/fn/functions/{function_name}

sovaria.api.functions.get(
  args: { functionName: string; projectId?: JsonValue },
): Promise<JsonValue>

Parameters

args{ functionName: string; projectId?: JsonValue }required
Returns
Promise<JsonValue>
HTTP
GET /api/v1/fn/functions/{…}

sovaria.api.functions.getBindings

GET /api/v1/fn/functions/{function_name}/bindings

sovaria.api.functions.getBindings(args: { functionName: string }): Promise<JsonValue>

Parameters

args{ functionName: string }required
Returns
Promise<JsonValue>
HTTP
GET /api/v1/fn/functions/{…}/bindings

sovaria.api.functions.getPolicy

GET /api/v1/fn/functions/{function_name}/policy

sovaria.api.functions.getPolicy(args: { functionName: string }): Promise<JsonValue>

Parameters

args{ functionName: string }required
Returns
Promise<JsonValue>
HTTP
GET /api/v1/fn/functions/{…}/policy

sovaria.api.functions.getSource

GET /api/v1/fn/functions/{function_name}/source

sovaria.api.functions.getSource(
  args: { functionName: string; projectId?: JsonValue },
): Promise<JsonValue>

Parameters

args{ functionName: string; projectId?: JsonValue }required
Returns
Promise<JsonValue>
HTTP
GET /api/v1/fn/functions/{…}/source

sovaria.api.functions.githubCommit

POST /api/v1/fn/github/commit

sovaria.api.functions.githubCommit(args: { body: JsonObject }): Promise<JsonValue>

Parameters

args{ body: JsonObject }required
Returns
Promise<JsonValue>
HTTP
POST /api/v1/fn/github/commit

sovaria.api.functions.githubImport

POST /api/v1/fn/github/import

sovaria.api.functions.githubImport(args: { body: JsonObject }): Promise<JsonValue>

Parameters

args{ body: JsonObject }required
Returns
Promise<JsonValue>
HTTP
POST /api/v1/fn/github/import

sovaria.api.functions.invocationStatus

Get status for an async Forge invocation id.

sovaria.api.functions.invocationStatus(
  args: { invocationId: string; projectId?: JsonValue },
): Promise<JsonValue>

GET /api/v1/fn/invocations/{invocation_id}

Parameters

args{ invocationId: string; projectId?: JsonValue }required
Returns
Promise<JsonValue>
HTTP
GET /api/v1/fn/invocations/{…}

sovaria.api.functions.list

List Forge functions with active version and queue summary.

sovaria.api.functions.list(
  args?: { projectId?: JsonValue; limit?: JsonValue; offset?: JsonValue } = {},
): Promise<JsonValue>

GET /api/v1/fn/functions

Parameters

args{ projectId?: JsonValue; limit?: JsonValue; offset?: JsonValue }optionaldefault {}
Returns
Promise<JsonValue>
HTTP
GET /api/v1/fn/functions

sovaria.api.functions.simulationDiff

Diff two simulation invocation outputs.

sovaria.api.functions.simulationDiff(
  args: { functionName: string; projectId?: JsonValue; leftInvocationId?: JsonValue; rightInvocationId?: JsonValue },
): Promise<JsonValue>

GET /api/v1/fn/{function_name}/history/simulation-diff

Parameters

args{ functionName: string; projectId?: JsonValue; leftInvocationId?: JsonValue; rightInvocationId?: JsonValue }required
Returns
Promise<JsonValue>
HTTP
GET /api/v1/fn/{…}/history/simulation-diff

sovaria.api.functions.status

Get forge deployment status by deploy id.

sovaria.api.functions.status(
  args: { deployId: string; projectId?: JsonValue },
): Promise<JsonValue>

GET /api/v1/fn/{deploy_id}/status

Parameters

args{ deployId: string; projectId?: JsonValue }required
Returns
Promise<JsonValue>
HTTP
GET /api/v1/fn/{…}/status

sovaria.api.functions.update

PATCH /api/v1/fn/functions/{function_name}

sovaria.api.functions.update(
  args: { functionName: string; body: JsonObject; projectId?: JsonValue },
): Promise<JsonValue>

Parameters

args{ functionName: string; body: JsonObject; projectId?: JsonValue }required
Returns
Promise<JsonValue>
HTTP
PATCH /api/v1/fn/functions/{…}

sovaria.api.functions.updateBindings

PUT /api/v1/fn/functions/{function_name}/bindings

sovaria.api.functions.updateBindings(
  args: { functionName: string; bindings: JsonValue },
): Promise<JsonValue>

Parameters

args{ functionName: string; bindings: JsonValue }required
Returns
Promise<JsonValue>
HTTP
PUT /api/v1/fn/functions/{…}/bindings

sovaria.api.functions.updatePolicy

PUT /api/v1/fn/functions/{function_name}/policy

sovaria.api.functions.updatePolicy(
  args: { functionName: string; policy: JsonObject },
): Promise<JsonValue>

Parameters

args{ functionName: string; policy: JsonObject }required
Returns
Promise<JsonValue>
HTTP
PUT /api/v1/fn/functions/{…}/policy

sovaria.api.functions.versions

List deployment versions for a Forge function.

sovaria.api.functions.versions(
  args: { functionName: string; projectId?: JsonValue; limit?: JsonValue; offset?: JsonValue },
): Promise<JsonValue>

GET /api/v1/fn/{function_name}/versions

Parameters

args{ functionName: string; projectId?: JsonValue; limit?: JsonValue; offset?: JsonValue }required
Returns
Promise<JsonValue>
HTTP
GET /api/v1/fn/{…}/versions

sovaria.api.governance

sovaria.api.governance.adminDatabases

GET /api/v1/governance/admin/databases

sovaria.api.governance.adminDatabases(): Promise<JsonValue>
Returns
Promise<JsonValue>
HTTP
GET /api/v1/governance/admin/databases

sovaria.api.governance.getTenant

GET /api/v1/governance/tenants/{org_id}

sovaria.api.governance.getTenant(args?: { orgId?: string } = {}): Promise<JsonValue>

Parameters

args{ orgId?: string }optionaldefault {}
Returns
Promise<JsonValue>
HTTP
GET /api/v1/governance/tenants/{…}

sovaria.api.governance.getTenantDatabaseConnection

GET /api/v1/governance/tenants/{org_id}/databases/{project_id}/connection

sovaria.api.governance.getTenantDatabaseConnection(
  args?: { orgId?: string; projectId?: string } = {},
): Promise<JsonValue>

Parameters

args{ orgId?: string; projectId?: string }optionaldefault {}
Returns
Promise<JsonValue>
HTTP
GET /api/v1/governance/tenants/{…}/databases/{…}/connection

sovaria.api.governance.listHosts

GET /api/v1/governance/hosts

sovaria.api.governance.listHosts(args?: { regionId?: JsonValue } = {}): Promise<JsonValue>

Parameters

args{ regionId?: JsonValue }optionaldefault {}
Returns
Promise<JsonValue>
HTTP
GET /api/v1/governance/hosts

sovaria.api.governance.listRegions

GET /api/v1/governance/regions

sovaria.api.governance.listRegions(): Promise<JsonValue>
Returns
Promise<JsonValue>
HTTP
GET /api/v1/governance/regions

sovaria.api.governance.listTenantDatabaseBackups

GET /api/v1/governance/tenants/{org_id}/databases/{project_id}/backups

sovaria.api.governance.listTenantDatabaseBackups(
  args?: { orgId?: string; projectId?: string; limit?: JsonValue } = {},
): Promise<JsonValue>

Parameters

args{ orgId?: string; projectId?: string; limit?: JsonValue }optionaldefault {}
Returns
Promise<JsonValue>
HTTP
GET /api/v1/governance/tenants/{…}/databases/{…}/backups

sovaria.api.governance.listTenantDatabases

GET /api/v1/governance/tenants/{org_id}/databases

sovaria.api.governance.listTenantDatabases(args?: { orgId?: string } = {}): Promise<JsonValue>

Parameters

args{ orgId?: string }optionaldefault {}
Returns
Promise<JsonValue>
HTTP
GET /api/v1/governance/tenants/{…}/databases

sovaria.api.governance.listTenants

GET /api/v1/governance/tenants

sovaria.api.governance.listTenants(): Promise<JsonValue>
Returns
Promise<JsonValue>
HTTP
GET /api/v1/governance/tenants

sovaria.api.governance.metricsOverview

GET /api/v1/governance/metrics/overview

sovaria.api.governance.metricsOverview(): Promise<JsonValue>
Returns
Promise<JsonValue>
HTTP
GET /api/v1/governance/metrics/overview

sovaria.api.governance.patchHost

PATCH /api/v1/governance/hosts/{host_id}

sovaria.api.governance.patchHost(args: { hostId: string; body: JsonObject }): Promise<JsonValue>

Parameters

args{ hostId: string; body: JsonObject }required
Returns
Promise<JsonValue>
HTTP
PATCH /api/v1/governance/hosts/{…}

sovaria.api.governance.patchRegion

PATCH /api/v1/governance/regions/{region_id}

sovaria.api.governance.patchRegion(
  args: { regionId: string; body: JsonObject },
): Promise<JsonValue>

Parameters

args{ regionId: string; body: JsonObject }required
Returns
Promise<JsonValue>
HTTP
PATCH /api/v1/governance/regions/{…}

sovaria.api.governance.pauseTenantDatabase

POST /api/v1/governance/tenants/{org_id}/databases/{project_id}/pause

sovaria.api.governance.pauseTenantDatabase(
  args?: { orgId?: string; projectId?: string } = {},
): Promise<JsonValue>

Parameters

args{ orgId?: string; projectId?: string }optionaldefault {}
Returns
Promise<JsonValue>
HTTP
POST /api/v1/governance/tenants/{…}/databases/{…}/pause

sovaria.api.governance.resizeTenantDatabase

POST /api/v1/governance/tenants/{org_id}/databases/{project_id}/resize

sovaria.api.governance.resizeTenantDatabase(
  args: { orgId?: string; projectId?: string; computeSize: JsonValue },
): Promise<JsonValue>

Parameters

args{ orgId?: string; projectId?: string; computeSize: JsonValue }required
Returns
Promise<JsonValue>
HTTP
POST /api/v1/governance/tenants/{…}/databases/{…}/resize

sovaria.api.governance.resumeTenantDatabase

POST /api/v1/governance/tenants/{org_id}/databases/{project_id}/resume

sovaria.api.governance.resumeTenantDatabase(
  args?: { orgId?: string; projectId?: string } = {},
): Promise<JsonValue>

Parameters

args{ orgId?: string; projectId?: string }optionaldefault {}
Returns
Promise<JsonValue>
HTTP
POST /api/v1/governance/tenants/{…}/databases/{…}/resume

sovaria.api.governance.revealTenantDatabaseConnection

POST /api/v1/governance/tenants/{org_id}/databases/{project_id}/connection/reveal

sovaria.api.governance.revealTenantDatabaseConnection(
  args?: { orgId?: string; projectId?: string } = {},
): Promise<JsonValue>

Parameters

args{ orgId?: string; projectId?: string }optionaldefault {}
Returns
Promise<JsonValue>
HTTP
POST /api/v1/governance/tenants/{…}/databases/{…}/connection/reveal

sovaria.api.governance.setTenantStatus

POST /api/v1/governance/tenants/{org_id}/status

sovaria.api.governance.setTenantStatus(
  args: { orgId?: string; status: JsonValue },
): Promise<JsonValue>

Parameters

args{ orgId?: string; status: JsonValue }required
Returns
Promise<JsonValue>
HTTP
POST /api/v1/governance/tenants/{…}/status

sovaria.api.governance.triggerTenantDatabaseBackup

POST /api/v1/governance/tenants/{org_id}/databases/{project_id}/backups

sovaria.api.governance.triggerTenantDatabaseBackup(
  args?: { orgId?: string; projectId?: string } = {},
): Promise<JsonValue>

Parameters

args{ orgId?: string; projectId?: string }optionaldefault {}
Returns
Promise<JsonValue>
HTTP
POST /api/v1/governance/tenants/{…}/databases/{…}/backups

sovaria.api.history

sovaria.api.history.commit

Create a Chrono commit.

sovaria.api.history.commit(
  args?: { timeline?: JsonValue; message?: JsonValue; author?: JsonValue; eventType?: JsonValue } = {},
): Promise<JsonValue>

POST /api/v1/chrono/commit

Parameters

args{ timeline?: JsonValue; message?: JsonValue; author?: JsonValue; eventType?: JsonValue }optionaldefault {}
Returns
Promise<JsonValue>
HTTP
POST /api/v1/chrono/commit

sovaria.api.history.converge

Converge source timeline into target timeline.

sovaria.api.history.converge(
  args?: { target?: JsonValue; source?: JsonValue; author?: JsonValue; message?: JsonValue } = {},
): Promise<JsonValue>

POST /api/v1/chrono/timelines/converge

Parameters

args{ target?: JsonValue; source?: JsonValue; author?: JsonValue; message?: JsonValue }optionaldefault {}
Returns
Promise<JsonValue>
HTTP
POST /api/v1/chrono/timelines/converge

sovaria.api.history.createSnapshot

Create a system snapshot.

sovaria.api.history.createSnapshot(args: { message: JsonValue }): Promise<JsonValue>

POST /api/v1/chrono/snapshots/create

Parameters

args{ message: JsonValue }required
Returns
Promise<JsonValue>
HTTP
POST /api/v1/chrono/snapshots/create

sovaria.api.history.deleteTimeline

Delete a timeline.

sovaria.api.history.deleteTimeline(args: { name: string }): Promise<JsonValue>

DELETE /api/v1/chrono/timelines/{name}

Parameters

args{ name: string }required
Returns
Promise<JsonValue>
HTTP
DELETE /api/v1/chrono/timelines/{…}

sovaria.api.history.jumpTimeline

Force-jump a timeline head.

sovaria.api.history.jumpTimeline(
  args: { name: string; targetHex: JsonValue },
): Promise<JsonValue>

POST /api/v1/chrono/timelines/{name}/jump

Parameters

args{ name: string; targetHex: JsonValue }required
Returns
Promise<JsonValue>
HTTP
POST /api/v1/chrono/timelines/{…}/jump

sovaria.api.history.listSnapshots

List known snapshots.

sovaria.api.history.listSnapshots(): Promise<JsonValue>

GET /api/v1/chrono/snapshots

Returns
Promise<JsonValue>
HTTP
GET /api/v1/chrono/snapshots

sovaria.api.history.listTimelines

List available timelines.

sovaria.api.history.listTimelines(): Promise<JsonValue>

GET /api/v1/chrono/timelines

Returns
Promise<JsonValue>
HTTP
GET /api/v1/chrono/timelines

sovaria.api.history.restoreSnapshot

Restore a snapshot by id.

sovaria.api.history.restoreSnapshot(args: { snapshotId: string }): Promise<JsonValue>

POST /api/v1/chrono/snapshots/{snapshot_id}/restore

Parameters

args{ snapshotId: string }required
Returns
Promise<JsonValue>
HTTP
POST /api/v1/chrono/snapshots/{…}/restore

sovaria.api.history.spawnTimeline

Spawn a new timeline from a source chronon.

sovaria.api.history.spawnTimeline(
  args?: { name?: JsonValue; sourceHexId?: JsonValue } = {},
): Promise<JsonValue>

POST /api/v1/chrono/timelines/spawn

Parameters

args{ name?: JsonValue; sourceHexId?: JsonValue }optionaldefault {}
Returns
Promise<JsonValue>
HTTP
POST /api/v1/chrono/timelines/spawn

sovaria.api.history.timelineHistory

Fetch timeline history chronons.

sovaria.api.history.timelineHistory(
  args: { name: string; limit?: JsonValue; offset?: JsonValue },
): Promise<JsonValue>

GET /api/v1/chrono/timelines/{name}/history

Parameters

args{ name: string; limit?: JsonValue; offset?: JsonValue }required
Returns
Promise<JsonValue>
HTTP
GET /api/v1/chrono/timelines/{…}/history

sovaria.api.history.topology

Return timeline graph topology.

sovaria.api.history.topology(
  args?: { timeline?: JsonValue; limit?: JsonValue } = {},
): Promise<JsonValue>

GET /api/v1/chrono/timelines/topology

Parameters

args{ timeline?: JsonValue; limit?: JsonValue }optionaldefault {}
Returns
Promise<JsonValue>
HTTP
GET /api/v1/chrono/timelines/topology

sovaria.api.history.variance

Calculate variance between two chronons.

sovaria.api.history.variance(
  args?: { oldChrononHex?: JsonValue; newChrononHex?: JsonValue; domainFilter?: JsonValue } = {},
): Promise<JsonValue>

POST /api/v1/chrono/variance

Parameters

args{ oldChrononHex?: JsonValue; newChrononHex?: JsonValue; domainFilter?: JsonValue }optionaldefault {}
Returns
Promise<JsonValue>
HTTP
POST /api/v1/chrono/variance

sovaria.api.org

sovaria.api.org.acceptOrgInvite

POST /api/v1/org/invites/accept

sovaria.api.org.acceptOrgInvite(args: { token: JsonValue }): Promise<JsonValue>

Parameters

args{ token: JsonValue }required
Returns
Promise<JsonValue>
HTTP
POST /api/v1/org/invites/accept

sovaria.api.org.addMember

Add a user as a member of an org/project node.

sovaria.api.org.addMember(
  args: { orgId?: string; userId: JsonValue; role?: JsonValue },
): Promise<JsonValue>

POST /api/v1/org/{org_id}/member

Parameters

args{ orgId?: string; userId: JsonValue; role?: JsonValue }required
Returns
Promise<JsonValue>
HTTP
POST /api/v1/org/{…}/member

sovaria.api.org.createEdge

Connect two DAPG nodes with a typed relationship.

sovaria.api.org.createEdge(
  args: { sourceNodeId: JsonValue; targetNodeId: JsonValue; relationType: JsonValue; role?: JsonValue },
): Promise<JsonValue>

POST /api/v1/edge

Parameters

args{ sourceNodeId: JsonValue; targetNodeId: JsonValue; relationType: JsonValue; role?: JsonValue }required
Returns
Promise<JsonValue>
HTTP
POST /api/v1/edge

sovaria.api.org.createOrgInvite

POST /api/v1/org/{org_id}/invites

sovaria.api.org.createOrgInvite(
  args: { orgId?: string; email: JsonValue; role: JsonValue },
): Promise<JsonValue>

Parameters

args{ orgId?: string; email: JsonValue; role: JsonValue }required
Returns
Promise<JsonValue>
HTTP
POST /api/v1/org/{…}/invites

sovaria.api.org.deleteOrg

DELETE /api/v1/org/{org_id}

sovaria.api.org.deleteOrg(args?: { orgId?: string } = {}): Promise<JsonValue>

Parameters

args{ orgId?: string }optionaldefault {}
Returns
Promise<JsonValue>
HTTP
DELETE /api/v1/org/{…}

sovaria.api.org.ensureDefaultApiKeys

POST /api/v1/apikeys/ensure-defaults

sovaria.api.org.ensureDefaultApiKeys(): Promise<JsonValue>
Returns
Promise<JsonValue>
HTTP
POST /api/v1/apikeys/ensure-defaults

sovaria.api.org.getChildren

List child nodes attached by a relation (e.g.

sovaria.api.org.getChildren(
  args: { parentId: string; relation?: JsonValue },
): Promise<JsonValue>

OWNS, HAS_ENV). GET /api/v1/org/{parent_id}/children

Parameters

args{ parentId: string; relation?: JsonValue }required
Returns
Promise<JsonValue>
HTTP
GET /api/v1/org/{…}/children

sovaria.api.org.getContext

Resolve a user's roles on a resource by walking the DAPG.

sovaria.api.org.getContext(args: { userId: string; resourceId: string }): Promise<JsonValue>

GET /api/v1/context/{user_id}/{resource_id}

Parameters

args{ userId: string; resourceId: string }required
Returns
Promise<JsonValue>
HTTP
GET /api/v1/context/{…}/{…}

sovaria.api.org.getNode

Fetch a single graph node by ID.

sovaria.api.org.getNode(args: { nodeId: string }): Promise<JsonValue>

GET /api/v1/org/{node_id}

Parameters

args{ nodeId: string }required
Returns
Promise<JsonValue>
HTTP
GET /api/v1/org/{…}

sovaria.api.org.getProjectRef

GET /api/v1/org/{project_id}/ref

sovaria.api.org.getProjectRef(args?: { projectId?: string } = {}): Promise<JsonValue>

Parameters

args{ projectId?: string }optionaldefault {}
Returns
Promise<JsonValue>
HTTP
GET /api/v1/org/{…}/ref

sovaria.api.org.getProjectSettings

GET /api/v1/project-settings

sovaria.api.org.getProjectSettings(): Promise<JsonValue>
Returns
Promise<JsonValue>
HTTP
GET /api/v1/project-settings

sovaria.api.org.getRoleCatalog

GET /api/v1/roles/catalog

sovaria.api.org.getRoleCatalog(): Promise<JsonValue>
Returns
Promise<JsonValue>
HTTP
GET /api/v1/roles/catalog

sovaria.api.org.getRoleMatrix

GET /api/v1/roles/matrix

sovaria.api.org.getRoleMatrix(): Promise<JsonValue>
Returns
Promise<JsonValue>
HTTP
GET /api/v1/roles/matrix

sovaria.api.org.listApiKeys

GET /api/v1/apikeys

sovaria.api.org.listApiKeys(): Promise<JsonValue>
Returns
Promise<JsonValue>
HTTP
GET /api/v1/apikeys

sovaria.api.org.listNodes

List graph nodes; when provided, `node_type filters by type

sovaria.api.org.listNodes(args?: { nodeType?: JsonValue } = {}): Promise<JsonValue>

GET /api/v1/org

Parameters

args{ nodeType?: JsonValue }optionaldefault {}
Returns
Promise<JsonValue>
HTTP
GET /api/v1/org

sovaria.api.org.listOrgMembers

GET /api/v1/org/{org_id}/members

sovaria.api.org.listOrgMembers(args?: { orgId?: string } = {}): Promise<JsonValue>

Parameters

args{ orgId?: string }optionaldefault {}
Returns
Promise<JsonValue>
HTTP
GET /api/v1/org/{…}/members

sovaria.api.org.removeOrgMember

DELETE /api/v1/org/{org_id}/member/{user_id}

sovaria.api.org.removeOrgMember(args: { orgId?: string; userId: string }): Promise<JsonValue>

Parameters

args{ orgId?: string; userId: string }required
Returns
Promise<JsonValue>
HTTP
DELETE /api/v1/org/{…}/member/{…}

sovaria.api.org.revokeApiKey

DELETE /api/v1/apikeys/{key_id}

sovaria.api.org.revokeApiKey(args: { keyId: string }): Promise<JsonValue>

Parameters

args{ keyId: string }required
Returns
Promise<JsonValue>
HTTP
DELETE /api/v1/apikeys/{…}

sovaria.api.org.setOrgPlan

PUT /api/v1/org/{org_id}/plan

sovaria.api.org.setOrgPlan(args: { orgId?: string; plan: JsonValue }): Promise<JsonValue>

Parameters

args{ orgId?: string; plan: JsonValue }required
Returns
Promise<JsonValue>
HTTP
PUT /api/v1/org/{…}/plan

sovaria.api.org.updateMemberRole

PUT /api/v1/org/{org_id}/member/{user_id}

sovaria.api.org.updateMemberRole(
  args: { orgId?: string; userId: string; role: JsonValue },
): Promise<JsonValue>

Parameters

args{ orgId?: string; userId: string; role: JsonValue }required
Returns
Promise<JsonValue>
HTTP
PUT /api/v1/org/{…}/member/{…}

sovaria.api.org.updateOrg

PUT /api/v1/org/{org_id}

sovaria.api.org.updateOrg(args: { orgId?: string; body: JsonObject }): Promise<JsonValue>

Parameters

args{ orgId?: string; body: JsonObject }required
Returns
Promise<JsonValue>
HTTP
PUT /api/v1/org/{…}

sovaria.api.org.updateProjectSettings

PUT /api/v1/project-settings

sovaria.api.org.updateProjectSettings(args: { settings: JsonValue }): Promise<JsonValue>

Parameters

args{ settings: JsonValue }required
Returns
Promise<JsonValue>
HTTP
PUT /api/v1/project-settings

sovaria.api.org.updateRoleMatrix

PUT /api/v1/roles/matrix

sovaria.api.org.updateRoleMatrix(args: { matrix: JsonValue }): Promise<JsonValue>

Parameters

args{ matrix: JsonValue }required
Returns
Promise<JsonValue>
HTTP
PUT /api/v1/roles/matrix

sovaria.api.platform

sovaria.api.platform.createEventHook

POST /api/v1/auth/event-hooks

sovaria.api.platform.createEventHook(args: { body: JsonObject }): Promise<JsonValue>

Parameters

args{ body: JsonObject }required
Returns
Promise<JsonValue>
HTTP
POST /api/v1/auth/event-hooks

sovaria.api.platform.deleteEventHook

DELETE /api/v1/auth/event-hooks/{hook_id}

sovaria.api.platform.deleteEventHook(args: { hookId: string }): Promise<JsonValue>

Parameters

args{ hookId: string }required
Returns
Promise<JsonValue>
HTTP
DELETE /api/v1/auth/event-hooks/{…}

sovaria.api.platform.disconnectGithub

DELETE /api/v1/auth/github/connection-state

sovaria.api.platform.disconnectGithub(args?: { projectId?: JsonValue } = {}): Promise<JsonValue>

Parameters

args{ projectId?: JsonValue }optionaldefault {}
Returns
Promise<JsonValue>
HTTP
DELETE /api/v1/auth/github/connection-state

sovaria.api.platform.gatewayHealth

GET /healthz

sovaria.api.platform.gatewayHealth(): Promise<JsonValue>
Returns
Promise<JsonValue>
HTTP
GET /healthz

sovaria.api.platform.getEnginesHealth

Return aggregate gateway health for downstream engines.

sovaria.api.platform.getEnginesHealth(): Promise<JsonValue>

GET /api/v1/system/engines/health

Returns
Promise<JsonValue>
HTTP
GET /api/v1/system/engines/health

sovaria.api.platform.getErrorTrace

GET /api/v1/error-traces/{trace_id}

sovaria.api.platform.getErrorTrace(args: { traceId: string }): Promise<JsonValue>

Parameters

args{ traceId: string }required
Returns
Promise<JsonValue>
HTTP
GET /api/v1/error-traces/{…}

sovaria.api.platform.getGithubConnectionState

GET /api/v1/auth/github/connection-state

sovaria.api.platform.getGithubConnectionState(
  args?: { projectId?: JsonValue } = {},
): Promise<JsonValue>

Parameters

args{ projectId?: JsonValue }optionaldefault {}
Returns
Promise<JsonValue>
HTTP
GET /api/v1/auth/github/connection-state

sovaria.api.platform.listEventHooks

GET /api/v1/auth/event-hooks

sovaria.api.platform.listEventHooks(): Promise<JsonValue>
Returns
Promise<JsonValue>
HTTP
GET /api/v1/auth/event-hooks

sovaria.api.platform.resolveErrorTrace

PATCH /api/v1/error-traces/{trace_id}/resolved

sovaria.api.platform.resolveErrorTrace(
  args: { traceId: string; resolved: JsonValue },
): Promise<JsonValue>

Parameters

args{ traceId: string; resolved: JsonValue }required
Returns
Promise<JsonValue>
HTTP
PATCH /api/v1/error-traces/{…}/resolved

sovaria.api.policy

sovaria.api.policy.auditCount

Return current audit-entry count.

sovaria.api.policy.auditCount(): Promise<JsonValue>

GET /api/v1/audit/count

Returns
Promise<JsonValue>
HTTP
GET /api/v1/audit/count

sovaria.api.policy.auditVerify

Verify audit hash-chain integrity.

sovaria.api.policy.auditVerify(): Promise<JsonValue>

GET /api/v1/audit/verify

Returns
Promise<JsonValue>
HTTP
GET /api/v1/audit/verify

sovaria.api.policy.policyCreate

Create and compile a policy.

sovaria.api.policy.policyCreate(
  args: { policyId: JsonValue; name: JsonValue; splSource: JsonValue; orgId: JsonValue },
): Promise<JsonValue>

POST /api/v1/policies/

Parameters

args{ policyId: JsonValue; name: JsonValue; splSource: JsonValue; orgId: JsonValue }required
Returns
Promise<JsonValue>
HTTP
POST /api/v1/policies/

sovaria.api.policy.policyDelete

Delete (deactivate) a policy.

sovaria.api.policy.policyDelete(args: { policyId: string }): Promise<JsonValue>

DELETE /api/v1/policies/{policy_id}

Parameters

args{ policyId: string }required
Returns
Promise<JsonValue>
HTTP
DELETE /api/v1/policies/{…}

sovaria.api.policy.policyEvaluate

Evaluate a policy against an explicit debug context.

sovaria.api.policy.policyEvaluate(
  args: { policyId: string; context: JsonValue },
): Promise<JsonValue>

POST /api/v1/policies/{policy_id}/evaluate

Parameters

args{ policyId: string; context: JsonValue }required
Returns
Promise<JsonValue>
HTTP
POST /api/v1/policies/{…}/evaluate

sovaria.api.policy.policyGet

Get a single policy by ID.

sovaria.api.policy.policyGet(args: { policyId: string }): Promise<JsonValue>

GET /api/v1/policies/{policy_id}

Parameters

args{ policyId: string }required
Returns
Promise<JsonValue>
HTTP
GET /api/v1/policies/{…}

sovaria.api.policy.policyHistory

Return version history for a policy.

sovaria.api.policy.policyHistory(args: { policyId: string }): Promise<JsonValue>

GET /api/v1/policies/{policy_id}/history

Parameters

args{ policyId: string }required
Returns
Promise<JsonValue>
HTTP
GET /api/v1/policies/{…}/history

sovaria.api.policy.policyList

List active policies visible in current tenant scope.

sovaria.api.policy.policyList(): Promise<JsonValue>

GET /api/v1/policies/

Returns
Promise<JsonValue>
HTTP
GET /api/v1/policies/

sovaria.api.policy.policyRollback

Rollback a policy to a historical version.

sovaria.api.policy.policyRollback(
  args: { policyId: string; version: JsonValue },
): Promise<JsonValue>

POST /api/v1/policies/{policy_id}/rollback

Parameters

args{ policyId: string; version: JsonValue }required
Returns
Promise<JsonValue>
HTTP
POST /api/v1/policies/{…}/rollback

sovaria.api.policy.policyTemplates

List server-authoritative SPL templates.

sovaria.api.policy.policyTemplates(): Promise<JsonValue>

GET /api/v1/policies/templates

Returns
Promise<JsonValue>
HTTP
GET /api/v1/policies/templates

sovaria.api.realtime

sovaria.api.realtime.channels

List active realtime channels.

sovaria.api.realtime.channels(): Promise<JsonValue>

GET /api/v1/rt/stream/channels

Returns
Promise<JsonValue>
HTTP
GET /api/v1/rt/stream/channels

sovaria.api.realtime.presence

Fetch presence for a realtime channel.

sovaria.api.realtime.presence(args: { channel: string }): Promise<JsonValue>

GET /api/v1/rt/stream/presence/{channel}

Parameters

args{ channel: string }required
Returns
Promise<JsonValue>
HTTP
GET /api/v1/rt/stream/presence/{…}

sovaria.api.realtime.replay

Replay events for a realtime channel.

sovaria.api.realtime.replay(
  args: { channel: string; after?: JsonValue; limit?: JsonValue },
): Promise<JsonValue>

GET /api/v1/rt/stream/replay/{channel}

Parameters

args{ channel: string; after?: JsonValue; limit?: JsonValue }required
Returns
Promise<JsonValue>
HTTP
GET /api/v1/rt/stream/replay/{…}

sovaria.api.realtime.subscribe

Subscribe a client ID to a realtime channel.

sovaria.api.realtime.subscribe(
  args: { channel: JsonValue; clientId: JsonValue },
): Promise<JsonValue>

POST /api/v1/rt/stream/subscribe

Parameters

args{ channel: JsonValue; clientId: JsonValue }required
Returns
Promise<JsonValue>
HTTP
POST /api/v1/rt/stream/subscribe

sovaria.api.realtime.unsubscribe

Unsubscribe a client ID from a realtime channel.

sovaria.api.realtime.unsubscribe(
  args: { channel: JsonValue; clientId: JsonValue },
): Promise<JsonValue>

POST /api/v1/rt/stream/unsubscribe

Parameters

args{ channel: JsonValue; clientId: JsonValue }required
Returns
Promise<JsonValue>
HTTP
POST /api/v1/rt/stream/unsubscribe

sovaria.api.simulation

sovaria.api.simulation.compareRuns

GET /api/v1/sim/runs/{target_run_id}/compare/{baseline_run_id}

sovaria.api.simulation.compareRuns(
  args: { targetRunId: string; baselineRunId: string },
): Promise<JsonValue>

Parameters

args{ targetRunId: string; baselineRunId: string }required
Returns
Promise<JsonValue>
HTTP
GET /api/v1/sim/runs/{…}/compare/{…}

sovaria.api.simulation.discover

POST /api/v1/sim/discover

sovaria.api.simulation.discover(): Promise<JsonValue>
Returns
Promise<JsonValue>
HTTP
POST /api/v1/sim/discover

sovaria.api.simulation.getRun

GET /api/v1/sim/runs/{run_id}

sovaria.api.simulation.getRun(args: { runId: string }): Promise<JsonValue>

Parameters

args{ runId: string }required
Returns
Promise<JsonValue>
HTTP
GET /api/v1/sim/runs/{…}

sovaria.api.simulation.listRuns

GET /api/v1/sim/runs

sovaria.api.simulation.listRuns(
  args?: { limit?: JsonValue; offset?: JsonValue } = {},
): Promise<JsonValue>

Parameters

args{ limit?: JsonValue; offset?: JsonValue }optionaldefault {}
Returns
Promise<JsonValue>
HTTP
GET /api/v1/sim/runs

sovaria.api.storage

sovaria.api.storage.createBucket

POST /api/v1/store/buckets

sovaria.api.storage.createBucket(args: { body: JsonObject }): Promise<JsonValue>

Parameters

args{ body: JsonObject }required
Returns
Promise<JsonValue>
HTTP
POST /api/v1/store/buckets

sovaria.api.storage.deleteBucket

DELETE /api/v1/store/buckets/{name}

sovaria.api.storage.deleteBucket(args: { name: string }): Promise<JsonValue>

Parameters

args{ name: string }required
Returns
Promise<JsonValue>
HTTP
DELETE /api/v1/store/buckets/{…}

sovaria.api.storage.getBucket

GET /api/v1/store/buckets/{name}

sovaria.api.storage.getBucket(args: { name: string }): Promise<JsonValue>

Parameters

args{ name: string }required
Returns
Promise<JsonValue>
HTTP
GET /api/v1/store/buckets/{…}

sovaria.api.storage.listBuckets

GET /api/v1/store/buckets

sovaria.api.storage.listBuckets(): Promise<JsonValue>
Returns
Promise<JsonValue>
HTTP
GET /api/v1/store/buckets

sovaria.api.storage.moveObject

POST /api/v1/store/objects/move

sovaria.api.storage.moveObject(
  args: { fromPath: JsonValue; toPath: JsonValue },
): Promise<JsonValue>

Parameters

args{ fromPath: JsonValue; toPath: JsonValue }required
Returns
Promise<JsonValue>
HTTP
POST /api/v1/store/objects/move

sovaria.api.storage.updateBucket

PATCH /api/v1/store/buckets/{name}

sovaria.api.storage.updateBucket(args: { name: string; body: JsonObject }): Promise<JsonValue>

Parameters

args{ name: string; body: JsonObject }required
Returns
Promise<JsonValue>
HTTP
PATCH /api/v1/store/buckets/{…}

sovaria.api.vector

sovaria.api.vector.deleteCollection

Delete an entire vector collection.

sovaria.api.vector.deleteCollection(args: { collection: string }): Promise<JsonValue>

DELETE /api/v1/collections/{collection}

Parameters

args{ collection: string }required
Returns
Promise<JsonValue>
HTTP
DELETE /api/v1/collections/{…}

sovaria.api.vector.deleteRecord

Delete a record from a vector collection.

sovaria.api.vector.deleteRecord(
  args: { collection: string; recordId: string },
): Promise<JsonValue>

DELETE /api/v1/collections/{collection}/records/{record_id}

Parameters

args{ collection: string; recordId: string }required
Returns
Promise<JsonValue>
HTTP
DELETE /api/v1/collections/{…}/records/{…}

sovaria.api.vector.embed

Generate embeddings for one or more texts.

sovaria.api.vector.embed(args: { texts: JsonValue }): Promise<JsonValue>

POST /api/v1/embed

Parameters

args{ texts: JsonValue }required
Returns
Promise<JsonValue>
HTTP
POST /api/v1/embed

sovaria.api.vector.listCollections

List vector collections in the current project scope.

sovaria.api.vector.listCollections(): Promise<JsonValue>

GET /api/v1/collections

Returns
Promise<JsonValue>
HTTP
GET /api/v1/collections

sovaria.api.vector.upsert

Embed and upsert documents into a vector collection.

sovaria.api.vector.upsert(args: { collection: JsonValue; docs: JsonValue }): Promise<JsonValue>

POST /api/v1/vectors/upsert

Parameters

args{ collection: JsonValue; docs: JsonValue }required
Returns
Promise<JsonValue>
HTTP
POST /api/v1/vectors/upsert

Related

JavaScript SDKHTTP API
Something unclear or missing on this page?Tell us