媒体与素材

查询素材

依 asset_type、source 或 tag 寻找工作区素材；返回一页资料（limit 最多 100，另加 offset）与总数。请明确传入 workspace_id。

POST /assets-api/list

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

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

概览

依 asset_type、source 或 tag 寻找工作区素材；返回一页资料（limit 最多 100，另加 offset）与总数。请明确传入 workspace_id。

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

验证与权限

接受的凭证类别: user_session, delegated_oauth, personal_access_token
委派能力: agent:operate
最低工作区角色: viewer
访问范围: 此用户有权访问的资源
需要所有工作区同意: 否
变更状态: 否
操作完成时: 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 \| array`可选／项目	—
`asset_type`anyOf 1	`string`可选／项目	`enum: ["text","image","video","audio"]`
`asset_type`anyOf 2	`array`可选／项目	—
`asset_type[]`anyOf 2	`string`可选／项目	`enum: ["text","image","video","audio"]`
`source`	`string`可选／项目	`maxLength: 64`
`tag`	`string`可选／项目	`maxLength: 64`
`limit`	`integer`可选／项目	`minimum: 1` `maximum: 100`
`offset`	`integer`可选／项目	跳过的行数。最多支持 100000；超出返回 400 OFFSET_TOO_LARGE。优先使用筛选，避免深度分页。 `minimum: 0` `maximum: 9007199254740991`
`include_version`	`boolean`可选／项目	可选。true 会将资源版本加入响应。 —

完整 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": {
      "anyOf": [
        {
          "type": "string",
          "enum": [
            "text",
            "image",
            "video",
            "audio"
          ]
        },
        {
          "type": "array",
          "items": {
            "type": "string",
            "enum": [
              "text",
              "image",
              "video",
              "audio"
            ]
          }
        }
      ]
    },
    "source": {
      "type": "string",
      "maxLength": 64
    },
    "tag": {
      "type": "string",
      "maxLength": 64
    },
    "limit": {
      "type": "integer",
      "minimum": 1,
      "maximum": 100
    },
    "offset": {
      "description": "Rows to skip. Served up to 100000; beyond it 400 OFFSET_TOO_LARGE. Prefer filters to paging deep.",
      "type": "integer",
      "minimum": 0,
      "maximum": 9007199254740991
    },
    "include_version": {
      "description": "Optional. true adds the resource version to the answer.",
      "type": "boolean"
    }
  },
  "additionalProperties": false
}

响应与完成

成功 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[].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)$"`
`assets[].user_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)$"`
`assets[].asset_type`	`string`在父对象中必填	`enum: ["text","image","video","audio"]`
`assets[].asset_url`	`string \| null`在父对象中必填	—
`assets[].asset_url`anyOf 1	`string`在父对象中必填	—
`assets[].asset_url`anyOf 2	`null`在父对象中必填	—
`assets[].preview_url`	`string \| null`可选／项目	由工作区授权的暂时读取 URL。preview_expires_at 后，请通过素材读取／清单重新获取；保留 asset_url 作为持久媒体身分。 —
`assets[].preview_url`anyOf 1	`string`可选／项目	`format: "uri"`
`assets[].preview_url`anyOf 2	`null`可选／项目	—
`assets[].preview_expires_at`	`string \| null`可选／项目	—
`assets[].preview_expires_at`anyOf 1	`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))$"`
`assets[].preview_expires_at`anyOf 2	`null`可选／项目	—
`assets[].title`	`string \| null`在父对象中必填	—
`assets[].title`anyOf 1	`string`在父对象中必填	—
`assets[].title`anyOf 2	`null`在父对象中必填	—
`assets[].description`	`string \| null`在父对象中必填	—
`assets[].description`anyOf 1	`string`在父对象中必填	—
`assets[].description`anyOf 2	`null`在父对象中必填	—
`assets[].tags`	`array \| null`在父对象中必填	—
`assets[].tags`anyOf 1	`array`在父对象中必填	—
`assets[].tags[]`anyOf 1	`string`可选／项目	—
`assets[].tags`anyOf 2	`null`在父对象中必填	—
`assets[].metadata`	`object \| null`在父对象中必填	—
`assets[].metadata`anyOf 1	`object`在父对象中必填	`additionalProperties: {}`
`assets[].metadata.*`anyOf 1	`any JSON value`可选／项目	—
`assets[].metadata`anyOf 2	`null`在父对象中必填	—
`assets[].source`	`string \| null`可选／项目	—
`assets[].source`anyOf 1	`string`可选／项目	—
`assets[].source`anyOf 2	`null`可选／项目	—
`assets[].source_metadata`	`object \| null`可选／项目	—
`assets[].source_metadata`anyOf 1	`object`可选／项目	`additionalProperties: {}`
`assets[].source_metadata.*`anyOf 1	`any JSON value`可选／项目	—
`assets[].source_metadata`anyOf 2	`null`可选／项目	—
`assets[].created_at`	`string`在父对象中必填	—
`assets[].version`	`integer`可选／项目	`maximum: 9007199254740991` `exclusiveMinimum: 0`
`total`	`integer`在父对象中必填	`minimum: 0` `maximum: 9007199254740991`

完整 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"
              }
            ]
          },
          "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)$"
          },
          "user_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": [
              "text",
              "image",
              "video",
              "audio"
            ]
          },
          "asset_url": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "preview_url": {
            "description": "Workspace-authorized temporary read URL. Refresh through Asset read/list after preview_expires_at; keep asset_url as persisted media identity.",
            "anyOf": [
              {
                "type": "string",
                "format": "uri"
              },
              {
                "type": "null"
              }
            ]
          },
          "preview_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))$"
              },
              {
                "type": "null"
              }
            ]
          },
          "title": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "description": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "tags": {
            "anyOf": [
              {
                "type": "array",
                "items": {
                  "type": "string"
                }
              },
              {
                "type": "null"
              }
            ]
          },
          "metadata": {
            "anyOf": [
              {
                "type": "object",
                "propertyNames": {
                  "type": "string"
                },
                "additionalProperties": {}
              },
              {
                "type": "null"
              }
            ]
          },
          "source": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "source_metadata": {
            "anyOf": [
              {
                "type": "object",
                "propertyNames": {
                  "type": "string"
                },
                "additionalProperties": {}
              },
              {
                "type": "null"
              }
            ]
          },
          "created_at": {
            "type": "string"
          },
          "version": {
            "type": "integer",
            "exclusiveMinimum": 0,
            "maximum": 9007199254740991
          }
        },
        "required": [
          "id",
          "workspace_id",
          "user_id",
          "asset_type",
          "asset_url",
          "title",
          "description",
          "tags",
          "metadata",
          "created_at"
        ]
      }
    },
    "total": {
      "type": "integer",
      "minimum": 0,
      "maximum": 9007199254740991
    }
  },
  "required": [
    "assets",
    "total"
  ]
}

错误与安全重试

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

{}

cURL

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

CLI

npx sosoapi api post /assets-api/list < request.json

合成响应示例

{
  "assets": [],
  "total": 0
}

MCP： sosoapi_query_assets

全部 API 操作验证与权限