Public API

API キーを削除

Management key required. 使用履歴を保持したままモデル API キーを永久に削除します。

URL の api_key_id は、モデル API キーの作成(POST /public/v1/api-keys)のレスポンスに含まれる id(ak_... 形式)です。 無効化、削除、利用上限の設定、使用量の照会に使うため保存してください。レスポンスの key(apikey-...)はモデル呼び出し用です。管理操作の認証ヘッダーには引き続き mgmt-... を指定します。

DELETE
/public/v1/api-keys/{api_key_id}

Management key required. Use a Management API Key (mgmt-...) for your Team, created by a Team Owner. Requests use the Team associated with that key.

No request body. Soft-deletes the key, preserving its identity and usage history. A deleted key cannot be enabled or have its allowance changed. Repeating deletion of this Team's key returns 204; unknown or other-Team identifiers return 404. Follows existing gateway cache refresh behavior.

Authorization

ManagementKeyBearer
AuthorizationBearer <token>

Management key required. Send Authorization: Bearer mgmt-....

In: header

Path Parameters

api_key_id*string

The id returned by Create a model API key (POST /public/v1/api-keys). Copy the complete ak_... value into this path parameter. Use the mgmt-... management key in the authorization header; the returned key (apikey-...) is for model calls.

Match^ak_[0-9A-Za-z]{22}$

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X DELETE "https://example.com/public/v1/api-keys/ak_0123456789ABCDEFGHIJKL"
Empty

Last updated on