> ## Documentation Index
> Fetch the complete documentation index at: https://docs.vellaro.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Update Chat Settings



## OpenAPI

````yaml https://api.vellaro.io/openapi/admin.json put /api/v1/admin/chat/settings
openapi: 3.1.0
info:
  title: Vellaro Admin API
  description: >-
    Store management under `/api/v1/admin`, for back ends and integrations.
    Every call takes `Authorization: Bearer <token>`: an admin API token or a
    staff user's token. The permissions of its role decide what it can do,
    always in its own store.
  version: 0.1.0
servers:
  - url: https://api.vellaro.io
    description: Produzione
security: []
tags:
  - name: Orders
    description: >-
      Orders and manual orders, payments, refunds, shipments, invoices, returns,
      customer subscriptions.
  - name: Products
    description: Products, variants, images, prices and discounts, product lookups.
  - name: Categories & catalog setup
    description: >-
      Categories, brands, attributes, options, filters, downloadable files,
      recurring profiles.
  - name: Inventory
    description: Stock of the variants and stock statuses.
  - name: Customers
    description: Customers, customer groups, custom fields.
  - name: Reviews & questions
    description: Moderation of product reviews and questions.
  - name: Promotions & coupons
    description: Coupons and gift vouchers.
  - name: Marketing
    description: Campaigns, newsletter subscribers, affiliates and their commissions.
  - name: Content
    description: >-
      CMS pages, menus, banners, information pages, flipbooks, media library,
      SEO URLs, email templates, translations.
  - name: Settings
    description: >-
      Store settings, email delivery, languages, currencies, physical stores,
      social login providers.
  - name: Shipping
    description: Couriers, shipping rates, weight and length classes.
  - name: Taxes & geo
    description: Tax classes, rates and rules; countries, zones and geo zones.
  - name: Integrations & modules
    description: >-
      Integrations, plugins and modules (Iute, extra warranty, Nextera, Financa
      5, WhatsApp, Firebase), outbound webhooks.
  - name: AI
    description: AI content generation and the settings of the AI shopping assistant.
  - name: Imports
    description: 'CSV imports and the universal import: runs, mappings, previews, undo.'
  - name: Reports & dashboard
    description: Dashboard figures and reports.
  - name: Users & API keys
    description: Staff users and roles, publishable keys, admin API tokens.
  - name: Audit
    description: The store's audit log.
paths:
  /api/v1/admin/chat/settings:
    put:
      tags:
        - AI
      summary: Update Chat Settings
      operationId: update_chat_settings_api_v1_admin_chat_settings_put
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ChatSettingsUpsert'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResponse_ChatSettingsOut_'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
        - HTTPBearer: []
