研究及附來源簡報
讀取公開研究來源
擷取有界限的公開 HTTPS 文字或已發布字幕；重用 mutation_id，檢查覆蓋範圍及不可信文字。需要 agent:research。
POST /research-api/evidence/retrieve契約檢閱日期： · sha256:ab393e91e9b7f18a
概覽
擷取有界限的公開 HTTPS 文字或已發布字幕；重用 mutation_id，檢查覆蓋範圍及不可信文字。需要 agent:research。
成功 HTTP 回應可能表示請求已接受，並非已完成。背景工作請儲存回傳 ID，持續檢查同一操作直到完成。已排程或已接受的貼文，只有平台確認後才算已發布；用戶端逾時無法證明結果。
驗證與權限
權杖只能使用其擁有者持有的權利。每次請求會檢查工作空間成員資格、資源擁有權、所選工作空間及已授予能力。core 與 full 設定檔只變更顯示的工具，不會授予存取權。
請求欄位
「必填」是指在其父物件及所選分支內必填。必填子欄位不會使選填父物件變成必填。下列規則與欄位名稱均複製自契約。
| 欄位 / 分支 | 類型 / 必填 | 約束 |
|---|---|---|
$ | object在父物件中必填 |
|
url | string在父物件中必填 |
|
kind | string在父物件中必填 |
|
language | string選填／項目 |
|
workspace_id | string在父物件中必填 |
|
mutation_id | string在父物件中必填 |
|
完整 JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"url": {
"type": "string",
"maxLength": 2048,
"format": "uri"
},
"kind": {
"type": "string",
"enum": [
"url_text",
"published_captions"
]
},
"language": {
"type": "string",
"minLength": 1,
"maxLength": 35,
"pattern": "^[a-zA-Z]{2,8}(?:-[a-zA-Z0-9]{1,8})*$"
},
"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)$"
}
},
"required": [
"url",
"kind",
"workspace_id",
"mutation_id"
],
"additionalProperties": false
}回應與完成
成功 HTTP 狀態：200。操作完成時： durable bounded read receipt and current evidence; unsupported or unconfirmed is not success.
成功 HTTP 回應可能表示請求已接受，並非已完成。背景工作請儲存回傳 ID，持續檢查同一操作直到完成。已排程或已接受的貼文，只有平台確認後才算已發布；用戶端逾時無法證明結果。
「必填」是指在其父物件及所選分支內必填。必填子欄位不會使選填父物件變成必填。下列規則與欄位名稱均複製自契約。
| 欄位 / 分支 | 類型 / 必填 | 約束 |
|---|---|---|
$ | object在父物件中必填 | — |
retrieval | object在父物件中必填 | — |
retrieval.id | string在父物件中必填 |
|
retrieval.workspace_id | string在父物件中必填 |
|
retrieval.mutation_id | string在父物件中必填 |
|
retrieval.state | string在父物件中必填 |
|
retrieval.kind | string | null在父物件中必填 | — |
retrieval.kindanyOf 1 | string在父物件中必填 |
|
retrieval.kindanyOf 2 | null在父物件中必填 | — |
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.kindanyOf 1 | string在父物件中必填 |
|
retrieval.result.statusanyOf 1 | string在父物件中必填 |
|
retrieval.result.textanyOf 1 | string在父物件中必填 |
|
retrieval.result.titleanyOf 1 | string | null在父物件中必填 | — |
retrieval.result.titleanyOf 1 / anyOf 1 | string在父物件中必填 |
|
retrieval.result.titleanyOf 1 / anyOf 2 | null在父物件中必填 | — |
retrieval.result.descriptionanyOf 1 | string | null在父物件中必填 | — |
retrieval.result.descriptionanyOf 1 / anyOf 1 | string在父物件中必填 |
|
retrieval.result.descriptionanyOf 1 / anyOf 2 | null在父物件中必填 | — |
retrieval.result.segmentsanyOf 1 | array在父物件中必填 |
|
retrieval.result.segments[]anyOf 1 | object選填／項目 | — |
retrieval.result.segments[].start_msanyOf 1 | integer在父物件中必填 |
|
retrieval.result.segments[].end_msanyOf 1 | integer在父物件中必填 |
|
retrieval.result.segments[].textanyOf 1 | string在父物件中必填 |
|
retrieval.result.provenanceanyOf 1 | object在父物件中必填 | — |
retrieval.result.provenance.source_urlanyOf 1 | string | null在父物件中必填 | — |
retrieval.result.provenance.source_urlanyOf 1 / anyOf 1 | string在父物件中必填 |
|
retrieval.result.provenance.source_urlanyOf 1 / anyOf 2 | null在父物件中必填 | — |
retrieval.result.provenance.retrieved_atanyOf 1 | string在父物件中必填 |
|
retrieval.result.provenance.mime_typeanyOf 1 | string | null在父物件中必填 | — |
retrieval.result.provenance.mime_typeanyOf 1 / anyOf 1 | string在父物件中必填 |
|
retrieval.result.provenance.mime_typeanyOf 1 / anyOf 2 | null在父物件中必填 | — |
retrieval.result.provenance.parser_versionanyOf 1 | string在父物件中必填 |
|
retrieval.result.provenance.content_kindanyOf 1 | string在父物件中必填 |
|
retrieval.result.provenance.caption_formatanyOf 1 | string | null在父物件中必填 | — |
retrieval.result.provenance.caption_formatanyOf 1 / anyOf 1 | string在父物件中必填 |
|
retrieval.result.provenance.caption_formatanyOf 1 / anyOf 2 | null在父物件中必填 | — |
retrieval.result.provenance.languageanyOf 1 | string | null在父物件中必填 | — |
retrieval.result.provenance.languageanyOf 1 / anyOf 1 | string在父物件中必填 |
|
retrieval.result.provenance.languageanyOf 1 / anyOf 2 | null在父物件中必填 | — |
retrieval.result.provenance.language_sourceanyOf 1 | string在父物件中必填 |
|
retrieval.result.provenance.platform_native_verifiedanyOf 1 | boolean在父物件中必填 |
|
retrieval.result.reasonanyOf 1 | string | null在父物件中必填 | — |
retrieval.result.reasonanyOf 1 / anyOf 1 | string在父物件中必填 |
|
retrieval.result.reasonanyOf 1 / anyOf 2 | null在父物件中必填 | — |
retrieval.result.warningsanyOf 1 | array在父物件中必填 |
|
retrieval.result.warnings[]anyOf 1 | string選填／項目 |
|
retrieval.result.retry_after_secondsanyOf 1 | integer | null在父物件中必填 | — |
retrieval.result.retry_after_secondsanyOf 1 / anyOf 1 | integer在父物件中必填 |
|
retrieval.result.retry_after_secondsanyOf 1 / anyOf 2 | null在父物件中必填 | — |
retrieval.resultanyOf 2 | null在父物件中必填 | — |
retrieval.evidence | object | null在父物件中必填 | — |
retrieval.evidenceanyOf 1 | object在父物件中必填 | — |
retrieval.evidence.evidence_idanyOf 1 | string在父物件中必填 |
|
retrieval.evidence.revisionanyOf 1 | integer在父物件中必填 |
|
retrieval.evidenceanyOf 2 | null在父物件中必填 | — |
完整 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)$"
},
"state": {
"type": "string",
"enum": [
"pending",
"running",
"completed",
"cancelled",
"unconfirmed",
"expired"
]
},
"kind": {
"anyOf": [
{
"type": "string",
"enum": [
"url_text",
"published_captions"
]
},
{
"type": "null"
}
]
},
"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": {
"kind": {
"type": "string",
"enum": [
"url_text",
"published_captions"
]
},
"status": {
"type": "string",
"enum": [
"ready",
"partial",
"blocked",
"unsupported",
"empty",
"rate_limited",
"unavailable",
"cancelled"
]
},
"text": {
"type": "string",
"maxLength": 20000
},
"title": {
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 200
},
{
"type": "null"
}
]
},
"description": {
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 2000
},
{
"type": "null"
}
]
},
"segments": {
"maxItems": 1000,
"type": "array",
"items": {
"type": "object",
"properties": {
"start_ms": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"end_ms": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"text": {
"type": "string",
"minLength": 1,
"maxLength": 20000
}
},
"required": [
"start_ms",
"end_ms",
"text"
]
}
},
"provenance": {
"type": "object",
"properties": {
"source_url": {
"anyOf": [
{
"type": "string",
"maxLength": 2048,
"format": "uri"
},
{
"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"
},
"mime_type": {
"anyOf": [
{
"type": "string",
"enum": [
"text/html",
"application/xhtml+xml",
"text/plain",
"text/vtt",
"application/x-subrip",
"application/srt",
"text/srt"
]
},
{
"type": "null"
}
]
},
"parser_version": {
"type": "string",
"const": "research-public-retrieval/v1"
},
"content_kind": {
"type": "string",
"enum": [
"document_text",
"metadata_only",
"published_caption_file",
"none"
]
},
"caption_format": {
"anyOf": [
{
"type": "string",
"enum": [
"webvtt",
"subrip"
]
},
{
"type": "null"
}
]
},
"language": {
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 35,
"pattern": "^[a-zA-Z]{2,8}(?:-[a-zA-Z0-9]{1,8})*$"
},
{
"type": "null"
}
]
},
"language_source": {
"type": "string",
"enum": [
"publisher_declared",
"unknown"
]
},
"platform_native_verified": {
"type": "boolean",
"const": false
}
},
"required": [
"source_url",
"retrieved_at",
"mime_type",
"parser_version",
"content_kind",
"caption_format",
"language",
"language_source",
"platform_native_verified"
]
},
"reason": {
"anyOf": [
{
"type": "string",
"enum": [
"unsafe_url",
"unsupported_source",
"unsupported_media",
"unsupported_content",
"access_denied",
"login_required",
"no_text",
"metadata_only",
"no_captions",
"invalid_captions",
"not_found",
"rate_limited",
"response_too_large",
"text_limited",
"nodes_limited",
"cues_limited",
"invalid_cues",
"language_mismatch",
"source_partial",
"timeout",
"cancelled",
"egress_unavailable",
"unavailable"
]
},
{
"type": "null"
}
]
},
"warnings": {
"maxItems": 10,
"type": "array",
"items": {
"type": "string",
"enum": [
"unsafe_url",
"unsupported_source",
"unsupported_media",
"unsupported_content",
"access_denied",
"login_required",
"no_text",
"metadata_only",
"no_captions",
"invalid_captions",
"not_found",
"rate_limited",
"response_too_large",
"text_limited",
"nodes_limited",
"cues_limited",
"invalid_cues",
"language_mismatch",
"source_partial",
"timeout",
"cancelled",
"egress_unavailable",
"unavailable"
]
}
},
"retry_after_seconds": {
"anyOf": [
{
"type": "integer",
"minimum": 1,
"maximum": 86400
},
{
"type": "null"
}
]
}
},
"required": [
"kind",
"status",
"text",
"title",
"description",
"segments",
"provenance",
"reason",
"warnings",
"retry_after_seconds"
]
},
{
"type": "null"
}
]
},
"evidence": {
"anyOf": [
{
"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"
]
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"workspace_id",
"mutation_id",
"state",
"kind",
"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-000000000001",
"url": "https://example.com/research-notes",
"kind": "url_text"
}cURL
curl --request POST \
"https://gqeshlawtcexsapabaui.supabase.co/functions/v1/research-api/evidence/retrieve" \
-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", {
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-000000000001",
"url": "https://example.com/research-notes",
"kind": "url_text"
})
});
const result = await response.json();
// Check response.ok, the operation-specific body and completion state before continuing.CLI
npx sosoapi api post /research-api/evidence/retrieve < request.json合成回應範例
{
"retrieval": {
"id": "30000000-0000-4000-8000-000000000007",
"workspace_id": "11111111-1111-4111-8111-111111111111",
"mutation_id": "40000000-0000-4000-8000-000000000001",
"state": "completed",
"kind": "url_text",
"created_at": "2099-01-15T09:00:00Z",
"settled_at": "2099-01-15T09:00:01Z",
"valid_until": "2099-01-16T09:00:00Z",
"evidence": null,
"result": {
"kind": "url_text",
"status": "unavailable",
"text": "",
"title": null,
"description": null,
"segments": [],
"provenance": {
"source_url": null,
"retrieved_at": "2099-01-15T09:00:01Z",
"mime_type": null,
"parser_version": "research-public-retrieval/v1",
"content_kind": "none",
"caption_format": null,
"language": null,
"language_source": "unknown",
"platform_native_verified": false
},
"reason": "unavailable",
"warnings": [],
"retry_after_seconds": null
}
}
}