GET
/
admin
/
setting
shell
curl --request GET \
  --url https://app.teable.ai/api/admin/setting \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'
{
  "instanceId": "<string>",
  "brandName": "<string>",
  "brandLogo": "<string>",
  "disallowSignUp": true,
  "disallowSpaceCreation": true,
  "disallowSpaceInvitation": true,
  "enableEmailVerification": true,
  "enableWaitlist": true,
  "aiConfig": {
    "llmProviders": [],
    "embeddingModel": "<string>",
    "translationModel": "<string>",
    "chatModel": {
      "lg": "<string>",
      "md": "<string>",
      "sm": "<string>",
      "ability": {
        "image": true,
        "pdf": true,
        "webSearch": true
      }
    },
    "capabilities": {
      "disableActions": [
        "<string>"
      ]
    },
    "enable": true
  },
  "notifyMailTransportConfig": {
    "senderName": "<string>",
    "sender": "<string>",
    "host": "<string>",
    "port": 123,
    "secure": true,
    "auth": {
      "user": "<string>",
      "pass": "<string>"
    }
  },
  "automationMailTransportConfig": {
    "senderName": "<string>",
    "sender": "<string>",
    "host": "<string>",
    "port": 123,
    "secure": true,
    "auth": {
      "user": "<string>",
      "pass": "<string>"
    }
  },
  "appConfig": {
    "apiKey": "<string>",
    "creditCount": 1
  },
  "webSearchConfig": {
    "apiKey": "<string>"
  },
  "createdTime": "<string>"
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Response

200 - application/json

Returns the instance settings.

instanceId
string
required
brandName
string | null
disallowSignUp
boolean | null
disallowSpaceCreation
boolean | null
disallowSpaceInvitation
boolean | null
enableEmailVerification
boolean | null
enableWaitlist
boolean | null
aiConfig
object | null
notifyMailTransportConfig
object | null
automationMailTransportConfig
object | null
appConfig
object | null
webSearchConfig
object | null
createdTime
string