components:
  schemas:
    ChatSettingsUpsert:
      properties:
        enabled:
          anyOf:
            - type: boolean
            - type: 'null'
          title: Enabled
        system_prompt_template:
          anyOf:
            - type: string
            - type: 'null'
          title: System Prompt Template
        brand_voice:
          anyOf:
            - type: string
              maxLength: 500
            - type: 'null'
          title: Brand Voice
        welcome_message:
          anyOf:
            - type: string
              maxLength: 500
            - type: 'null'
          title: Welcome Message
        welcome_message_i18n:
          anyOf:
            - additionalProperties:
                type: string
              type: object
            - type: 'null'
          title: Welcome Message I18N
        starter_prompts:
          anyOf:
            - items:
                type: string
              type: array
              maxItems: 8
            - type: 'null'
          title: Starter Prompts
        starter_prompts_i18n:
          anyOf:
            - additionalProperties:
                items:
                  type: string
                type: array
              type: object
            - type: 'null'
          title: Starter Prompts I18N
        excluded_category_ids:
          anyOf:
            - items:
                type: string
                format: uuid
              type: array
            - type: 'null'
          title: Excluded Category Ids
        banned_phrases:
          anyOf:
            - items:
                type: string
              type: array
              maxItems: 50
            - type: 'null'
          title: Banned Phrases
        primary_model_override:
          anyOf:
            - type: string
              maxLength: 120
            - type: 'null'
          title: Primary Model Override
        safety_model_override:
          anyOf:
            - type: string
              maxLength: 120
            - type: 'null'
          title: Safety Model Override
        embedding_provider:
          anyOf:
            - type: string
              maxLength: 40
            - type: 'null'
          title: Embedding Provider
        embedding_model:
          anyOf:
            - type: string
              maxLength: 80
            - type: 'null'
          title: Embedding Model
        embedding_api_key:
          anyOf:
            - type: string
              maxLength: 120
            - type: 'null'
          title: Embedding Api Key
        monthly_budget_cents:
          anyOf:
            - type: integer
              minimum: 0
            - type: 'null'
          title: Monthly Budget Cents
        rollout_percent:
          anyOf:
            - type: integer
              maximum: 100
              minimum: 0
            - type: 'null'
          title: Rollout Percent
          description: 'Deprecated: not applied'
      type: object
      title: ChatSettingsUpsert
      description: >-
        All fields optional — partial update (omitted = unchanged).


        INT-13: null (or "") CLEARS the nullable text fields — prompt, brand
        voice,

        welcome message, model overrides, embedding provider/model — back to the

        platform default; null on the other fields leaves them alone.
    ApiResponse_ChatSettingsOut_:
      properties:
        data:
          anyOf:
            - $ref: '#/components/schemas/ChatSettingsOut'
            - type: 'null'
        meta:
          anyOf:
            - $ref: '#/components/schemas/PaginationMeta'
            - type: 'null'
        error:
          anyOf:
            - type: string
            - type: 'null'
          title: Error
        error_code:
          anyOf:
            - type: string
            - type: 'null'
          title: Error Code
      type: object
      title: ApiResponse[ChatSettingsOut]
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    ChatSettingsOut:
      properties:
        tenant_id:
          type: string
          format: uuid
          title: Tenant Id
        enabled:
          type: boolean
          title: Enabled
        system_prompt_template:
          anyOf:
            - type: string
            - type: 'null'
          title: System Prompt Template
        brand_voice:
          anyOf:
            - type: string
            - type: 'null'
          title: Brand Voice
        welcome_message:
          anyOf:
            - type: string
            - type: 'null'
          title: Welcome Message
        welcome_message_i18n:
          additionalProperties:
            type: string
          type: object
          title: Welcome Message I18N
          default: {}
        starter_prompts:
          items:
            type: string
          type: array
          title: Starter Prompts
        starter_prompts_i18n:
          additionalProperties:
            items:
              type: string
            type: array
          type: object
          title: Starter Prompts I18N
          default: {}
        excluded_category_ids:
          items:
            type: string
            format: uuid
          type: array
          title: Excluded Category Ids
        banned_phrases:
          items:
            type: string
          type: array
          title: Banned Phrases
        primary_model_override:
          anyOf:
            - type: string
            - type: 'null'
          title: Primary Model Override
        safety_model_override:
          anyOf:
            - type: string
            - type: 'null'
          title: Safety Model Override
        embedding_provider:
          anyOf:
            - type: string
            - type: 'null'
          title: Embedding Provider
        embedding_model:
          anyOf:
            - type: string
            - type: 'null'
          title: Embedding Model
        has_embedding_api_key:
          type: boolean
          title: Has Embedding Api Key
        embedding_api_key_last4:
          anyOf:
            - type: string
            - type: 'null'
          title: Embedding Api Key Last4
        monthly_budget_cents:
          type: integer
          title: Monthly Budget Cents
        current_month_cents:
          type: integer
          title: Current Month Cents
        rollout_percent:
          type: integer
          title: Rollout Percent
        updated_at:
          type: string
          format: date-time
          title: Updated At
        profile_generating:
          type: boolean
          title: Profile Generating
          default: false
      type: object
      required:
        - tenant_id
        - enabled
        - system_prompt_template
        - brand_voice
        - welcome_message
        - starter_prompts
        - excluded_category_ids
        - banned_phrases
        - primary_model_override
        - safety_model_override
        - embedding_provider
        - embedding_model
        - has_embedding_api_key
        - monthly_budget_cents
        - current_month_cents
        - rollout_percent
        - updated_at
      title: ChatSettingsOut
    PaginationMeta:
      properties:
        page:
          type: integer
          title: Page
        page_size:
          type: integer
          title: Page Size
        total:
          type: integer
          title: Total
        total_pages:
          type: integer
          title: Total Pages
      type: object
      required:
        - page
        - page_size
        - total
        - total_pages
      title: PaginationMeta
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
  securitySchemes:
    HTTPBearer:
      type: http
      scheme: bearer

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.