---
title: "GET /admin/setting"
method: GET
path: "/admin/setting"
tags: ["admin"]
---

# GET /admin/setting

`GET /admin/setting`

Get the instance settings

## Response `200`

Returns the instance settings.

- object
  - `instanceId` string, required
  - `brandName` string, nullable
  - `brandLogo` string, nullable
  - `disallowSignUp` boolean, nullable
  - `disallowSpaceCreation` boolean, nullable
  - `disallowSpaceInvitation` boolean, nullable
  - `disallowDashboard` boolean, nullable
  - `enableEmailVerification` boolean, nullable
  - `enableWaitlist` boolean, nullable
  - `enableCreditReward` boolean, nullable
  - `aiConfig` object, nullable
    - `llmProviders` object[]
      - `type` 'openai' | 'anthropic' | 'google' | 'azure' | 'cohere' | 'mistral' | 'deepseek' | 'qwen' | 'zhipu' | 'lingyiwanwu' | 'xai' | 'togetherai' | 'ollama' | 'amazonBedrock' | 'openRouter' | 'openaiCompatible' | 'aiGateway', required
      - `name` string, required
      - `apiKey` string
      - `baseUrl` string, uri
      - `models` string
      - `isInstance` boolean
      - `modelConfigs` object
    - `embeddingModel` string
    - `translationModel` string
    - `chatModel` object
      - `lg` string
      - `md` string
      - `sm` string
      - `ability` object
        - `image` union
          - boolean
          - object
            - `url` boolean
            - `base64` boolean
        - `pdf` union
          - boolean
          - object
            - `url` boolean
            - `base64` boolean
        - `webSearch` boolean
        - `toolCall` boolean
        - `reasoning` boolean
        - `imageGeneration` boolean
    - `gatewayModels` object[]
      - `id` string, required
      - `label` string, required
      - `enabled` boolean
      - `capabilities` object
        - `image` union
          - boolean
          - object
            - `url` boolean
            - `base64` boolean
        - `pdf` union
          - boolean
          - object
            - `url` boolean
            - `base64` boolean
        - `webSearch` boolean
        - `toolCall` boolean
        - `reasoning` boolean
        - `imageGeneration` boolean
      - `pricing` object
        - `input` string
        - `output` string
        - `inputCacheRead` string
        - `inputCacheWrite` string
        - `reasoning` string
        - `image` string
        - `webSearch` string
      - `rates` object
        - `inputRate` number
        - `outputRate` number
        - `cacheReadRate` number
        - `cacheWriteRate` number
        - `reasoningRate` number
        - `imageRate` number
        - `webSearchRate` number
      - `isImageModel` boolean
      - `defaultFor` string[]
      - `testedAt` number
      - `ownedBy` 'alibaba' | 'amazon' | 'anthropic' | 'arcee-ai' | 'bfl' | 'bytedance' | 'cohere' | 'deepseek' | 'google' | 'inception' | 'kwaipilot' | 'meituan' | 'meta' | 'minimax' | 'mistral' | 'moonshotai' | 'morph' | 'nvidia' | 'openai' | 'perplexity' | 'prime-intellect' | 'stealth' | 'vercel' | 'voyage' | 'xai' | 'xiaomi' | 'zai'
      - `modelType` 'language' | 'embedding' | 'image'
      - `tags` string[]
      - `contextWindow` number
      - `maxTokens` number
      - `description` string
    - `capabilities` object
      - `disableActions` string[]
    - `aiGatewayApiKey` string
    - `aiGatewayBaseUrl` string, uri
    - `attachmentTest` object
      - `urlMode` object
        - `success` boolean, required
        - `errorMessage` string
      - `base64Mode` object
        - `success` boolean, required
        - `errorMessage` string
      - `testedAt` string
      - `testedOrigin` string
      - `recommendedMode` 'url' | 'base64'
    - `attachmentTransferMode` 'url' | 'base64'
    - `aiGatewayApiKeys` string[]
    - `vertexByokCredential` object
      - `project` string, required
      - `location` string, required
      - `googleCredentials` object, required
        - `privateKey` string, required
        - `clientEmail` string, required
    - `concurrencyGroups` object[]
      - `id` string, required
      - `name` string, required
      - `taskTypes` string[]
      - `keys` object[]
        - `apiKey` string, required
        - `status` 'verified' | 'untested' | 'error'
      - `perKey` number
    - `concurrencyPerKey` number
    - `enable` boolean
  - `notifyMailTransportConfig` object, nullable
    - `senderName` string
    - `sender` string, required
    - `host` string, required
    - `port` number, required
    - `secure` boolean
    - `auth` object, required
      - `user` string, required
      - `pass` string, required
  - `automationMailTransportConfig` object, nullable
    - `senderName` string
    - `sender` string, required
    - `host` string, required
    - `port` number, required
    - `secure` boolean
    - `auth` object, required
      - `user` string, required
      - `pass` string, required
  - `appConfig` object, nullable
    - `apiKey` string
    - `vercelToken` string
    - `customDomain` string
    - `creditCount` number
    - `v0BaseUrl` string, uri
    - `vercelBaseUrl` string, uri
  - `canaryConfig` object, nullable
    - `enabled` boolean, required
    - `spaceIds` string[]
    - `forceV2All` boolean
  - `trashCleanupEnabledAt` string, nullable
  - `createdTime` string

---

[API](https://skmtc.net/teable/apis/teable-app.md) · [All operations](https://skmtc.net/teable/apis/teable-app/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/teable/teable-app/versions/7515f3b33d79/schema)