Interface Object Structure

Overview

The interface object allows for customization of various user interface elements within the application, including visibility and behavior settings for components such as menus, panels, and links. This section provides a detailed breakdown of the interface object structure.

These are fields under interface:

• mcpServers
• privacyPolicy
• termsOfService
• modelSelect
• parameters
• contextUsage
• contextCost
• currency
• presets
• prompts
• bookmarks
• memories
• multiConvo
• agents
• remoteAgents
• skills
• sharedLinks
• temporaryChat
• temporaryChatRetention
• retentionMode
• retainAgentFiles
• autoSubmitFromUrl
• customWelcome
• runCode
• webSearch
• fileSearch
• fileCitations
• peoplePicker
• marketplace

Notes:

• The interface configurations are applied globally within the application.
• Default values are provided for most settings but can be overridden based on specific requirements or conditions.
• Conditional logic in the application can further modify these settings based on other configurations like model specifications.

Example

interface:
  mcpServers:
    placeholder: 'MCP Servers'
    use: true
    create: true
    share: false
    public: false
    configureObo: false
    trustCheckbox:
      label: 'I trust this server'
      subLabel: 'Only enable servers you trust'
  privacyPolicy:
    externalUrl: 'https://example.com/privacy'
    openNewTab: true
  termsOfService:
    externalUrl: 'https://example.com/terms'
    openNewTab: true
    modalAcceptance: true
    modalTitle: 'Terms of Service'
    modalContent: |
      # Terms of Service
      ## Introduction
      Welcome to LibreChat!
  modelSelect: false
  parameters: true
  contextUsage: true
  contextCost: true
  currency:
    code: EUR
    rate: 0.92
  presets: false
  prompts:
    use: true
    create: true
    share: true
    public: false
  bookmarks: true
  multiConvo: true
  agents:
    use: true
    create: true
    share: true
    public: false
  skills:
    use: true
    create: true
    share: false
    public: false
    defaultActiveOnShare: false
  sharedLinks:
    create: true
    share: true
    public: false
  customWelcome: 'Hey {{user.name}}! Welcome to LibreChat'
  runCode: true
  webSearch: true
  fileSearch: true
  fileCitations: true

mcpServers

Deprecated for permission management. The use, create, share, and public sub-keys seed role permissions at startup. Prefer the Admin Panel for managing MCP server permissions per role/group/user. The placeholder and trustCheckbox sub-keys are unaffected.

Key:

Sub-keys:

trustCheckbox Sub-keys:

Example:

interface:
  mcpServers:
    placeholder: 'Select MCP Server'
    use: true
    create: true
    share: false
    configureObo: false
    trustCheckbox:
      label:
        en: 'I trust this server'
        es: 'Confío en este servidor'
      subLabel:
        en: 'Only enable servers you trust'
        es: 'Solo habilite servidores en los que confíe'

privacyPolicy

Key:

Sub-keys:

termsOfService

Key:

Sub-keys:

modelSelect

Key:

Default: true

Notes:

• This is required to be true if using modelSpecs.addedEndpoints.
• If modelSpecs.addedEndpoints is used and interface.modelSelect is not explicitly set, it defaults to true.

Example:

interface:
  modelSelect: true

parameters

Key:

Default: true

Example:

interface:
  parameters: false

contextUsage

Key:

Default: true

Example:

interface:
  contextUsage: true

contextCost

Key:

Default: false

Notes:

• Set contextCost: true to opt in to visible cost values. Token usage can remain visible through contextUsage while cost values stay hidden.
• currency only affects displayed costs when cost display is enabled.

Example:

interface:
  contextCost: true

currency

Key:

Sub-keys:

Example:

interface:
  currency:
    code: EUR
    rate: 0.92

presets

Key:

Default: true

Example:

interface:
  presets: true

prompts

Deprecated for permission management. Seeds the PROMPTS role permissions at startup for the default USER role only. Prefer the Admin Panel for managing prompt permissions per role/group/user.

Key:

Default: true

Important: Boolean vs Object Configuration

• Boolean (prompts: true): Only updates the use permission. Existing create, share, and public permission values are preserved from the database. Use this as a simple feature toggle without affecting other settings configured through the admin panel.

• Object: Updates only the sub-permissions that are explicitly specified. Any permissions not included in the config are preserved from the database.

When using the object structure:

Sub-keys:

Example (boolean - simple feature toggle):

interface:
  prompts: true # Only updates USE; create/share/public remain unchanged

Example (object - granular control):

interface:
  prompts:
    use: true
    create: false # Disable creation while allowing use
    # share and public not specified - preserves existing values

Example (object - full control):

interface:
  prompts:
    use: true
    create: true
    share: true
    public: false

bookmarks

Deprecated for permission management. Seeds the BOOKMARKS role permission at startup for the default USER role only. Prefer the Admin Panel.

Key:

Default: true

Example:

