# 列出素材 标准 URL： https://sosoapi.ai/zh-hans/docs/api/assets-api-list-workspace 契约：sha256:563d2d581da0ad29 列出工作区素材，可按 kind（video、image、audio、cover、thumbnail、frame、video-source、branding）或 customer_ready_only 筛选，以 next_offset 分页。需要 workspace_id。 POST /assets-api/list-workspace ## 验证与权限 - **接受的凭证类别：** user_session、delegated_oauth、personal_access_token - **委派能力：** agent:operate - **最低工作区角色：** viewer - **访问范围：** 此用户获准访问的资源 - **需要所有工作区同意：** 否 - **变更状态：** 否 - **操作完成时：** synchronous_http_response 令牌只能使用其所有者持有的权利。每次请求会检查工作区成员资格、资源拥有权、所选工作区及已授予能力。core 与 full 配置只变更显示的工具，不会授予访问权限。 ## 请求字段 ```json { "$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)$" }, "kind": { "type": "string", "enum": [ "video", "image", "audio", "cover", "thumbnail", "frame", "video-source", "branding" ] }, "customer_ready_only": { "default": false, "type": "boolean" }, "limit": { "default": 24, "type": "integer", "minimum": 1, "maximum": 100 }, "offset": { "default": 0, "description": "Rows to skip. Served up to 100000; beyond it 400 OFFSET_TOO_LARGE.", "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "workspace_id" ] } ``` ## 响应与完成 成功 HTTP 状态：200 成功 HTTP 响应可能表示请求已接受，并非已完成。背景工作请存储返回 ID，持续检查同一操作直到完成。已排程或已接受的帖子，只有平台确认后才算已发布；客户端逾时无法证明结果。 ```json { "$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" } ] }, "asset_type": { "type": "string", "enum": [ "text", "image", "video", "audio" ] }, "asset_url": { "anyOf": [ { "type": "string", "format": "uri" }, { "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" } ] }, "created_at": { "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|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$" }, "readiness": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "ready", "not_ready" ] }, "reason_code": { "type": "string", "enum": [ "ready", "unsupported_kind", "missing_registered_media", "untrusted_workspace_object", "media_probe_missing_or_invalid" ] }, "message": { "type": "string", "minLength": 1, "maxLength": 500 } }, "required": [ "status", "reason_code", "message" ] } }, "required": [ "id", "asset_type", "asset_url", "title", "description", "tags", "created_at", "readiness" ] } }, "total": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "next_offset": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] } }, "required": [ "assets", "total", "next_offset" ] } ``` ## 错误与安全重试 检查 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 ```json { "workspace_id": "11111111-1111-4111-8111-111111111111" } ``` cURL ```bash curl --request POST \ "https://gqeshlawtcexsapabaui.supabase.co/functions/v1/assets-api/list-workspace" \ -H "Authorization: Bearer $SOSOAPI_ACCESS_TOKEN" \ -H "Content-Type: application/json" \ --data-binary @request.json ``` JavaScript ```js // 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-workspace", { 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 ```bash npx sosoapi api post /assets-api/list-workspace < request.json ``` 合成响应示例 ```json { "assets": [], "total": 0, "next_offset": null } ``` ## 相关工具与指南 MCP：sosoapi_list_assets [API 参考](https://sosoapi.ai/zh-hans/docs/api)