讀取輿情監測來源覆蓋範圍

概覽

讀取支援的輿情監測來源覆蓋範圍、字面查詢規則和收集限制；僅含中繼資料。需要 agent:research。

成功 HTTP 回應可能表示請求已接受，並非已完成。背景工作請儲存回傳 ID，持續檢查同一操作直到完成。已排程或已接受的貼文，只有平台確認後才算已發布；用戶端逾時無法證明結果。

驗證與權限

接受的憑證類別

user_session, delegated_oauth, personal_access_token

委派能力

agent:research

最低工作空間角色

viewer

存取範圍

此使用者有權存取的資源

需要所有工作空間同意

否

變更狀態

否

操作完成時

current authorized Listening data; indexed public sample is partial and is not a verified account mention

權杖只能使用其擁有者持有的權利。每次請求會檢查工作空間成員資格、資源擁有權、所選工作空間及已授予能力。core 與 full 設定檔只變更顯示的工具，不會授予存取權。

請求欄位

「必填」是指在其父物件及所選分支內必填。必填子欄位不會使選填父物件變成必填。下列規則與欄位名稱均複製自契約。

{
  "$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)$"
    }
  },
  "required": [
    "workspace_id"
  ],
  "additionalProperties": false
}

回應與完成

成功 HTTP 狀態：200。操作完成時： current authorized Listening data; indexed public sample is partial and is not a verified account mention.

成功 HTTP 回應可能表示請求已接受，並非已完成。背景工作請儲存回傳 ID，持續檢查同一操作直到完成。已排程或已接受的貼文，只有平台確認後才算已發布；用戶端逾時無法證明結果。

「必填」是指在其父物件及所選分支內必填。必填子欄位不會使選填父物件變成必填。下列規則與欄位名稱均複製自契約。

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "source": {
      "type": "string",
      "const": "hacker_news"
    },
    "query_mode": {
      "type": "string",
      "const": "literal_phrase"
    },
    "include_mode": {
      "type": "string",
      "const": "all_literal_substrings"
    },
    "exclude_mode": {
      "type": "string",
      "const": "any_literal_substring"
    },
    "item_types": {
      "type": "array",
      "prefixItems": [
        {
          "type": "string",
          "const": "story"
        },
        {
          "type": "string",
          "const": "comment"
        }
      ],
      "items": false,
      "minItems": 2,
      "maxItems": 2
    },
    "coverage": {
      "type": "string",
      "const": "partial_indexed_sample"
    },
    "exhaustive": {
      "type": "boolean",
      "const": false
    },
    "limits": {
      "type": "object",
      "properties": {
        "streams_per_workspace": {
          "type": "number",
          "const": 5
        },
        "minimum_cadence_minutes": {
          "type": "number",
          "const": 30
        },
        "lookback_days": {
          "type": "number",
          "const": 7
        },
        "content_retention_days": {
          "type": "number",
          "const": 7
        },
        "results_per_run": {
          "type": "number",
          "const": 20
        },
        "provider_gets_per_run": {
          "type": "number",
          "const": 21
        },
        "workspace_provider_gets_per_day": {
          "type": "number",
          "const": 500
        },
        "shared_searches_per_hour": {
          "type": "number",
          "const": 5000
        }
      },
      "required": [
        "streams_per_workspace",
        "minimum_cadence_minutes",
        "lookback_days",
        "content_retention_days",
        "results_per_run",
        "provider_gets_per_run",
        "workspace_provider_gets_per_day",
        "shared_searches_per_hour"
      ]
    }
  },
  "required": [
    "source",
    "query_mode",
    "include_mode",
    "exclude_mode",
    "item_types",
    "coverage",
    "exhaustive",
    "limits"
  ]
}

錯誤與安全重試

檢查 HTTP 狀態和回應內容。400 驗證錯誤可能包含 ZodError；處理常式錯誤使用 error、message 和 code 欄位。保留 request_id 或 x-request-id 以便診斷，但不要保留憑證。先解決 401/403 存取錯誤再重試，並在收到 429 時遵循 Retry-After。如寫入結果不確定或回傳 5xx，先讀取現有結果。僅在支援時重複使用冪等鍵；重試行為因操作而異，並不保證恰好傳送一次。

範例

這些範例使用已依結構描述檢查的虛構值。請將 ID 替換為您有權使用的 ID、將媒體替換為已就緒素材，並將日期替換為已確認的發布時間。提交寫入前，請檢查帳號資格。本頁不會傳送 API 請求。

在伺服器上將 SOSOAPI_ACCESS_TOKEN 設為此操作接受的憑證，且不要放入瀏覽器程式碼。AI 代理程式請使用 sosoapi auth login 透過瀏覽器登入，並由 CLI 更新憑證。

request.json

{
  "workspace_id": "11111111-1111-4111-8111-111111111111"
}

cURL

curl --request POST \
  "https://gqeshlawtcexsapabaui.supabase.co/functions/v1/listening-api/capabilities" \
  -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/listening-api/capabilities", {
  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 /listening-api/capabilities < request.json

合成回應範例

{
  "source": "hacker_news",
  "query_mode": "literal_phrase",
  "include_mode": "all_literal_substrings",
  "exclude_mode": "any_literal_substring",
  "item_types": [
    "story",
    "comment"
  ],
  "coverage": "partial_indexed_sample",
  "exhaustive": false,
  "limits": {
    "streams_per_workspace": 5,
    "minimum_cadence_minutes": 30,
    "lookback_days": 7,
    "content_retention_days": 7,
    "results_per_run": 20,
    "provider_gets_per_run": 21,
    "workspace_provider_gets_per_day": 500,
    "shared_searches_per_hour": 5000
  }
}

相關工具與指南

MCP： sosoapi_listening_capabilities