API Docs / Schemas / UpdateAiSettingsRequest

UpdateAiSettingsRequest

Request DTO for updating AI settings for a tenant

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

modelServicesScheduleContentCodestring

Code of the content block that provides context/instructions for AI when generating service schedule descriptions

Code of the content block that provides context/instructions for AI when generating service schedule descriptions

modelProposalsContentCodestring

Code of the content block that provides context/instructions for AI when generating proposal content

Code of the content block that provides context/instructions for AI when generating proposal content

JSON Example

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

Used By Operations