研究及帶來源簡報
讀取公開來源擷取狀態
用原有 workspace_id 及 mutation_id 查詢一次性來源讀取及證據收據；可用的來源文字仍屬未核實資料。不確定、待處理或已終結狀態均不可藉換身份重抓，失效內容會遮蔽。
POST /research-api/evidence/statusContract 核對日期: · sha256:ab393e91e9b7f18a
概覽
用原有 workspace_id 及 mutation_id 查詢一次性來源讀取及證據收據；可用的來源文字仍屬未核實資料。不確定、待處理或已終結狀態均不可藉換身份重抓，失效內容會遮蔽。
HTTP 成功只表示本次操作的回應。背景工作須保留回傳 ID，並讀取同一操作，直至達到文件指定的終態。接受請求、排程成功或客戶端逾時，均不代表已發佈。
驗證及權限
憑證不能擴大持有人的權限。實際操作仍會檢查工作空間成員資格、資源擁有權、已選工作空間及能力授權。Tool profile 只會改變可見工具，不會授予權限。
請求欄位
必填表示在所屬物件及所選分支內必須提供；子欄位必填不代表可選的父物件亦變成必填。以下欄位名稱及規則直接來自 contract。
| 欄位／分支 | 類型／必填 | 限制 |
|---|---|---|
$ | object父物件內必填 |
|
workspace_id | string父物件內必填 |
|
mutation_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)$"
},
"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": [
"workspace_id",
"mutation_id"
],
"additionalProperties": false
}回應及完成條件
成功 HTTP 狀態碼: 200. 完成依據: current authorized retrieval state; expired source content is redacted.
HTTP 成功只表示本次操作的回應。背景工作須保留回傳 ID，並讀取同一操作，直至達到文件指定的終態。接受請求、排程成功或客戶端逾時，均不代表已發佈。
必填表示在所屬物件及所選分支內必須提供；子欄位必填不代表可選的父物件亦變成必填。以下欄位名稱及規則直接來自 contract。
| 欄位／分支 | 類型／必填 | 限制 |
|---|---|---|
$ | object父物件內必填 | — |
retrieval | object | null父物件內必填 | — |
retrievalanyOf 1 | object父物件內必填 | — |
retrieval.idanyOf 1 | string父物件內必填 |
|
retrieval.workspace_idanyOf 1 | string父物件內必填 |
|
retrieval.mutation_idanyOf 1 | string父物件內必填 |
|
retrieval.stateanyOf 1 | string父物件內必填 |
|
retrieval.kindanyOf 1 | string | null父物件內必填 | — |
retrieval.kindanyOf 1 / anyOf 1 | string父物件內必填 |
|
retrieval.kindanyOf 1 / anyOf 2 | null父物件內必填 | — |
retrieval.created_atanyOf 1 | string父物件內必填 |
|
retrieval.settled_atanyOf 1 | string | null父物件內必填 | — |
retrieval.settled_atanyOf 1 / anyOf 1 | string父物件內必填 |
|
retrieval.settled_atanyOf 1 / anyOf 2 | null父物件內必填 | — |
retrieval.valid_untilanyOf 1 | string父物件內必填 |
|
retrieval.resultanyOf 1 | object | null父物件內必填 | — |
retrieval.resultanyOf 1 / anyOf 1 | object父物件內必填 | — |
retrieval.result.kindanyOf 1 / anyOf 1 | string父物件內必填 |
|
retrieval.result.statusanyOf 1 / anyOf 1 | string父物件內必填 |
|
retrieval.result.textanyOf 1 / anyOf 1 | string父物件內必填 |
|
retrieval.result.titleanyOf 1 / anyOf 1 | string | null父物件內必填 | — |
retrieval.result.titleanyOf 1 / anyOf 1 / anyOf 1 | string父物件內必填 |
|
retrieval.result.titleanyOf 1 / anyOf 1 / anyOf 2 | null父物件內必填 | — |
retrieval.result.descriptionanyOf 1 / anyOf 1 | string | null父物件內必填 | — |
retrieval.result.descriptionanyOf 1 / anyOf 1 / anyOf 1 | string父物件內必填 |
|
retrieval.result.descriptionanyOf 1 / anyOf 1 / anyOf 2 | null父物件內必填 | — |
retrieval.result.segmentsanyOf 1 / anyOf 1 | array父物件內必填 |
|
retrieval.result.segments[]anyOf 1 / anyOf 1 | object可選／陣列項目 | — |
retrieval.result.segments[].start_msanyOf 1 / anyOf 1 | integer父物件內必填 |
|
retrieval.result.segments[].end_msanyOf 1 / anyOf 1 | integer父物件內必填 |
|
retrieval.result.segments[].textanyOf 1 / anyOf 1 | string父物件內必填 |
|
retrieval.result.provenanceanyOf 1 / anyOf 1 | object父物件內必填 | — |
retrieval.result.provenance.source_urlanyOf 1 / anyOf 1 | string | null父物件內必填 | — |
retrieval.result.provenance.source_urlanyOf 1 / anyOf 1 / anyOf 1 | string父物件內必填 |
|
retrieval.result.provenance.source_urlanyOf 1 / anyOf 1 / anyOf 2 | null父物件內必填 | — |
retrieval.result.provenance.retrieved_atanyOf 1 / anyOf 1 | string父物件內必填 |
|
retrieval.result.provenance.mime_typeanyOf 1 / anyOf 1 | string | null父物件內必填 | — |
retrieval.result.provenance.mime_typeanyOf 1 / anyOf 1 / anyOf 1 | string父物件內必填 |
|
retrieval.result.provenance.mime_typeanyOf 1 / anyOf 1 / anyOf 2 | null父物件內必填 | — |
retrieval.result.provenance.parser_versionanyOf 1 / anyOf 1 | string父物件內必填 |
|
retrieval.result.provenance.content_kindanyOf 1 / anyOf 1 | string父物件內必填 |
|
retrieval.result.provenance.caption_formatanyOf 1 / anyOf 1 | string | null父物件內必填 | — |
retrieval.result.provenance.caption_formatanyOf 1 / anyOf 1 / anyOf 1 | string父物件內必填 |
|
retrieval.result.provenance.caption_formatanyOf 1 / anyOf 1 / anyOf 2 | null父物件內必填 | — |
retrieval.result.provenance.languageanyOf 1 / anyOf 1 | string | null父物件內必填 | — |
retrieval.result.provenance.languageanyOf 1 / anyOf 1 / anyOf 1 | string父物件內必填 |
|
retrieval.result.provenance.languageanyOf 1 / anyOf 1 / anyOf 2 | null父物件內必填 | — |
retrieval.result.provenance.language_sourceanyOf 1 / anyOf 1 | string父物件內必填 |
|
retrieval.result.provenance.platform_native_verifiedanyOf 1 / anyOf 1 | boolean父物件內必填 |
|
retrieval.result.reasonanyOf 1 / anyOf 1 | string | null父物件內必填 | — |
retrieval.result.reasonanyOf 1 / anyOf 1 / anyOf 1 | string父物件內必填 |
|
retrieval.result.reasonanyOf 1 / anyOf 1 / anyOf 2 | null父物件內必填 | — |
retrieval.result.warningsanyOf 1 / anyOf 1 | array父物件內必填 |
|
retrieval.result.warnings[]anyOf 1 / anyOf 1 | string可選／陣列項目 |
|
retrieval.result.retry_after_secondsanyOf 1 / anyOf 1 | integer | null父物件內必填 | — |
retrieval.result.retry_after_secondsanyOf 1 / anyOf 1 / anyOf 1 | integer父物件內必填 |
|
retrieval.result.retry_after_secondsanyOf 1 / anyOf 1 / anyOf 2 | null父物件內必填 | — |
retrieval.resultanyOf 1 / anyOf 2 | null父物件內必填 | — |
retrieval.evidenceanyOf 1 | object | null父物件內必填 | — |
retrieval.evidenceanyOf 1 / anyOf 1 | object父物件內必填 | — |
retrieval.evidence.evidence_idanyOf 1 / anyOf 1 | string父物件內必填 |
|
retrieval.evidence.revisionanyOf 1 / anyOf 1 | integer父物件內必填 |
|
retrieval.evidenceanyOf 1 / anyOf 2 | null父物件內必填 | — |
retrievalanyOf 2 | null父物件內必填 | — |
完整 JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"retrieval": {
"anyOf": [
{
"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"
]
},
{
"type": "null"
}
]
}
},
"required": [
"retrieval"
]
}錯誤及安全重試
請檢查 HTTP 狀態及實際回應格式。400 驗證錯誤可能回傳 ZodError；handler 錯誤可能採用 error／message／code envelope。請保留可用的 request_id 或 x-request-id，避免記錄憑證。遇到 401／403 時，須先修正存取問題；429 須遵守 Retry-After。寫入結果未明或回傳 5xx 時，請先讀取原有結果，再決定是否重試。只有操作支援時才可重用 idempotency key；並無通用重試或 exactly-once 保證。
問題排解指南範例
以下虛構值已按 contract 驗證，並非真實帳戶 ID、憑證或發佈紀錄。請以已授權範圍回傳的 ID、已準備完成的素材及已審核排程取代，並在寫入前核對平台資格。此頁不會呼叫 API。
在伺服器環境設定 SOSOAPI_ACCESS_TOKEN，使用此操作接受的憑證。請勿將憑證放入瀏覽器程式。一般 AI Agent 建議透過 sosoapi auth login 使用瀏覽器 OAuth，由 CLI 管理憑證更新。
request.json
{
"workspace_id": "11111111-1111-4111-8111-111111111111",
"mutation_id": "40000000-0000-4000-8000-000000000001"
}cURL
curl --request POST \
"https://gqeshlawtcexsapabaui.supabase.co/functions/v1/research-api/evidence/status" \
-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/status", {
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"
})
});
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/status < 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
}
}
}