Sign in

v1

latestOpenAPI 3.1.0raw.githubusercontent.com2026-06-25173140700.7 KB
Settings

Update current tenant settings

Update the settings for the current user's tenant (tenant admin only).

patch/settings/current

Query parameters

cookie_namestring nullable
tenant_idinteger

Request body

default_llm_catalog_idinteger nullable

ID of the LLM catalog entry to use as the tenant default model. Must be a model enabled for the tenant.

guardrails_enabledboolean nullable

Whether input/output guardrails are applied to chat.

sharepoint_enabledboolean nullable

Whether the SharePoint integration is enabled for the tenant.

inbound_guardrailstring nullable

Identifier of the guardrail applied to inbound (user) messages.

outbound_guardrailstring nullable

Identifier of the guardrail applied to outbound (model) messages.

welcome_email_template_idinteger nullable

ID of the email template sent to new users on signup.

project_member_added_email_template_idinteger nullable

ID of the email template sent when a user is added to a project.

system_promptstring nullable

Tenant-wide system prompt prepended to chat conversations.

errlog_webhook_urlstring nullable

Webhook URL that receives error-log notifications.

require_email_confirmationboolean nullable

Whether new users must confirm their email. Superadmin-only field.

Example request

{
  "default_llm_catalog_id": 3,
  "guardrails_enabled": true,
  "inbound_guardrail": "default-inbound",
  "outbound_guardrail": "default-outbound",
  "welcome_email_template_id": 1,
  "project_member_added_email_template_id": 2,
  "system_prompt": "You are a helpful assistant for Acme Corp.",
  "errlog_webhook_url": "https://hooks.example.com/errlog",
  "require_email_confirmation": true
}

Response

Successful Response

idinteger nullable

Primary key for the tenant settings record.

tenant_idinteger required

ID of the tenant these settings belong to.

default_llm_catalog_idinteger nullable

ID of the default LLM catalog entry for the tenant.

created_atstring date-time

Timestamp when the settings record was created.

guardrails_enabledboolean

Whether guardrails are enabled for the tenant.

sharepoint_enabledboolean nullable required

Whether SharePoint integration is enabled for the tenant.

inbound_guardrailstring nullable

Identifier of the inbound guardrail policy applied to user input.

outbound_guardrailstring nullable

Identifier of the outbound guardrail policy applied to model output.

system_promptstring nullable

Tenant-wide default system prompt.

inserted_bystring nullable required

Marker indicating which process inserted the record (e.g. alembic).

errlog_webhook_urlstring nullable

Webhook URL for delivering error log notifications.

default_languagestring

Default language code for the tenant's emails.

require_email_confirmationboolean

Whether users must confirm their email before login.

Example response

{
  "id": 1,
  "tenant_id": 1,
  "default_llm_catalog_id": 1,
  "created_at": "2026-06-23T12:00:00Z",
  "sharepoint_enabled": true,
  "inbound_guardrail": "default-inbound",
  "outbound_guardrail": "default-outbound",
  "system_prompt": "You are a helpful assistant.",
  "inserted_by": "alembic",
  "errlog_webhook_url": "https://hooks.example.com/errors",
  "default_language": "en"
}