取得頭像上傳 URL

概覽

取得自己新頭像嘅 signed upload URL；需要 filename 同 content_type。單靠此操作唔會改個人資料。

HTTP 成功只表示呢次操作嘅回應。背景工作要保留回傳 ID，讀取同一操作直到文件指定嘅終態。接受請求、排程成功或客戶端逾時，都唔代表已發佈。

驗證及權限

接受嘅憑證類型

user_session, delegated_oauth, personal_access_token

委派權限

agent:operate

最低工作空間角色

此 contract 冇指定工作空間最低角色；仍需符合擁有權及授權檢查。

存取範圍

已登入使用者及獲授權資源範圍

需要所有工作空間同意

唔係

會改動狀態

係

完成依據

synchronous_http_response

憑證唔能夠擴大持有人權限。實際操作仍會檢查工作空間成員資格、資源擁有權、已選工作空間及能力授權。Tool profile 只改變可見工具，唔會授權。

請求欄位

必填表示喺所屬物件及所選分支內必須提供；子欄位必填唔代表可選父物件變成必填。以下欄位名稱及規則直接來自 contract。

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "filename": {
      "type": "string",
      "minLength": 1,
      "maxLength": 256
    },
    "content_type": {
      "type": "string",
      "pattern": "^image\\/(png|jpeg|jpg|gif|webp)$"
    },
    "byte_size": {
      "description": "Exact avatar size in bytes (max 5 MiB); signed into the upload URL",
      "type": "integer",
      "minimum": 1,
      "maximum": 5242880
    }
  },
  "required": [
    "filename",
    "content_type"
  ],
  "additionalProperties": false
}

回應及完成條件

成功 HTTP 狀態碼: 200. 完成依據: synchronous_http_response.

HTTP 成功只表示呢次操作嘅回應。背景工作要保留回傳 ID，讀取同一操作直到文件指定嘅終態。接受請求、排程成功或客戶端逾時，都唔代表已發佈。

必填表示喺所屬物件及所選分支內必須提供；子欄位必填唔代表可選父物件變成必填。以下欄位名稱及規則直接來自 contract。

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "action": {
      "type": "string",
      "const": "sign-avatar-url"
    },
    "path": {
      "type": "string"
    },
    "signed_url": {
      "type": "string",
      "format": "uri"
    },
    "token": {
      "type": "string"
    }
  },
  "required": [
    "action",
    "path",
    "signed_url"
  ]
}

錯誤及安全重試

檢查 HTTP 狀態及實際回應格式。驗證400可能回傳 ZodError；handler 錯誤可能係 error／message／code envelope。保留可用嘅 request_id 或 x-request-id，唔好記錄憑證。401／403先修正存取問題；429遵守 Retry-After。寫入結果未明或5xx時，先讀原有結果，再決定重試；只喺操作支援時重用 idempotency key，並冇通用重試或 exactly-once 保證。

範例

以下虛構值已按 contract 驗證，唔係真實帳戶 ID、憑證或發佈紀錄。請用已授權範圍回傳嘅 ID、已準備好嘅素材及已審核排程取代，寫入前核對平台資格。此頁唔會呼叫 API。

喺伺服器環境設定 SOSOAPI_ACCESS_TOKEN，使用此操作接受嘅憑證。唔好放入瀏覽器程式。一般 agent 建議透過 sosoapi auth login 用瀏覽器 OAuth，由 CLI 管理憑證更新。

request.json

{
  "filename": "example.png",
  "content_type": "image/png"
}

cURL

curl --request POST \
  "https://gqeshlawtcexsapabaui.supabase.co/functions/v1/identity-api/user/profile/sign-avatar-url" \
  -H "Authorization: Bearer $SOSOAPI_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  --data-binary @request.json

JavaScript

// Server-side JavaScript. Do not print tokens or credential-bearing responses.
const token = process.env.SOSOAPI_ACCESS_TOKEN;
if (!token) throw new Error("Set an accepted credential for this operation");
const response = await fetch("https://gqeshlawtcexsapabaui.supabase.co/functions/v1/identity-api/user/profile/sign-avatar-url", {
  method: "POST",
  headers: { "Content-Type": "application/json", Authorization: "Bearer " + token },
  body: JSON.stringify({
  "filename": "example.png",
  "content_type": "image/png"
})
});
const result = await response.json();
// Check response.ok, the operation-specific body and completion state before continuing.

CLI

npx sosoapi api post /identity-api/user/profile/sign-avatar-url < request.json

虛構回應範例

{
  "action": "sign-avatar-url",
  "path": "example",
  "signed_url": "https://example.com/media.png"
}

相關工具及指南

MCP: sosoapi_sign_avatar_upload