舆情监测及提及
读取舆情监测来源覆盖范围
读取支援的舆情监测来源覆盖范围、字面查询规则和收集限制;仅含中继数据。需要 agent:research。
POST /listening-api/capabilities契约审核日期: · sha256:ab393e91e9b7f18a
概览
读取支援的舆情监测来源覆盖范围、字面查询规则和收集限制;仅含中继数据。需要 agent:research。
成功 HTTP 响应可能表示请求已接受,并非已完成。背景工作请存储返回 ID,持续检查同一操作直到完成。已排程或已接受的帖子,只有平台确认后才算已发布;客户端逾时无法证明结果。
验证与权限
令牌只能使用其所有者持有的权利。每次请求会检查工作区成员资格、资源拥有权、所选工作区及已授予能力。core 与 full 配置只变更显示的工具,不会授予访问权限。
请求字段
「必填」是指在其父对象及所选分支内必填。必填子字段不会使可选父对象变成必填。下列规则与字段名称均复制自契约。
| 字段 / 分支 | 类型 / 必填 | 约束 |
|---|---|---|
$ | object在父对象中必填 |
|
workspace_id | string在父对象中必填 |
|
完整 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)$"
}
},
"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,持续检查同一操作直到完成。已排程或已接受的帖子,只有平台确认后才算已发布;客户端逾时无法证明结果。
「必填」是指在其父对象及所选分支内必填。必填子字段不会使可选父对象变成必填。下列规则与字段名称均复制自契约。
| 字段 / 分支 | 类型 / 必填 | 约束 |
|---|---|---|
$ | object在父对象中必填 | — |
source | string在父对象中必填 |
|
query_mode | string在父对象中必填 |
|
include_mode | string在父对象中必填 |
|
exclude_mode | string在父对象中必填 |
|
item_types | array在父对象中必填 |
|
item_types[0] | string在父对象中必填 |
|
item_types[1] | string在父对象中必填 |
|
coverage | string在父对象中必填 |
|
exhaustive | boolean在父对象中必填 |
|
limits | object在父对象中必填 | — |
limits.streams_per_workspace | number在父对象中必填 |
|
limits.minimum_cadence_minutes | number在父对象中必填 |
|
limits.lookback_days | number在父对象中必填 |
|
limits.content_retention_days | number在父对象中必填 |
|
limits.results_per_run | number在父对象中必填 |
|
limits.provider_gets_per_run | number在父对象中必填 |
|
limits.workspace_provider_gets_per_day | number在父对象中必填 |
|
limits.shared_searches_per_hour | number在父对象中必填 |
|
完整 JSON Schema
{
"$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,先读取现有结果。仅在支持时复用幂等键;重试行为因操作而异,并不保证恰好交付一次。
故障排查指南示例
这些示例使用已依schema检查的虚构值。请将 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.jsonJavaScript
// 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
}
}