使用時先載入搜尋資料。亦可直接瀏覽下方分類。

媒體及素材

讀取素材儲存清單

分頁讀取工作空間已登記素材及儲存物件清單,供儲存核對。

POST /assets-api/storage/inventory

Contract 核對日期: · sha256:563d2d581da0ad29

概覽

分頁讀取工作空間已登記素材及儲存物件清單,供儲存核對。

HTTP 成功只表示呢次操作嘅回應。背景工作要保留回傳 ID,讀取同一操作直到文件指定嘅終態。接受請求、排程成功或客戶端逾時,都唔代表已發佈。

驗證及權限

接受嘅憑證類型
user_session, delegated_oauth, personal_access_token
委派權限
agent:operate
最低工作空間角色
viewer
存取範圍
已登入使用者及獲授權資源範圍
需要所有工作空間同意
唔係
會改動狀態
唔係
完成依據
synchronous_http_response

憑證唔能夠擴大持有人權限。實際操作仍會檢查工作空間成員資格、資源擁有權、已選工作空間及能力授權。Tool profile 只改變可見工具,唔會授權。

請求欄位

必填表示喺所屬物件及所選分支內必須提供;子欄位必填唔代表可選父物件變成必填。以下欄位名稱及規則直接來自 contract。

請求欄位
欄位/分支類型/必填限制
$object父物件內必填—
workspace_idstring父物件內必填
  • 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_cursorinteger可選/陣列項目
  • maximum: 9007199254740991
  • exclusiveMinimum: 0
object_continuation_tokenstring可選/陣列項目
  • minLength: 1
  • maxLength: 2048
continuation_tokenstring可選/陣列項目
  • minLength: 1
  • maxLength: 2048
limitinteger可選/陣列項目
  • 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.

HTTP 成功只表示呢次操作嘅回應。背景工作要保留回傳 ID,讀取同一操作直到文件指定嘅終態。接受請求、排程成功或客戶端逾時,都唔代表已發佈。

必填表示喺所屬物件及所選分支內必須提供;子欄位必填唔代表可選父物件變成必填。以下欄位名稱及規則直接來自 contract。

回應及完成條件
欄位/分支類型/必填限制
$object父物件內必填—
assetsarray父物件內必填—
assets[]object可選/陣列項目—
assets[].idinteger | string父物件內必填—
assets[].idanyOf 1integer父物件內必填
  • minimum: -9007199254740991
  • maximum: 9007199254740991
assets[].idanyOf 2string父物件內必填—
assets[].object_keystring | null父物件內必填—
assets[].object_keyanyOf 1string父物件內必填—
assets[].object_keyanyOf 2null父物件內必填—
assets[].classificationstring父物件內必填
  • enum: ["safe","warning_history","blocked_active"]
objectsarray父物件內必填—
objects[]object可選/陣列項目—
objects[].keystring父物件內必填
  • minLength: 1
objects[].sizeinteger父物件內必填
  • minimum: 0
  • maximum: 9007199254740991
objects[].lastModifiedstring父物件內必填—
next_asset_cursorinteger | null父物件內必填—
next_asset_cursoranyOf 1integer父物件內必填
  • maximum: 9007199254740991
  • exclusiveMinimum: 0
next_asset_cursoranyOf 2null父物件內必填—
next_object_continuation_tokenstring | null父物件內必填—
next_object_continuation_tokenanyOf 1string父物件內必填—
next_object_continuation_tokenanyOf 2null父物件內必填—
continuation_tokenstring | null父物件內必填—
continuation_tokenanyOf 1string父物件內必填—
continuation_tokenanyOf 2null父物件內必填—
完整 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;handler 錯誤可能係 error/message/code envelope。保留可用嘅 request_id 或 x-request-id,唔好記錄憑證。401/403先修正存取問題;429遵守 Retry-After。寫入結果未明或5xx時,先讀原有結果,再決定重試;只喺操作支援時重用 idempotency key,並冇通用重試或 exactly-once 保證。

問題排解指南

範例

以下虛構值已按 contract 驗證,唔係真實帳戶 ID、憑證或發佈紀錄。請用已授權範圍回傳嘅 ID、已準備好嘅素材及已審核排程取代,寫入前核對平台資格。此頁唔會呼叫 API。

喺伺服器環境設定 SOSOAPI_ACCESS_TOKEN,使用此操作接受嘅憑證。唔好放入瀏覽器程式。一般 agent 建議透過 sosoapi auth login 用瀏覽器 OAuth,由 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