生成头像上传签名

概览

为已登录用户获取上传新头像的签署 URL（需要 filename 及 content_type）。此操作本身不会变更个人资料。

成功 HTTP 响应可能表示请求已接受，并非已完成。背景工作请存储返回 ID，持续检查同一操作直到完成。已排程或已接受的帖子，只有平台确认后才算已发布；客户端逾时无法证明结果。

验证与权限

接受的凭证类别

user_session, delegated_oauth, personal_access_token

委派能力

agent:operate

最低工作区角色

此契约没有最低工作区角色要求；拥有权与授权检查仍然适用。

访问范围

此用户有权访问的资源

需要所有工作区同意

否

变更状态

是

操作完成时

synchronous_http_response

令牌只能使用其所有者持有的权利。每次请求会检查工作区成员资格、资源拥有权、所选工作区及已授予能力。core 与 full 配置只变更显示的工具，不会授予访问权限。

请求字段

「必填」是指在其父对象及所选分支内必填。必填子字段不会使可选父对象变成必填。下列规则与字段名称均复制自契约。

{
  "$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，持续检查同一操作直到完成。已排程或已接受的帖子，只有平台确认后才算已发布；客户端逾时无法证明结果。

「必填」是指在其父对象及所选分支内必填。必填子字段不会使可选父对象变成必填。下列规则与字段名称均复制自契约。

{
  "$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；处理程序错误使用 error、message 和 code 字段。保留 request_id 或 x-request-id 以便诊断，但不要保留凭证。先解决 401/403 访问错误再重试，并在收到 429 时遵循 Retry-After。如写入结果不确定或返回 5xx，先读取现有结果。仅在支持时复用幂等键；重试行为因操作而异，并不保证恰好交付一次。

示例

这些示例使用已依schema检查的虚构值。请将 ID 替换为你有权使用的 ID、将媒体替换为已就绪素材，并将日期替换为已确认的发布时间。提交写入前，请检查账号资格。本页不会发送 API 请求。

在服务器上将 SOSOAPI_ACCESS_TOKEN 设为此操作接受的凭证，且不要放入浏览器代码。agent 请使用 sosoapi auth login 通过浏览器登录，并由 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