interface:
  bookmarks: true

memories

Deprecated for permission management. Seeds the MEMORIES role permissions at startup for the default USER role only. Prefer the Admin Panel. Note this toggle is separate from the memory behavior configuration.

Key:

Default: true

Note: This controls the UI visibility of the memories feature. For detailed memory behavior configuration (token limits, personalization, agent settings), see the Memory Configuration.

Example:

interface:
  memories: true

multiConvo

Deprecated for permission management. Seeds the MULTI_CONVO role permission at startup for the default USER role only. Prefer the Admin Panel.

Key:

Default: true

Example:

interface:
  multiConvo: true

agents

More info on Agents

Deprecated for permission management. Seeds the AGENTS role permissions at startup for the default USER role only. Prefer the Admin Panel for managing agent permissions per role/group/user.

Key:

Default: true

Important: Boolean vs Object Configuration

• Boolean (agents: true): Only updates the use permission. Existing create, share, and public permission values are preserved from the database. Use this as a simple feature toggle without affecting other settings configured through the admin panel.

• Object: Updates only the sub-permissions that are explicitly specified. Any permissions not included in the config are preserved from the database.

When using the object structure:

Sub-keys:

Example (boolean - simple feature toggle):

interface:
  agents: true # Only updates USE; create/share/public remain unchanged

Example (object - granular control):

interface:
  agents:
    use: true
    create: false # Disable creation while allowing use
    # share and public not specified - preserves existing values

Example (object - full control):

interface:
  agents:
    use: true
    create: true
    share: true
    public: false

remoteAgents

Controls access to the Agents API (OpenAI-compatible and Open Responses API endpoints), which allows external applications to interact with LibreChat agents programmatically via API keys.

Deprecated for permission management. Seeds the REMOTE_AGENTS role permissions at startup for the default USER role only. Prefer the Admin Panel.

Key:

Sub-keys:

Default: All fields default to false (disabled).

Example:

interface:
  remoteAgents:
    use: true
    create: true
    share: false
    public: false

Note: Admin users have all remote agent permissions enabled by default regardless of this configuration.

skills

Deprecated for permission management. Seeds the SKILLS role permissions at startup for the default USER role only. Prefer the Admin Panel for managing Skills permissions per role/group/user. defaultActiveOnShare is not a permission bit and remains a YAML behavior setting.

Key:

Default: true for use and create, false for share, public, and defaultActiveOnShare.

Sub-keys:

Example:

interface:
  skills:
    use: true
    create: true
    share: false
    public: false
    defaultActiveOnShare: false

For Skills behavior and invocation modes, see Skills.

sharedLinks

Deprecated for permission management. Seeds the SHARED_LINKS role permissions at startup for the default USER role only. Prefer the Admin Panel for managing shared-link permissions per role/group/user.

Key:

Default: create: true, share: true, public: true

Important: Boolean vs Object Configuration

• Boolean (sharedLinks: true): Enables all SHARED_LINKS permissions for the default USER role.
• Boolean (sharedLinks: false): Disables all SHARED_LINKS permissions for the default USER role.
• Object: Updates only the sub-permissions that are explicitly specified. Any permissions not included in the config are preserved from the database.

Sub-keys:

Example:

interface:
  sharedLinks:
    create: true
    share: true
    public: false

For user-facing shared-link behavior, see Shareable Links.

temporaryChat

Controls whether the temporary chat feature is available to users. Temporary chats are not saved to conversation history and are automatically deleted after a configurable retention period.

Deprecated for permission management. Seeds the TEMPORARY_CHAT role permission at startup for the default USER role only. Prefer the Admin Panel. temporaryChatRetention below is not a permission and remains the recommended way to configure retention.

Key:

Default: true

Note: The retention period for temporary chats can be configured using temporaryChatRetention.

Example:

interface:
  temporaryChat: true

temporaryChatRetention

The temporaryChatRetention configuration allows you to customize how long temporary chats are retained before being automatically deleted.

Key:

Validation Rules:

• Minimum: 1 hour (prevents immediate deletion)
• Maximum: 8760 hours (1 year maximum retention)
• Default: 720 hours (30 days)

Configuration Methods:

1. LibreChat.yaml (recommended): interface.temporaryChatRetention: 168
2. Environment Variable (deprecated): TEMP_CHAT_RETENTION_HOURS=168

Note: The environment variable TEMP_CHAT_RETENTION_HOURS is deprecated. Please use the interface.temporaryChatRetention config option in librechat.yaml instead. The config file value takes precedence over the environment variable.

Example:

interface:
  temporaryChatRetention: 168 # Retain temporary chats for 7 days
  retentionMode: 'temporary'

Common Retention Periods:

• 1 hour: temporaryChatRetention: 1 (minimal retention)
• 24 hours: temporaryChatRetention: 24 (1 day)
• 168 hours: temporaryChatRetention: 168 (1 week)
• 720 hours: temporaryChatRetention: 720 (30 days - default)
• 8760 hours: temporaryChatRetention: 8760 (1 year - maximum)

