輿情監測及提及
讀取輿情監測符合項目
讀取目前單一不可信的 Hacker News 符合項目;字面查詢符合不等於經驗證的帳戶提及。需要 agent:research。
POST /listening-api/results/get契約檢閱日期: · sha256:ab393e91e9b7f18a
概覽
讀取目前單一不可信的 Hacker News 符合項目;字面查詢符合不等於經驗證的帳戶提及。需要 agent:research。
成功 HTTP 回應可能表示請求已接受,並非已完成。背景工作請儲存回傳 ID,持續檢查同一操作直到完成。已排程或已接受的貼文,只有平台確認後才算已發布;用戶端逾時無法證明結果。
驗證與權限
權杖只能使用其擁有者持有的權利。每次請求會檢查工作空間成員資格、資源擁有權、所選工作空間及已授予能力。core 與 full 設定檔只變更顯示的工具,不會授予存取權。
請求欄位
「必填」是指在其父物件及所選分支內必填。必填子欄位不會使選填父物件變成必填。下列規則與欄位名稱均複製自契約。
| 欄位 / 分支 | 類型 / 必填 | 約束 |
|---|---|---|
$ | object在父物件中必填 |
|
workspace_id | string在父物件中必填 |
|
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)$"
},
"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",
"id"
],
"additionalProperties": false
}回應與完成
成功 HTTP 狀態:200。操作完成時: current authorized Listening data; indexed public sample is partial and is not a verified account mention.
成功 HTTP 回應可能表示請求已接受,並非已完成。背景工作請儲存回傳 ID,持續檢查同一操作直到完成。已排程或已接受的貼文,只有平台確認後才算已發布;用戶端逾時無法證明結果。
「必填」是指在其父物件及所選分支內必填。必填子欄位不會使選填父物件變成必填。下列規則與欄位名稱均複製自契約。
| 欄位 / 分支 | 類型 / 必填 | 約束 |
|---|---|---|
$ | object在父物件中必填 | — |
result | object在父物件中必填 | — |
result.id | string在父物件中必填 |
|
result.workspace_id | string在父物件中必填 |
|
result.stream_id | string在父物件中必填 |
|
result.run_id | string在父物件中必填 |
|
result.revision | integer在父物件中必填 |
|
result.source | string在父物件中必填 |
|
result.source_item_id | string在父物件中必填 |
|
result.canonical_url | string在父物件中必填 |
|
result.title | string | null在父物件中必填 | — |
result.titleanyOf 1 | string在父物件中必填 |
|
result.titleanyOf 2 | null在父物件中必填 | — |
result.excerpt | string | null在父物件中必填 | — |
result.excerptanyOf 1 | string在父物件中必填 |
|
result.excerptanyOf 2 | null在父物件中必填 | — |
result.author | string | null在父物件中必填 | — |
result.authoranyOf 1 | string在父物件中必填 |
|
result.authoranyOf 2 | null在父物件中必填 | — |
result.published_at | string | null在父物件中必填 | — |
result.published_atanyOf 1 | string在父物件中必填 |
|
result.published_atanyOf 2 | null在父物件中必填 | — |
result.retrieved_at | string在父物件中必填 |
|
result.source_checked_at | string在父物件中必填 |
|
result.expires_at | string在父物件中必填 |
|
result.availability | string在父物件中必填 |
|
result.metrics | object在父物件中必填 | — |
result.metrics.score | integer | null在父物件中必填 | — |
result.metrics.scoreanyOf 1 | integer在父物件中必填 |
|
result.metrics.scoreanyOf 2 | null在父物件中必填 | — |
result.metrics.replies | integer | null在父物件中必填 | — |
result.metrics.repliesanyOf 1 | integer在父物件中必填 |
|
result.metrics.repliesanyOf 2 | null在父物件中必填 | — |
result.handled | boolean在父物件中必填 | — |
result.archived | boolean在父物件中必填 | — |
result.match_kind | string在父物件中必填 |
|
result.coverage | string在父物件中必填 |
|
result.sentiment | null在父物件中必填 | — |
完整 JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"result": {
"type": "object",
"properties": {
"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)$"
},
"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)$"
},
"stream_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)$"
},
"run_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)$"
},
"revision": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"source": {
"type": "string",
"const": "hacker_news"
},
"source_item_id": {
"type": "string",
"pattern": "^[1-9][0-9]{0,15}$"
},
"canonical_url": {
"type": "string",
"pattern": "^https:\\/\\/news\\.ycombinator\\.com\\/item\\?id=[1-9][0-9]{0,15}$"
},
"title": {
"anyOf": [
{
"type": "string",
"maxLength": 500
},
{
"type": "null"
}
]
},
"excerpt": {
"anyOf": [
{
"type": "string",
"maxLength": 4000
},
{
"type": "null"
}
]
},
"author": {
"anyOf": [
{
"type": "string",
"maxLength": 100
},
{
"type": "null"
}
]
},
"published_at": {
"anyOf": [
{
"type": "string",
"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)))$",
"format": "date-time"
},
{
"type": "null"
}
]
},
"retrieved_at": {
"type": "string",
"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)))$",
"format": "date-time"
},
"source_checked_at": {
"type": "string",
"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)))$",
"format": "date-time"
},
"expires_at": {
"type": "string",
"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)))$",
"format": "date-time"
},
"availability": {
"type": "string",
"enum": [
"available",
"removed",
"expired",
"unavailable"
]
},
"metrics": {
"type": "object",
"properties": {
"score": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"replies": {
"anyOf": [
{
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
}
},
"required": [
"score",
"replies"
]
},
"handled": {
"type": "boolean"
},
"archived": {
"type": "boolean"
},
"match_kind": {
"type": "string",
"const": "literal_query_match"
},
"coverage": {
"type": "string",
"const": "partial_indexed_sample"
},
"sentiment": {
"type": "null"
}
},
"required": [
"id",
"workspace_id",
"stream_id",
"run_id",
"revision",
"source",
"source_item_id",
"canonical_url",
"title",
"excerpt",
"author",
"published_at",
"retrieved_at",
"source_checked_at",
"expires_at",
"availability",
"metrics",
"handled",
"archived",
"match_kind",
"coverage",
"sentiment"
]
}
},
"required": [
"result"
]
}錯誤與安全重試
檢查 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",
"id": "30000000-0000-4000-8000-000000000005"
}cURL
curl --request POST \
"https://gqeshlawtcexsapabaui.supabase.co/functions/v1/listening-api/results/get" \
-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/results/get", {
method: "POST",
headers: { "Content-Type": "application/json", Authorization: "Bearer " + token },
body: JSON.stringify({
"workspace_id": "11111111-1111-4111-8111-111111111111",
"id": "30000000-0000-4000-8000-000000000005"
})
});
const result = await response.json();
// Check response.ok, the operation-specific body and completion state before continuing.CLI
npx sosoapi api post /listening-api/results/get < request.json合成回應範例
{
"result": {
"id": "30000000-0000-4000-8000-000000000005",
"workspace_id": "11111111-1111-4111-8111-111111111111",
"stream_id": "30000000-0000-4000-8000-000000000004",
"run_id": "30000000-0000-4000-8000-000000000009",
"revision": 1,
"source": "hacker_news",
"source_item_id": "9999999999999999",
"canonical_url": "https://news.ycombinator.com/item?id=9999999999999999",
"title": null,
"excerpt": null,
"author": null,
"published_at": null,
"retrieved_at": "2099-01-15T09:00:00Z",
"source_checked_at": "2099-01-15T09:00:00Z",
"expires_at": "2099-01-16T09:00:00Z",
"availability": "unavailable",
"metrics": {
"score": null,
"replies": null
},
"handled": false,
"archived": false,
"match_kind": "literal_query_match",
"coverage": "partial_indexed_sample",
"sentiment": null
}
}