Skip to main content

Settings and organizations

Install settings​

Method and pathWhoWhat it does
GET /brandinganyone, no sign-inThe install's branding, which the sign-in page shows.
GET /localizationanyone, no sign-inThe console's languages and the install's default.
GET /settings/installplatform adminExternal providers (the Helm ceiling, the console switch and the result), branding and language, as stored.
PUT /settings/install/external-providersplatform admin{"enabled": true}, false, or null to follow the Helm value. Turning it on past the Helm ceiling answers 409 and names the value.
PUT /settings/install/brandingplatform admin{"product_name", "logo", "logo_dark", "primary_color"}. Logos are data: URLs (PNG, SVG, JPEG or WebP, up to 256 KB). The name is up to 40 characters, the colour #RRGGBB.
PUT /settings/install/localizationplatform admin{"default_locale": "ar"}: en, ar or fr.
GET /admin/voice-catalogplatform adminThe voices and speech models the install can add.
POST /admin/voice-catalog/seedplatform adminAdd voices and speech models to the catalog and build them.
GET /admin/systemplatform adminThe System page: version, component health, licence, NetworkPolicy and upgrade facts.

Organization settings​

Method and pathWhoWhat it does
GET /tenants/{tenant_id}/settingsorganization memberThe organization's settings.
PUT /tenants/{tenant_id}/settingsorganization admin or platform adminThe whole document: timezone (an IANA name), guardrail_profile_id, external_providers ("off" keeps the organization's projects in the cluster), allowed_models, and branding. A field left out or null follows the install.
PATCH /tenants/{tenant_id}organization admin or platform operatorRename or describe the organization.

Organizations in SaaS mode​

These routes are for platform operators on an install with tenancy.mode: saas. See Multi-tenancy.

Method and pathWhat it does
GET /platform/tenancyThe tenancy mode, the operator role, and the row-level security state.
GET /platform/tenantsEvery organization.
POST /platform/tenantsOnboard an organization, with its first admin and a first project.
POST /platform/tenants/{tenant_id}/suspendRefuse every member, key and agent of the organization.
POST /platform/tenants/{tenant_id}/resumeStop refusing them.
POST /platform/tenants/{tenant_id}/offboard{"confirm": "<tenant id>"}. For good: every personal, project and agent key of the organization is revoked.
DELETE /platform/tenants/{tenant_id}?confirm=<tenant id>Purge an offboarding organization's rows, then the organization.

A console user who belongs to several organizations chooses one per request with the X-Vois-Tenant header. The console's organization switcher sends it.

Was this page helpful?
On this page
Talk to our teamQuestions about licensing or sizing VoisX Orchestrate for your site? We can help.Talk to sales →