retentionMode

Controls which data receives retention deadlines.

Key:

Default: temporary

Example:

interface:
  temporaryChatRetention: 168
  retentionMode: 'all'

retainAgentFiles

Controls whether persistent agent resource files are exempt from all-data retention.

Key:

Default: false

Notes:

• This setting only changes behavior when retentionMode is set to "all".
• Set this to true when agents should keep their persistent resource files even while conversations, messages, and non-agent files receive retention deadlines.

Example:

interface:
  temporaryChatRetention: 168
  retentionMode: 'all'
  retainAgentFiles: true

autoSubmitFromUrl

Controls whether a prompt supplied via URL query parameters on /c/new is auto-submitted to the model.

When /c/new?prompt=…&submit=true is opened by an authenticated user, LibreChat normally pre-fills the composer with the URL-supplied prompt and submits it immediately. This is a convenience feature for crafted deeplinks and shared chat URLs.

For deployments where users may receive crafted links from external sources — and where memory- or tool-enabled models could leak sensitive context if a prompt-injection payload reaches the model — operators can disable auto-submission. With the flag set to false, the prompt is still pre-filled in the composer but the user must press Send explicitly.

Key:

Default: true (existing behavior is preserved unless explicitly disabled).

Notes:

• This setting does not affect URL-driven model spec selection or other URL-driven settings — only the auto-submission step.
• The query parameter accepts both prompt and q as the prompt source, with prompt taking precedence. submit=true is the trigger.
• Recommended for instances handling sensitive memory or tool data, where a 1-click prompt-injection vector should require explicit user confirmation.

Example:

interface:
  autoSubmitFromUrl: false

customWelcome

Key:

Default: None (if not specified, a default greeting is used)

Example:

interface:
  customWelcome: 'Hey {{user.name}}! Welcome to LibreChat'

Note: You can use {{user.name}} within the customWelcome message to dynamically insert the user's name for a personalized greeting experience.

runCode

Enables/disables the "Run Code" button for Markdown Code Blocks. More info on the LibreChat Code Interpreter API

Note: This setting does not disable the Agents Code Interpreter Capability. To disable the Agents Capability, see the Agents Endpoint configuration instead.

Deprecated for permission management. Seeds the RUN_CODE role permission at startup for the default USER role only. Prefer the Admin Panel.

Key:

Default: true

Example:

interface:
  runCode: true

webSearch

Enables/disables the web search button in the chat interface. More info on Web Search Configuration

Note: This setting does not disable the Agents Web Search Capability. To disable the Agents Capability, see the Agents Endpoint configuration instead.

Deprecated for permission management. Seeds the WEB_SEARCH role permission at startup for the default USER role only. Prefer the Admin Panel.

Key:

Default: true

Example:

interface:
  webSearch: true

fileSearch

Enables/disables the file search (for RAG API usage via tool) button in the chat interface

Note: This setting does not disable the Agents File Search Capability. To disable the Agents Capability, see the Agents Endpoint configuration instead.

Deprecated for permission management. Seeds the FILE_SEARCH role permission at startup for the default USER role only. Prefer the Admin Panel.

Key:

Default: true

Example:

interface:
  fileSearch: true

fileCitations

Controls the global availability of file citations functionality. When disabled, it effectively removes the FILE_CITATIONS permission for all users, preventing any file citations from being displayed when using file search, regardless of individual user permissions.

Deprecated for permission management. Seeds/globally gates the FILE_CITATIONS role permission at startup. Prefer the Admin Panel for managing citations permissions per role/group/user.

Note:

• This setting acts as a global toggle for the FILE_CITATIONS permission system-wide.
• When set to false, no users will see file citations, even if they have been granted the permission through roles.
• File citations require the fileSearch feature to be enabled.
• When using agents with file search capability, citation behavior (quantity and quality) can be configured through the Agents endpoint configuration.

Key:

Default: true

Example:

interface:
  fileCitations: true

peoplePicker

Controls which principal types (users, groups, roles) are available for selection in the people picker interface, typically used when sharing agents or managing access controls.

Deprecated for permission management. Seeds the PEOPLE_PICKER role permissions at startup for the default USER role only. Prefer the Admin Panel.

Key:

Sub-keys:

Default:

peoplePicker:
  users: true
  groups: true
  roles: true

Example:

interface:
  peoplePicker:
    users: true
    groups: true
    roles: false # Disable role selection in people picker

marketplace

Enables/disables access to the Agent Marketplace.

Deprecated for permission management. Seeds the MARKETPLACE role permission at startup for the default USER role only. Prefer the Admin Panel.

Key:

Sub-keys:

Default:

marketplace:
  use: false

Example:

interface:
  marketplace:
    use: true # Enable marketplace access