Get Configuration

Export the complete system configuration

GET /api/configs/export

Get Configuration

cURL

curl --request GET \
  --url https://api.example.com/api/configs/export

200

{
  "version": 123,
  "ui": {
    "enable_signup": true,
    "ENABLE_LOGIN_FORM": true,
    "default_locale": "<string>",
    "default_models": "<string>",
    "default_pinned_models": "<string>",
    "model_order_list": [
      {}
    ],
    "prompt_suggestions": [
      {
        "title": [
          {}
        ],
        "content": "<string>"
      }
    ],
    "default_user_role": "<string>",
    "default_group_id": "<string>",
    "watermark": "<string>",
    "enable_community_sharing": true,
    "enable_message_rating": true,
    "enable_user_webhooks": true,
    "banners": [
      {
        "id": "<string>",
        "type": "<string>",
        "title": "<string>",
        "content": "<string>",
        "dismissible": true,
        "timestamp": 123
      }
    ]
  },
  "auth": {
    "enable_api_keys": true,
    "api_key.endpoint_restrictions": true,
    "api_key.allowed_endpoints": "<string>",
    "jwt_expiry": "<string>",
    "admin.show": true,
    "admin.email": "<string>"
  },
  "oauth": {
    "enable_signup": true,
    "merge_accounts_by_email": true,
    "enable_role_mapping": true,
    "enable_group_mapping": true,
    "enable_group_creation": true,
    "allowed_domains": [
      {}
    ],
    "update_picture_on_login": true,
    "update_name_on_login": true,
    "update_email_on_login": true
  },
  "ollama": {
    "enable": true,
    "base_urls": [
      {}
    ],
    "api_configs": {}
  },
  "openai": {
    "enable": true,
    "api_keys": [
      {}
    ],
    "api_base_urls": [
      {}
    ],
    "api_configs": {}
  },
  "models": {
    "base_models_cache": true,
    "default_metadata": {},
    "default_params": {}
  },
  "tool_server": {
    "connections": [
      {
        "url": "<string>",
        "path": "<string>",
        "type": "<string>",
        "auth_type": "<string>",
        "headers": {},
        "key": "<string>",
        "config": {}
      }
    ]
  },
  "terminal_server": {
    "connections": [
      {}
    ]
  },
  "direct": {
    "enable": true
  },
  "webui": {
    "url": "<string>"
  },
  "user": {
    "permissions": {}
  },
  "folders": {
    "enable": true,
    "max_file_count": "<string>"
  },
  "channels": {
    "enable": true
  },
  "notes": {
    "enable": true
  },
  "webhook_url": "<string>"
}

Exports the complete system configuration including all settings, OAuth providers, tool servers, models, and UI preferences.

Authentication

Requires admin authentication.

Response

version · integer

Configuration version number

ui · object

UI-related configuration settings

Show properties

enable_signup · boolean

Whether user signup is enabled

ENABLE_LOGIN_FORM · boolean

Whether login form is displayed

default_locale · string

Default locale for the UI

default_models · string

Comma-separated list of default models

default_pinned_models · string

Comma-separated list of pinned models

model_order_list · array

Ordered list of model IDs

prompt_suggestions · array

Array of prompt suggestion objects

Show properties

title · array

Array of title strings

content · string

The prompt content

default_user_role · string

Default role for new users (e.g., “pending”, “user”)

default_group_id · string

Default group ID for new users

watermark · string

Response watermark text

enable_community_sharing · boolean

Whether community sharing is enabled

enable_message_rating · boolean

Whether message rating is enabled

enable_user_webhooks · boolean

Whether user webhooks are enabled

banners · array

Array of banner objects

Show properties

id · string · required

Unique banner identifier

type · string · required

Banner type (e.g., “info”, “warning”, “error”)

title · string

Banner title (optional)

content · string · required

Banner content

dismissible · boolean · required

Whether the banner can be dismissed

timestamp · integer · required

Unix timestamp when banner was created

auth · object

Authentication configuration

Show properties

enable_api_keys · boolean

Whether API keys are enabled

api_key.endpoint_restrictions · boolean

Whether API key endpoint restrictions are enabled

