# 換發 API key 標準 URL： https://sosoapi.ai/zh-tw/docs/mcp/renew-api-key `sosoapi_renew_api_key` 為 API key（id）建立接替 key，新機密值僅回傳一次，能力和工作空間限制相同，選填新名稱或有效期（最多 365 天，代理程式建立的 key 為 30 天）。原 key 不會被撤銷。需要管理 API keys 授權。 ## 設定與傳輸方式 設定：full 傳輸方式：stdio、http 選擇 core 或 full 以控制用戶端顯示的工具；這不會變更權限。本機檔案上傳需要 stdio，無法透過 HTTP 使用。設定 SOSOAPI_OUTPUT_SCHEMAS=1 可在探索結果加入輸出結構描述。無論是否啟用此設定，工具皆會回傳結構化結果。 ## 權限與副作用 註解幫助用戶端描述工具。每次呼叫仍會檢查使用者身分驗證、角色、資源存取和能力授權。 ```json { "readOnlyHint": false, "destructiveHint": false, "idempotentHint": false, "openWorldHint": false } ``` `/identity-api/api-keys/renew` — agent:manage_api_keys；synchronous_http_response ## 輸入欄位 ```json { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "minLength": 1, "maxLength": 80 }, "lifetime_days": { "description": "Days until the successor expires (1-365, default 365; 30 at most for a key created by a delegated agent). The successor keeps the predecessor's capabilities and Workspace limit.", "type": "integer", "minimum": 1, "maximum": 365 }, "idempotency_key": { "description": "Optional. Reuse the same key to retry safely. The new secret is shown once: a retry that finds the successor already created answers 409 IDEMPOTENT_REPLAY (details.existing_key names it). Revoke it and renew again with a new idempotency_key.", "type": "string", "minLength": 8, "maxLength": 160, "pattern": "^[!-~]+$" } }, "required": [ "id" ], "additionalProperties": false } ``` ## 結構化輸出 此 schema 描述成功工具結果中的 structuredContent。MCP 回應也包含 content，並可能在呼叫失敗時設定 isError。對於發布，請讀取貼文的最終結果，不要把已接受的請求或文字回應當作確認。連結的 API 操作說明了權限和重試規則。 ```json { "type": "object", "properties": { "apiKey": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "last_4": { "type": "string" }, "scopes": { "type": "array", "items": { "type": "string" } }, "created_at": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$" }, "expires_at": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$" }, { "type": "null" } ] }, "last_used_at": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$" }, { "type": "null" } ] }, "revoked_at": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$" }, { "type": "null" } ] }, "status": { "type": "string", "enum": [ "active", "expired", "revoked" ] }, "replaces": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "last_4": { "type": "string" }, "status": { "type": "string", "enum": [ "active", "expired", "revoked" ] } }, "required": [ "id", "name", "last_4", "status" ], "additionalProperties": false }, { "type": "null" } ] }, "replaced_by": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "last_4": { "type": "string" }, "status": { "type": "string", "enum": [ "active", "expired", "revoked" ] } }, "required": [ "id", "name", "last_4", "status" ], "additionalProperties": false } }, "capabilities": { "type": "array", "items": { "type": "string", "enum": [ "agent:operate", "agent:publish", "agent:engage" ] } }, "workspace_ids": { "anyOf": [ { "type": "array", "items": { "type": "string", "format": "uuid" } }, { "type": "null" } ] }, "created_by_delegated_grant_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] } }, "required": [ "id", "name", "last_4", "scopes", "created_at", "expires_at", "last_used_at", "revoked_at", "status", "replaces", "replaced_by" ], "additionalProperties": false }, "secret": { "type": "string", "minLength": 1 } }, "required": [ "apiKey", "secret" ], "$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": false } ``` ## 工具呼叫範例 這些範例使用已依結構描述檢查的虛構值。請將 ID 替換為您有權使用的 ID、將媒體替換為已就緒素材，並將日期替換為已確認的發布時間。提交寫入前，請檢查帳號資格。本頁不會傳送 API 請求。 ```json { "name": "sosoapi_renew_api_key", "arguments": { "id": "11111111-1111-4111-8111-111111111111" } } ``` structuredContent ```json { "apiKey": { "id": "11111111-1111-4111-8111-111111111111", "name": "example", "last_4": "example", "scopes": [], "created_at": "2099-01-15T09:00:00Z", "expires_at": null, "last_used_at": null, "revoked_at": null, "status": "active", "replaces": null, "replaced_by": [] }, "secret": "example" } ``` ## 底層 API 操作 - [/identity-api/api-keys/renew](https://sosoapi.ai/zh-tw/docs/api/identity-api-api-keys-renew)