媒体与素材

生成素材上传签名

获取工作区媒体对象的签署上传 URL。将文件位元组上传至该 URL，再调用 upload/complete 登记素材。此端点不会替你读取本地文件。

POST /assets-api/upload/sign

契约审核日期： 2026-10-21 · sha256:563d2d581da0ad29

阅读 Markdown 下载公开契约下载 OpenAPI

概览

获取工作区媒体对象的签署上传 URL。将文件位元组上传至该 URL，再调用 upload/complete 登记素材。此端点不会替你读取本地文件。

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

验证与权限

接受的凭证类别: user_session, delegated_oauth, personal_access_token
委派能力: agent:operate
最低工作区角色: editor
访问范围: 此用户有权访问的资源
需要所有工作区同意: 否
变更状态: 是
操作完成时: synchronous_http_response

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

请求字段

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

请求字段
字段 / 分支	类型 / 必填	约束
`$`	`object`在父对象中必填	`additionalProperties: false`
`workspace_id`	`string`在父对象中必填	`format: "uuid"` `pattern: "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}\|00000000-0000-0000-0000-000000000000\|ffffffff-ffff-ffff-ffff-ffffffffffff)$"`
`asset_type`	`string`在父对象中必填	`enum: ["image","video"]`
`filename`	`string`在父对象中必填	`minLength: 1` `maxLength: 256`
`content_type`	`string`在父对象中必填	`minLength: 1` `maxLength: 120`
`byte_size`	`integer`在父对象中必填	将要 PUT 的正文确切字节长度（最大 500 MiB）。此值作为 Content-Length 签入上传 URL，计入工作区存储限制，并在完成上传时再次检查：超过声明长度的对象会被拒绝并移除。 `minimum: 1` `maximum: 524288000`
`content_sha256`	`string`在父对象中必填	`pattern: "^[0-9a-f]{64}$"`
`title`	`string`可选／项目	`maxLength: 200`

完整 JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "workspace_id": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    },
    "asset_type": {
      "type": "string",
      "enum": [
        "image",
        "video"
      ]
    },
    "filename": {
      "type": "string",
      "minLength": 1,
      "maxLength": 256
    },
    "content_type": {
      "type": "string",
      "minLength": 1,
      "maxLength": 120
    },
    "byte_size": {
      "type": "integer",
      "minimum": 1,
      "maximum": 524288000,
      "description": "Exact length in bytes of the body you will PUT (max 500 MiB). It is signed into the upload URL as Content-Length, counted against the workspace storage limit, and checked again when you complete the upload: an object longer than declared is rejected and removed."
    },
    "content_sha256": {
      "type": "string",
      "pattern": "^[0-9a-f]{64}$"
    },
    "title": {
      "type": "string",
      "maxLength": 200
    }
  },
  "required": [
    "workspace_id",
    "asset_type",
    "filename",
    "content_type",
    "byte_size",
    "content_sha256"
  ],
  "additionalProperties": false
}

响应与完成

成功 HTTP 状态：200。操作完成时： synchronous_http_response.

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

响应与完成
字段 / 分支	类型 / 必填	约束
`$`	`object`在父对象中必填	—
`object_key`	`string`在父对象中必填	`minLength: 1`
`public_url`	`string`在父对象中必填	`format: "uri"`
`signed_url`	`string`在父对象中必填	`format: "uri"`
`upload_headers`	`object`在父对象中必填	—
`upload_headers.Content-Type`	`string`在父对象中必填	`minLength: 1`
`upload_headers.x-amz-checksum-sha256`	`string`在父对象中必填	`minLength: 1`
`expires_seconds`	`integer`在父对象中必填	`maximum: 9007199254740991` `exclusiveMinimum: 0`

完整 JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "object_key": {
      "type": "string",
      "minLength": 1
    },
    "public_url": {
      "type": "string",
      "format": "uri"
    },
    "signed_url": {
      "type": "string",
      "format": "uri"
    },
    "upload_headers": {
      "type": "object",
      "properties": {
        "Content-Type": {
          "type": "string",
          "minLength": 1
        },
        "x-amz-checksum-sha256": {
          "type": "string",
          "minLength": 1
        }
      },
      "required": [
        "Content-Type",
        "x-amz-checksum-sha256"
      ]
    },
    "expires_seconds": {
      "type": "integer",
      "exclusiveMinimum": 0,
      "maximum": 9007199254740991
    }
  },
  "required": [
    "object_key",
    "public_url",
    "signed_url",
    "upload_headers",
    "expires_seconds"
  ]
}

错误与安全重试

检查 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

{
  "workspace_id": "11111111-1111-4111-8111-111111111111",
  "asset_type": "image",
  "filename": "example.png",
  "content_type": "image/png",
  "byte_size": 1,
  "content_sha256": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
}

cURL

curl --request POST \
  "https://gqeshlawtcexsapabaui.supabase.co/functions/v1/assets-api/upload/sign" \
  -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/assets-api/upload/sign", {
  method: "POST",
  headers: { "Content-Type": "application/json", Authorization: "Bearer " + token },
  body: JSON.stringify({
  "workspace_id": "11111111-1111-4111-8111-111111111111",
  "asset_type": "image",
  "filename": "example.png",
  "content_type": "image/png",
  "byte_size": 1,
  "content_sha256": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
})
});
const result = await response.json();
// Check response.ok, the operation-specific body and completion state before continuing.

CLI

npx sosoapi api post /assets-api/upload/sign < request.json

合成响应示例

{
  "object_key": "example",
  "public_url": "https://example.com/media.png",
  "signed_url": "https://example.com/media.png",
  "upload_headers": {
    "Content-Type": "example",
    "x-amz-checksum-sha256": "example"
  },
  "expires_seconds": 1
}

MCP： sosoapi_upload_asset

全部 API 操作验证与权限