---
title: "POST /admin/setting/test-api-key"
method: POST
path: "/admin/setting/test-api-key"
tags: ["admin", "setting"]
---

# POST /admin/setting/test-api-key

`POST /admin/setting/test-api-key`

Test API key validity for AI Gateway or v0, optionally test attachment transfer modes

## Request body

- object
  - `type` 'aiGateway' | 'v0' | 'vercel', required
  - `apiKey` string, required
  - `baseUrl` string
  - `testAttachment` boolean

## Response `200`

Test result

- object
  - `success` boolean, required
  - `error` object
    - `code` 'unauthorized' | 'forbidden' | 'need_credit_card' | 'insufficient_quota' | 'network_error' | 'unknown', required
    - `message` string
  - `attachmentTest` object
    - `urlMode` object
      - `success` boolean, required
      - `errorMessage` string
    - `base64Mode` object
      - `success` boolean, required
      - `errorMessage` string
    - `recommendedMode` 'url' | 'base64'
    - `testedOrigin` 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)
