媒体与素材

获取素材存储清单

读取工作区已登记素材和已存储对象的分页清单，以审计存储。

POST /assets-api/storage/inventory

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

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

概览

读取工作区已登记素材和已存储对象的分页清单，以审计存储。

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

验证与权限

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

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

请求字段

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

请求字段
字段 / 分支	类型 / 必填	约束
`$`	`object`在父对象中必填	—
`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_cursor`	`integer`可选／项目	`maximum: 9007199254740991` `exclusiveMinimum: 0`
`object_continuation_token`	`string`可选／项目	`minLength: 1` `maxLength: 2048`
`continuation_token`	`string`可选／项目	`minLength: 1` `maxLength: 2048`
`limit`	`integer`可选／项目	`minimum: 1` `maximum: 200` `default: 100`

完整 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_cursor": {
      "type": "integer",
      "exclusiveMinimum": 0,
      "maximum": 9007199254740991
    },
    "object_continuation_token": {
      "type": "string",
      "minLength": 1,
      "maxLength": 2048
    },
    "continuation_token": {
      "type": "string",
      "minLength": 1,
      "maxLength": 2048
    },
    "limit": {
      "default": 100,
      "type": "integer",
      "minimum": 1,
      "maximum": 200
    }
  },
  "required": [
    "workspace_id"
  ]
}

响应与完成

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

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

响应与完成
字段 / 分支	类型 / 必填	约束
`$`	`object`在父对象中必填	—
`assets`	`array`在父对象中必填	—
`assets[]`	`object`可选／项目	—
`assets[].id`	`integer \| string`在父对象中必填	—
`assets[].id`anyOf 1	`integer`在父对象中必填	`minimum: -9007199254740991` `maximum: 9007199254740991`
`assets[].id`anyOf 2	`string`在父对象中必填	—
`assets[].object_key`	`string \| null`在父对象中必填	—
`assets[].object_key`anyOf 1	`string`在父对象中必填	—
`assets[].object_key`anyOf 2	`null`在父对象中必填	—
`assets[].classification`	`string`在父对象中必填	`enum: ["safe","warning_history","blocked_active"]`
`objects`	`array`在父对象中必填	—
`objects[]`	`object`可选／项目	—
`objects[].key`	`string`在父对象中必填	`minLength: 1`
`objects[].size`	`integer`在父对象中必填	`minimum: 0` `maximum: 9007199254740991`
`objects[].lastModified`	`string`在父对象中必填	—
`next_asset_cursor`	`integer \| null`在父对象中必填	—
`next_asset_cursor`anyOf 1	`integer`在父对象中必填	`maximum: 9007199254740991` `exclusiveMinimum: 0`
`next_asset_cursor`anyOf 2	`null`在父对象中必填	—
`next_object_continuation_token`	`string \| null`在父对象中必填	—
`next_object_continuation_token`anyOf 1	`string`在父对象中必填	—
`next_object_continuation_token`anyOf 2	`null`在父对象中必填	—
`continuation_token`	`string \| null`在父对象中必填	—
`continuation_token`anyOf 1	`string`在父对象中必填	—
`continuation_token`anyOf 2	`null`在父对象中必填	—

完整 JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "assets": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "anyOf": [
              {
                "type": "integer",
                "minimum": -9007199254740991,
                "maximum": 9007199254740991
              },
              {
                "type": "string"
              }
            ]
          },
          "object_key": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "classification": {
            "type": "string",
            "enum": [
              "safe",
              "warning_history",
              "blocked_active"
            ]
          }
        },
        "required": [
          "id",
          "object_key",
          "classification"
        ]
      }
    },
    "objects": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "key": {
            "type": "string",
            "minLength": 1
          },
          "size": {
            "type": "integer",
            "minimum": 0,
            "maximum": 9007199254740991
          },
          "lastModified": {
            "type": "string"
          }
        },
        "required": [
          "key",
          "size",
          "lastModified"
        ]
      }
    },
    "next_asset_cursor": {
      "anyOf": [
        {
          "type": "integer",
          "exclusiveMinimum": 0,
          "maximum": 9007199254740991
        },
        {
          "type": "null"
        }
      ]
    },
    "next_object_continuation_token": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ]
    },
    "continuation_token": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ]
    }
  },
  "required": [
    "assets",
    "objects",
    "next_asset_cursor",
    "next_object_continuation_token",
    "continuation_token"
  ]
}

错误与安全重试

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

cURL

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

CLI

npx sosoapi api post /assets-api/storage/inventory < request.json

合成响应示例

{
  "assets": [],
  "objects": [],
  "next_asset_cursor": null,
  "next_object_continuation_token": null,
  "continuation_token": null
}

MCP： sosoapi_get_asset_storage_inventory

全部 API 操作验证与权限