Get Configuration

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

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/api/configs/export",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/api/configs/export"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.example.com/api/configs/export")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

{
  "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>"
}

GET

api

configs

export

Get Configuration

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

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/api/configs/export",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/api/configs/export"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.example.com/api/configs/export")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

{
  "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

integer

Configuration version number

object

UI-related configuration settings

Show properties

Whether user signup is enabled

Whether login form is displayed

string

Default locale for the UI

string

Comma-separated list of default models

string

Comma-separated list of pinned models

array

Ordered list of model IDs

array

Array of prompt suggestion objects

Show properties

array

Array of title strings

string

The prompt content

string

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

string

Default group ID for new users

string

Response watermark text

Whether community sharing is enabled

boolean

Whether message rating is enabled

boolean

Whether user webhooks are enabled

array

Array of banner objects

Show properties

string

required

Unique banner identifier

string

required

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

string

Banner title (optional)

string

required

Banner content

boolean

required

Whether the banner can be dismissed

integer

required

Unix timestamp when banner was created

object

Authentication configuration

Show properties

boolean

Whether API keys are enabled

boolean

Whether API key endpoint restrictions are enabled

string

Comma-separated list of allowed endpoints for API keys

string

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

boolean

Whether to show admin details

string

Admin email address

object

OAuth configuration settings

Show properties

Whether OAuth signup is enabled

boolean

Whether to merge accounts by email

boolean

Whether OAuth role mapping is enabled

boolean

Whether OAuth group mapping is enabled

boolean

Whether OAuth group creation is enabled

array

Array of allowed domains for OAuth

Whether to update user picture on login

Whether to update user name on login

Whether to update user email on login

object

Ollama configuration

Show properties

boolean

Whether Ollama API is enabled

array

Array of Ollama base URLs

object

Per-URL API configurations

object

OpenAI configuration

Show properties

boolean

Whether OpenAI API is enabled

array

Array of OpenAI API keys

array

Array of OpenAI API base URLs

object

Per-URL API configurations

object

Model configuration

Show properties

boolean

Whether base models cache is enabled

object

Default metadata for models

object

Default parameters for models

object

Tool server configuration

Show properties

array

Array of tool server connection objects

Show properties

string

required

Tool server URL

string

required

Path to OpenAPI spec

string

Connection type (“openapi” or “mcp”)

string

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

object

Custom headers

string

API key or token

object

Additional configuration

object

Terminal server configuration

Show properties

array

Array of terminal server connection objects

object

Direct connection settings

Show properties

boolean

Whether direct connections are enabled

object

Web UI configuration

Show properties

string

Web UI URL

object

User configuration

Show properties

object

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

object

Folder configuration

Show properties

boolean

Whether folders are enabled

string

Maximum file count per folder

object

Channel configuration

Show properties

boolean

Whether channels are enabled

object

Notes configuration

Show properties

boolean

Whether notes are enabled

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": ""
  }
}

Overview

Chat & Messages

Models

Users & Groups

Knowledge

Functions & Tools

Files & Media

Channels

Prompts

Notes & Folders

Evaluations

Configuration

Get Configuration

Authentication

Response

Example Response

​Authentication

​Response

​Example Response

Authentication

Response

Example Response