api_key.allowed_endpoints · string

Comma-separated list of allowed endpoints for API keys

jwt_expiry · string

JWT expiration time (e.g., “4w”, “30d”)

admin.show · boolean

Whether to show admin details

admin.email · string

Admin email address

oauth · object

OAuth configuration settings

Show properties

enable_signup · boolean

Whether OAuth signup is enabled

merge_accounts_by_email · boolean

Whether to merge accounts by email

enable_role_mapping · boolean

Whether OAuth role mapping is enabled

enable_group_mapping · boolean

Whether OAuth group mapping is enabled

enable_group_creation · boolean

Whether OAuth group creation is enabled

allowed_domains · array

Array of allowed domains for OAuth

update_picture_on_login · boolean

Whether to update user picture on login

update_name_on_login · boolean

Whether to update user name on login

update_email_on_login · boolean

Whether to update user email on login

ollama · object

Ollama configuration

Show properties

enable · boolean

Whether Ollama API is enabled

base_urls · array

Array of Ollama base URLs

api_configs · object

Per-URL API configurations

openai · object

OpenAI configuration

Show properties

enable · boolean

Whether OpenAI API is enabled

api_keys · array

Array of OpenAI API keys

api_base_urls · array

Array of OpenAI API base URLs

api_configs · object

Per-URL API configurations

models · object

Model configuration

Show properties

base_models_cache · boolean

Whether base models cache is enabled

default_metadata · object

Default metadata for models

default_params · object

Default parameters for models

tool_server · object

Tool server configuration

Show properties

connections · array

Array of tool server connection objects

Show properties

url · string · required

Tool server URL

path · string · required

Path to OpenAPI spec

type · string

Connection type (“openapi” or “mcp”)

auth_type · string

Authentication type (“bearer”, “session”, “oauth_2.1”, etc.)

headers · object

Custom headers

key · string

API key or token

config · object

Additional configuration

terminal_server · object

Terminal server configuration

Show properties

connections · array

Array of terminal server connection objects

direct · object

Direct connection settings

Show properties

enable · boolean

Whether direct connections are enabled

webui · object

Web UI configuration

Show properties

url · string

Web UI URL

user · object

User configuration

Show properties

permissions · object

Default user permissions object with nested workspace, sharing, chat, features, and settings permissions

folders · object

Folder configuration

Show properties

enable · boolean

Whether folders are enabled

max_file_count · string

Maximum file count per folder

channels · object

Channel configuration

Show properties

enable · boolean

Whether channels are enabled

notes · object

Notes configuration

Show properties

enable · boolean

Whether notes are enabled

webhook_url · string

Webhook URL for notifications

Example Response

{
  "version": 0,
  "ui": {
    "enable_signup": true,
    "ENABLE_LOGIN_FORM": true,
    "default_locale": "",
    "default_models": null,
    "default_pinned_models": null,
    "model_order_list": [],
    "prompt_suggestions": [
      {
        "title": ["Help me study", "vocabulary for a college entrance exam"],
        "content": "Help me study vocabulary: write a sentence for me to fill in the blank, and I'll try to pick the correct option."
      }
    ],
    "default_user_role": "pending",
    "default_group_id": "",
    "watermark": "",
    "enable_community_sharing": true,
    "enable_message_rating": true,
    "enable_user_webhooks": true,
    "banners": []
  },
  "auth": {
    "enable_api_keys": false,
    "api_key": {
      "endpoint_restrictions": false,
      "allowed_endpoints": ""
    },
    "jwt_expiry": "4w",
    "admin": {
      "show": true,
      "email": null
    }
  },
  "ollama": {
    "enable": true,
    "base_urls": ["http://localhost:11434"],
    "api_configs": {}
  },
  "openai": {
    "enable": true,
    "api_keys": [],
    "api_base_urls": ["https://api.openai.com/v1"],
    "api_configs": {}
  },
  "models": {
    "base_models_cache": false,
    "default_metadata": {},
    "default_params": {}
  },
  "tool_server": {
    "connections": []
  },
  "direct": {
    "enable": false
  },
  "webui": {
    "url": ""
  }
}