研究及附來源簡報
讀取公開社群研究來源
透過 URL 及 mutation_id 擷取有範圍限制的公開社群資料;文字未經驗證,覆蓋僅限部分樣本。需要 agent:research。
POST /research-api/evidence/retrieve-social契約檢閱日期: · sha256:dadbfeb34d10743d
概覽
透過 URL 及 mutation_id 擷取有範圍限制的公開社群資料;文字未經驗證,覆蓋僅限部分樣本。需要 agent:research。
成功 HTTP 回應可能表示請求已接受,並非已完成。背景工作請儲存回傳 ID,持續檢查同一操作直到完成。已排程或已接受的貼文,只有平台確認後才算已發布;用戶端逾時無法證明結果。
驗證與權限
權杖只能使用其擁有者持有的權利。每次請求會檢查工作空間成員資格、資源擁有權、所選工作空間及已授予能力。core 與 full 設定檔只變更顯示的工具,不會授予存取權。
請求欄位
「必填」是指在其父物件及所選分支內必填。必填子欄位不會使選填父物件變成必填。下列規則與欄位名稱均複製自契約。
| 欄位 / 分支 | 類型 / 必填 | 約束 |
|---|---|---|
$ | object在父物件中必填 |
|
workspace_id | string在父物件中必填 |
|
mutation_id | string在父物件中必填 |
|
url | 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)$"
},
"mutation_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)$"
},
"url": {
"type": "string",
"maxLength": 2048,
"format": "uri"
}
},
"required": [
"workspace_id",
"mutation_id",
"url"
],
"additionalProperties": false
}回應與完成
成功 HTTP 狀態:200。操作完成時: durable bounded social receipt and exact evidence references; partial samples and unknown counters stay explicit.
成功 HTTP 回應可能表示請求已接受,並非已完成。背景工作請儲存回傳 ID,持續檢查同一操作直到完成。已排程或已接受的貼文,只有平台確認後才算已發布;用戶端逾時無法證明結果。
「必填」是指在其父物件及所選分支內必填。必填子欄位不會使選填父物件變成必填。下列規則與欄位名稱均複製自契約。
| 欄位 / 分支 | 類型 / 必填 | 約束 |
|---|---|---|
$ | object在父物件中必填 | — |
retrieval | object在父物件中必填 | — |
retrieval.id | string在父物件中必填 |
|
retrieval.workspace_id | string在父物件中必填 |
|
retrieval.mutation_id | string在父物件中必填 |
|
retrieval.kind | string在父物件中必填 |
|
retrieval.state | string在父物件中必填 |
|
retrieval.created_at | string在父物件中必填 |
|
retrieval.settled_at | string | null在父物件中必填 | — |
retrieval.settled_atanyOf 1 | string在父物件中必填 |
|
retrieval.settled_atanyOf 2 | null在父物件中必填 | — |
retrieval.valid_until | string在父物件中必填 |
|
retrieval.result | object | null在父物件中必填 | — |
retrieval.resultanyOf 1 | object在父物件中必填 | — |
retrieval.result.sourceanyOf 1 | string在父物件中必填 |
|
retrieval.result.platformanyOf 1 | string在父物件中必填 |
|
retrieval.result.canonical_urlanyOf 1 | string在父物件中必填 |
|
retrieval.result.fetched_atanyOf 1 | string在父物件中必填 |
|
retrieval.result.expires_atanyOf 1 | string在父物件中必填 |
|
retrieval.result.upstream_updated_atanyOf 1 | null在父物件中必填 | — |
retrieval.result.statusanyOf 1 | string在父物件中必填 |
|
retrieval.result.profileanyOf 1 | object | null在父物件中必填 | — |
retrieval.result.profileanyOf 1 / anyOf 1 | object在父物件中必填 | — |
retrieval.result.profile.source_account_idanyOf 1 / anyOf 1 | string在父物件中必填 |
|
retrieval.result.profile.id_namespaceanyOf 1 / anyOf 1 | string在父物件中必填 |
|
retrieval.result.profile.usernameanyOf 1 / anyOf 1 | string在父物件中必填 |
|
retrieval.result.profile.nameanyOf 1 / anyOf 1 | string | null在父物件中必填 | — |
retrieval.result.profile.nameanyOf 1 / anyOf 1 / anyOf 1 | string在父物件中必填 |
|
retrieval.result.profile.nameanyOf 1 / anyOf 1 / anyOf 2 | null在父物件中必填 | — |
retrieval.result.profile.followersanyOf 1 / anyOf 1 | integer | null在父物件中必填 | — |
retrieval.result.profile.followersanyOf 1 / anyOf 1 / anyOf 1 | integer在父物件中必填 |
|
retrieval.result.profile.followersanyOf 1 / anyOf 1 / anyOf 2 | null在父物件中必填 | — |
retrieval.result.profileanyOf 1 / anyOf 2 | null在父物件中必填 | — |
retrieval.result.postsanyOf 1 | array在父物件中必填 |
|
retrieval.result.posts[]anyOf 1 | object選填/項目 | — |
retrieval.result.posts[].source_post_idanyOf 1 | string在父物件中必填 |
|
retrieval.result.posts[].id_namespaceanyOf 1 | string在父物件中必填 |
|
retrieval.result.posts[].shortcodeanyOf 1 | string | null在父物件中必填 | — |
retrieval.result.posts[].shortcodeanyOf 1 / anyOf 1 | string在父物件中必填 |
|
retrieval.result.posts[].shortcodeanyOf 1 / anyOf 2 | null在父物件中必填 | — |
retrieval.result.posts[].source_account_idanyOf 1 | string在父物件中必填 |
|
retrieval.result.posts[].authoranyOf 1 | string在父物件中必填 |
|
retrieval.result.posts[].canonical_urlanyOf 1 | string在父物件中必填 |
|
retrieval.result.posts[].textanyOf 1 | string在父物件中必填 |
|
retrieval.result.posts[].published_atanyOf 1 | string | null在父物件中必填 | — |
retrieval.result.posts[].published_atanyOf 1 / anyOf 1 | string在父物件中必填 |
|
retrieval.result.posts[].published_atanyOf 1 / anyOf 2 | null在父物件中必填 | — |
retrieval.result.posts[].media_kindanyOf 1 | string在父物件中必填 |
|
retrieval.result.posts[].metricsanyOf 1 | object在父物件中必填 | — |
retrieval.result.posts[].metrics.likesanyOf 1 | integer | null在父物件中必填 | — |
retrieval.result.posts[].metrics.likesanyOf 1 / anyOf 1 | integer在父物件中必填 |
|
retrieval.result.posts[].metrics.likesanyOf 1 / anyOf 2 | null在父物件中必填 | — |
retrieval.result.posts[].metrics.commentsanyOf 1 | integer | null在父物件中必填 | — |
retrieval.result.posts[].metrics.commentsanyOf 1 / anyOf 1 | integer在父物件中必填 |
|
retrieval.result.posts[].metrics.commentsanyOf 1 / anyOf 2 | null在父物件中必填 | — |
retrieval.result.posts[].metrics.reactionsanyOf 1 | integer | null在父物件中必填 | — |
retrieval.result.posts[].metrics.reactionsanyOf 1 / anyOf 1 | integer在父物件中必填 |
|
retrieval.result.posts[].metrics.reactionsanyOf 1 / anyOf 2 | null在父物件中必填 | — |
retrieval.result.posts[].metrics.sharesanyOf 1 | integer | null在父物件中必填 | — |
retrieval.result.posts[].metrics.sharesanyOf 1 / anyOf 1 | integer在父物件中必填 |
|
retrieval.result.posts[].metrics.sharesanyOf 1 / anyOf 2 | null在父物件中必填 | — |
retrieval.result.posts[].metrics.viewsanyOf 1 | integer | null在父物件中必填 | — |
retrieval.result.posts[].metrics.viewsanyOf 1 / anyOf 1 | integer在父物件中必填 |
|
retrieval.result.posts[].metrics.viewsanyOf 1 / anyOf 2 | null在父物件中必填 | — |
retrieval.result.coverageanyOf 1 | object在父物件中必填 | — |
retrieval.result.coverage.completeanyOf 1 | boolean在父物件中必填 |
|
retrieval.result.coverage.reasonsanyOf 1 | array在父物件中必填 |
|
retrieval.result.coverage.reasons[]anyOf 1 | string選填/項目 |
|
retrieval.result.coverage.omitted_rowsanyOf 1 | integer在父物件中必填 |
|
retrieval.result.coverage.next_cursoranyOf 1 | null在父物件中必填 | — |
retrieval.resultanyOf 2 | null在父物件中必填 | — |
retrieval.evidence | array在父物件中必填 |
|
retrieval.evidence[] | object選填/項目 | — |
retrieval.evidence[].evidence_id | string在父物件中必填 |
|
retrieval.evidence[].revision | integer在父物件中必填 |
|
完整 JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"retrieval": {
"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)$"
},
"mutation_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)$"
},
"kind": {
"type": "string",
"const": "public_social"
},
"state": {
"type": "string",
"enum": [
"pending",
"running",
"completed",
"cancelled",
"unconfirmed",
"expired"
]
},
"created_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"
},
"settled_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"
}
]
},
"valid_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"
},
"result": {
"anyOf": [
{
"type": "object",
"properties": {
"source": {
"type": "string",
"enum": [
"facebook_public_web",
"instagram_public_web",
"threads_public_web"
]
},
"platform": {
"type": "string",
"enum": [
"facebook",
"instagram",
"threads"
]
},
"canonical_url": {
"type": "string",
"maxLength": 2048,
"format": "uri"
},
"fetched_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"
},
"upstream_updated_at": {
"type": "null"
},
"status": {
"type": "string",
"enum": [
"available",
"partial",
"unavailable"
]
},
"profile": {
"anyOf": [
{
"type": "object",
"properties": {
"source_account_id": {
"type": "string",
"pattern": "^[0-9]{1,30}$"
},
"id_namespace": {
"type": "string",
"const": "public_web"
},
"username": {
"type": "string",
"minLength": 1,
"maxLength": 50
},
"name": {
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 200
},
{
"type": "null"
}
]
},
"followers": {
"anyOf": [
{
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
}
},
"required": [
"source_account_id",
"id_namespace",
"username",
"name",
"followers"
]
},
{
"type": "null"
}
]
},
"posts": {
"maxItems": 20,
"type": "array",
"items": {
"type": "object",
"properties": {
"source_post_id": {
"type": "string",
"pattern": "^[0-9]{1,30}$"
},
"id_namespace": {
"type": "string",
"const": "public_web"
},
"shortcode": {
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 64
},
{
"type": "null"
}
]
},
"source_account_id": {
"type": "string",
"pattern": "^[0-9]{1,30}$"
},
"author": {
"type": "string",
"minLength": 1,
"maxLength": 50
},
"canonical_url": {
"type": "string",
"maxLength": 2048,
"format": "uri"
},
"text": {
"type": "string",
"maxLength": 30000
},
"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"
}
]
},
"media_kind": {
"type": "string",
"enum": [
"text",
"image",
"video",
"carousel",
"unknown"
]
},
"metrics": {
"type": "object",
"properties": {
"likes": {
"anyOf": [
{
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"comments": {
"anyOf": [
{
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"reactions": {
"anyOf": [
{
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"shares": {
"anyOf": [
{
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"views": {
"anyOf": [
{
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
}
},
"required": [
"likes",
"comments",
"reactions",
"shares",
"views"
]
}
},
"required": [
"source_post_id",
"id_namespace",
"shortcode",
"source_account_id",
"author",
"canonical_url",
"text",
"published_at",
"media_kind",
"metrics"
]
}
},
"coverage": {
"type": "object",
"properties": {
"complete": {
"type": "boolean",
"const": false
},
"reasons": {
"maxItems": 20,
"type": "array",
"items": {
"type": "string",
"enum": [
"initial_page_only",
"public_web_ids",
"metrics_unavailable",
"profile_only",
"no_attributable_posts",
"foreign_or_malformed_rows",
"parser_limit",
"unsupported_payload",
"blocked",
"rate_limited",
"upstream_http_error",
"redirect_rejected",
"unsupported_content_type",
"response_too_large",
"timeout",
"aborted",
"network_error",
"inconsistent_identity",
"research_limit",
"source_removed"
]
}
},
"omitted_rows": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"next_cursor": {
"type": "null"
}
},
"required": [
"complete",
"reasons",
"omitted_rows",
"next_cursor"
]
}
},
"required": [
"source",
"platform",
"canonical_url",
"fetched_at",
"expires_at",
"upstream_updated_at",
"status",
"profile",
"posts",
"coverage"
]
},
{
"type": "null"
}
]
},
"evidence": {
"maxItems": 20,
"type": "array",
"items": {
"type": "object",
"properties": {
"evidence_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
}
},
"required": [
"evidence_id",
"revision"
]
}
}
},
"required": [
"id",
"workspace_id",
"mutation_id",
"kind",
"state",
"created_at",
"settled_at",
"valid_until",
"result",
"evidence"
]
}
},
"required": [
"retrieval"
]
}錯誤與安全重試
檢查 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",
"mutation_id": "40000000-0000-4000-8000-000000000005",
"url": "https://www.instagram.com/fictional_example/"
}cURL
curl --request POST \
"https://gqeshlawtcexsapabaui.supabase.co/functions/v1/research-api/evidence/retrieve-social" \
-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/research-api/evidence/retrieve-social", {
method: "POST",
headers: { "Content-Type": "application/json", Authorization: "Bearer " + token },
body: JSON.stringify({
"workspace_id": "11111111-1111-4111-8111-111111111111",
"mutation_id": "40000000-0000-4000-8000-000000000005",
"url": "https://www.instagram.com/fictional_example/"
})
});
const result = await response.json();
// Check response.ok, the operation-specific body and completion state before continuing.CLI
# This operation requires a CLI build containing the updated Research contract.
# Use HTTP or hosted MCP if your CLI build does not include it.
# 此操作需要包含更新版 Research contract 的 CLI build。
# 如 CLI build 未包含此 contract,請使用 HTTP 或 hosted MCP。
npx sosoapi api post /research-api/evidence/retrieve-social < request.json合成回應範例
{
"retrieval": {
"id": "30000000-0000-4000-8000-000000000007",
"workspace_id": "11111111-1111-4111-8111-111111111111",
"mutation_id": "40000000-0000-4000-8000-000000000005",
"kind": "public_social",
"state": "completed",
"created_at": "2099-01-15T09:00:00Z",
"settled_at": "2099-01-15T09:00:01Z",
"valid_until": "2099-01-16T09:00:00Z",
"evidence": [],
"result": {
"source": "instagram_public_web",
"platform": "instagram",
"canonical_url": "https://www.instagram.com/fictional_example/",
"fetched_at": "2099-01-15T09:00:00Z",
"expires_at": "2099-01-16T09:00:00Z",
"upstream_updated_at": null,
"status": "unavailable",
"profile": null,
"posts": [],
"coverage": {
"complete": false,
"reasons": [
"blocked"
],
"omitted_rows": 0,
"next_cursor": null
}
}
}
}