API Docs / Schemas / AiSettingsDto

AiSettingsDto

Configuration for AI/LLM integration settings at the tenant level.
Controls which AI model to use and whether to use a custom API key or the shared platform key.
Includes references to content blocks that provide context for AI-generated content in proposals and service schedules.

Properties

Name Type Description
useCustomKeyboolean

Whether to use a custom OpenAI API key instead of the shared platform key

Whether to use a custom OpenAI API key instead of the shared platform key

customKeystring

The custom OpenAI API key (only used if UseCustomKey is true)

The custom OpenAI API key (only used if UseCustomKey is true)

modelstring

The AI model identifier to use (e.g., "gpt-4", "gpt-3.5-turbo", or "default" for platform default)

The AI model identifier to use (e.g., "gpt-4", "gpt-3.5-turbo", or "default" for platform default)

useBritishEnglishboolean

Whether to use British English spelling and conventions in AI-generated content

Whether to use British English spelling and conventions in AI-generated content

contextenum

AccountancyPractice BookkeepingPractice

AccountancyPractice BookkeepingPractice

modelServicesScheduleContentCodeAndNameDto
modelProposalsContentCodeAndNameDto

JSON Example

{
  "useCustomKey": false,
  "customKey": "string",
  "model": "string",
  "useBritishEnglish": false,
  "context": "AccountancyPractice"
}

Used By Operations