リスニングとメンション
リスニング収集実行を探す
UUID ページングで単一ストリームの収集実行を探します。結果は限定的な部分サンプルを表します。agent:research が必要です。
POST /listening-api/runs/query契約確認日： · sha256:ab393e91e9b7f18a
概要
UUID ページングで単一ストリームの収集実行を探します。結果は限定的な部分サンプルを表します。agent:research が必要です。
HTTP成功は完了ではなく受理の場合があります。バックグラウンド処理はIDを保存し、同じ処理を完了まで確認します。予約・受理された投稿はプラットフォーム確認後のみ公開済みです。タイムアウトだけでは結果を判断できません。
認証と権限
トークンは所有者の権利内でのみ使えます。各要求で所属、リソース所有権、選択ワークスペース、付与機能を確認します。coreとfullは表示だけを変え、アクセスは付与しません。
リクエストのフィールド
必須とは、親オブジェクトと選択分岐内で必須という意味です。必須の子があっても任意の親は必須になりません。以下のルールとフィールド名は契約から転記しています。
| フィールド／分岐 | 型／必須 | 制約 |
|---|---|---|
$ | object親要素内で必須 |
|
workspace_id | string親要素内で必須 |
|
cursor | string任意／項目 |
|
limit | integer任意／項目 |
|
stream_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)$"
},
"cursor": {
"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)$"
},
"limit": {
"default": 25,
"type": "integer",
"minimum": 1,
"maximum": 50
},
"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)$"
}
},
"required": [
"workspace_id",
"stream_id"
],
"additionalProperties": false
}レスポンスと完了条件
成功時のHTTPステータス： 200. 操作完了時： current authorized Listening data; indexed public sample is partial and is not a verified account mention.
HTTP成功は完了ではなく受理の場合があります。バックグラウンド処理はIDを保存し、同じ処理を完了まで確認します。予約・受理された投稿はプラットフォーム確認後のみ公開済みです。タイムアウトだけでは結果を判断できません。
必須とは、親オブジェクトと選択分岐内で必須という意味です。必須の子があっても任意の親は必須になりません。以下のルールとフィールド名は契約から転記しています。
| フィールド／分岐 | 型／必須 | 制約 |
|---|---|---|
$ | object親要素内で必須 | — |
items | array親要素内で必須 |
|
items[] | object任意／項目 | — |
items[].id | string親要素内で必須 |
|
items[].workspace_id | string親要素内で必須 |
|
items[].stream_id | string親要素内で必須 |
|
items[].stream_revision | integer親要素内で必須 |
|
items[].query_revision | integer親要素内で必須 |
|
items[].generation | integer親要素内で必須 |
|
items[].source | string親要素内で必須 |
|
items[].status | string親要素内で必須 |
|
items[].reason | string | null親要素内で必須 | — |
items[].reasonanyOf 1 | string親要素内で必須 |
|
items[].reasonanyOf 2 | null親要素内で必須 | — |
items[].requested_at | string親要素内で必須 |
|
items[].completed_at | string | null親要素内で必須 | — |
items[].completed_atanyOf 1 | string親要素内で必須 |
|
items[].completed_atanyOf 2 | null親要素内で必須 | — |
items[].retry_after | string | null親要素内で必須 | — |
items[].retry_afteranyOf 1 | string親要素内で必須 |
|
items[].retry_afteranyOf 2 | null親要素内で必須 | — |
items[].result_count | integer親要素内で必須 |
|
items[].provider_gets | integer親要素内で必須 |
|
items[].coverage | string親要素内で必須 |
|
items[].exhaustive | boolean親要素内で必須 |
|
items[].method_version | string親要素内で必須 |
|
items[].observation_counts | object親要素内で必須 | — |
items[].observation_counts.source_items | integer親要素内で必須 |
|
items[].observation_counts.matched_items | integer親要素内で必須 |
|
items[].observation_counts.removed_items | integer親要素内で必須 |
|
items[].observation_counts.unavailable_items | integer親要素内で必須 |
|
items[].window_since | string親要素内で必須 |
|
items[].window_until | string親要素内で必須 |
|
items[].page | integer親要素内で必須 |
|
items[].next_page_available | boolean親要素内で必須 | — |
next_cursor | string | null親要素内で必須 | — |
next_cursoranyOf 1 | string親要素内で必須 |
|
next_cursoranyOf 2 | null親要素内で必須 | — |
完全なJSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"items": {
"maxItems": 50,
"type": "array",
"items": {
"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)$"
},
"stream_revision": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"query_revision": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"generation": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"source": {
"type": "string",
"const": "hacker_news"
},
"status": {
"type": "string",
"enum": [
"queued",
"running",
"partial",
"succeeded",
"deferred",
"cancelled",
"failed"
]
},
"reason": {
"anyOf": [
{
"type": "string",
"enum": [
"collection_paused",
"authorization_expired",
"authorization_revoked",
"stream_changed",
"stream_paused",
"stream_deleted",
"cancelled",
"workspace_budget",
"source_budget",
"run_budget",
"source_rate_limited",
"source_unavailable",
"source_invalid",
"execution_exhausted"
]
},
{
"type": "null"
}
]
},
"requested_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"
},
"completed_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"
}
]
},
"retry_after": {
"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"
}
]
},
"result_count": {
"type": "integer",
"minimum": 0,
"maximum": 20
},
"provider_gets": {
"type": "integer",
"minimum": 0,
"maximum": 21
},
"coverage": {
"type": "string",
"const": "partial_indexed_sample"
},
"exhaustive": {
"type": "boolean",
"const": false
},
"method_version": {
"type": "string",
"const": "hn-indexed-literal-sample/v1"
},
"observation_counts": {
"type": "object",
"properties": {
"source_items": {
"type": "integer",
"minimum": 0,
"maximum": 20
},
"matched_items": {
"type": "integer",
"minimum": 0,
"maximum": 20
},
"removed_items": {
"type": "integer",
"minimum": 0,
"maximum": 20
},
"unavailable_items": {
"type": "integer",
"minimum": 0,
"maximum": 20
}
},
"required": [
"source_items",
"matched_items",
"removed_items",
"unavailable_items"
]
},
"window_since": {
"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"
},
"window_until": {
"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"
},
"page": {
"type": "integer",
"minimum": 0,
"maximum": 49
},
"next_page_available": {
"type": "boolean"
}
},
"required": [
"id",
"workspace_id",
"stream_id",
"stream_revision",
"query_revision",
"generation",
"source",
"status",
"reason",
"requested_at",
"completed_at",
"retry_after",
"result_count",
"provider_gets",
"coverage",
"exhaustive",
"method_version",
"observation_counts",
"window_since",
"window_until",
"page",
"next_page_available"
]
}
},
"next_cursor": {
"anyOf": [
{
"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)$"
},
{
"type": "null"
}
]
}
},
"required": [
"items",
"next_cursor"
]
}エラーと安全な再試行
HTTPステータスとレスポンス本文を確認します。400の検証エラーにはZodErrorが含まれる場合があります。ハンドラーエラーはerror、message、codeを使用します。診断用にrequest_idまたはx-request-idを保持し、認証情報は含めないでください。401/403はアクセス問題を解消してから再試行し、429はRetry-Afterに従います。書き込み結果が不確か、または5xxの場合は、まず既存の結果を取得してください。冪等性キーは対応する操作でのみ再利用します。再試行の挙動は操作ごとに異なり、厳密に一回の配信は保証しません。
トラブルシューティングガイド例
スキーマ確認済みの架空値の例です。認可されたID、準備済みメディア、確認済みの公開日時に置き換え、書き込み前に適格性を確認してください。このページはAPIを呼びません。
サーバーのSOSOAPI_ACCESS_TOKENに操作が受け付ける認証情報を設定し、ブラウザーコードに含めないでください。AIエージェントはsosoapi auth loginでブラウザーログインし、CLIに更新を任せます。
request.json
{
"workspace_id": "11111111-1111-4111-8111-111111111111",
"stream_id": "11111111-1111-4111-8111-111111111111"
}cURL
curl --request POST \
"https://gqeshlawtcexsapabaui.supabase.co/functions/v1/listening-api/runs/query" \
-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/runs/query", {
method: "POST",
headers: { "Content-Type": "application/json", Authorization: "Bearer " + token },
body: JSON.stringify({
"workspace_id": "11111111-1111-4111-8111-111111111111",
"stream_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/runs/query < request.json合成レスポンス例
{
"items": [],
"next_cursor": null
}