跳到正文
API 参考
API 参考

更新 API 密钥

更新现有 Standard API 密钥，并获取其当前用量汇总。

查看 Markdown

更新现有 Standard API 密钥，并获取其当前用量汇总。

端点

PATCH /api/v1/keys/:id
基础 URL
https://runapi.ai
API 版本
v1
身份验证
Authorization: Bearer YOUR_MANAGEMENT_API_KEY
授权
需要账户管理员的 Management API 密钥，并且只允许更新其用户拥有的密钥。
02

请求

JSON 请求体

只能在列出的请求位置发送值。

JSON 请求体7 个字段
allowed_modelsarray | null
可选

Replacement model allowlist; null or an empty array clears it.

credit_limit_centsinteger | null
可选

Spending cap in USD cents; null clears the cap and reset interval.

credit_limit_reset_intervalstring | null
可选

Reset cadence for the spending cap.

可选值: daily, weekly, monthly
credit_limit_windowsobject
可选

Replacement rolling spending caps keyed by 1h, 1d, or 7d; an empty object clears all rolling caps.

enabledboolean
可选

Whether requests using this key are accepted.

namestring
可选

Replacement friendly name for the API key.

tagsarray
可选

Replacement key:value strings; omission preserves tags. Same format and 20-tag limit as create. Missing usage becomes usage:developer; an empty array resets to usage:developer.

路径参数1 个字段
idstring
必填

API key prefix ID, for example token_123.

03

成功响应

HTTP 200

PATCH /api/v1/keys/:id

JSON 
{
  "allowed_models": [
    "gpt-5.4"
  ],
  "created_at": "2026-07-27T10:00:00.000Z",
  "credit_limit_cents": 1000,
  "credit_limit_reset_interval": "daily",
  "credit_limit_windows": {},
  "credit_usage_cents_by_model": {
    "gpt-5.4": 250
  },
  "credit_usage_cents_this_month": 250,
  "credit_usage_cents_this_week": 100,
  "credit_usage_cents_today": 25,
  "credit_usage_cents_total": 250,
  "enabled": true,
  "guardrail_id": "guardrail_123",
  "id": "token_123",
  "last_used_at": null,
  "masked_token": "runapi_abc...wxyz",
  "name": "Production primary",
  "tags": [
    "usage:service",
    "env:production",
    "dept:ml"
  ]
}
04

错误响应 (401)

HTTP 401
响应 Schema
JSON 
{
  "properties": {
    "error": {
      "description": "Human-readable error message.",
      "type": "string"
    }
  },
  "required": [
    "error"
  ],
  "type": "object",
  "unevaluatedProperties": false
}

响应示例

JSON 
{
  "error": "Authentication required"
}
05

错误响应 (403)

HTTP 403
响应 Schema
JSON 
{
  "properties": {
    "error": {
      "description": "Human-readable error message.",
      "type": "string"
    }
  },
  "required": [
    "error"
  ],
  "type": "object",
  "unevaluatedProperties": false
}

响应示例

JSON 
{
  "error": "Management API key required"
}
06

错误响应 (403)

HTTP 403
响应 Schema
JSON 
{
  "properties": {
    "error": {
      "description": "Human-readable error message.",
      "type": "string"
    }
  },
  "required": [
    "error"
  ],
  "type": "object",
  "unevaluatedProperties": false
}

响应示例

JSON 
{
  "error": "Account admin required"
}
07

错误响应 (400)

HTTP 400
响应 Schema
JSON 
{
  "oneOf": [
    {
      "properties": {
        "error": {
          "description": "Human-readable error message.",
          "type": "string"
        }
      },
      "required": [
        "error"
      ],
      "type": "object",
      "unevaluatedProperties": false
    },
    {
      "properties": {
        "error": {
          "description": "Human-readable validation summary.",
          "type": "string"
        },
        "errors": {
          "additionalProperties": {
            "items": {
              "type": "string"
            },
            "type": "array"
          },
          "description": "Validation messages keyed by public request field, with an array of human-readable strings for each field.",
          "type": "object"
        }
      },
      "required": [
        "error",
        "errors"
      ],
      "type": "object",
      "unevaluatedProperties": false
    }
  ]
}

响应示例

JSON 
{
  "error": "page must be an integer"
}
08

错误响应 (404)

HTTP 404
响应 Schema
JSON 
{
  "properties": {
    "error": {
      "description": "Human-readable error message.",
      "type": "string"
    }
  },
  "required": [
    "error"
  ],
  "type": "object",
  "unevaluatedProperties": false
}

响应示例

JSON 
{
  "error": "Resource not found"
}
09

错误响应 (422)

HTTP 422
响应 Schema
JSON 
{
  "properties": {
    "error": {
      "description": "Human-readable validation summary.",
      "type": "string"
    },
    "errors": {
      "additionalProperties": {
        "items": {
          "type": "string"
        },
        "type": "array"
      },
      "description": "Validation messages keyed by public request field, with an array of human-readable strings for each field.",
      "type": "object"
    }
  },
  "required": [
    "error",
    "errors"
  ],
  "type": "object",
  "unevaluatedProperties": false
}

响应示例

JSON 
{
  "error": "Validation failed",
  "errors": {
    "base": [
      "Validation failed"
    ]
  }
}
10

cURL 示例

CURL 
curl -X PATCH https://runapi.ai/api/v1/keys/token_123 \
  -H 'Authorization: Bearer YOUR_MANAGEMENT_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{"name":"Production primary","tags":["usage:service","env:production","dept:ml"],"enabled":true,"credit_limit_windows":{}}'