# 读取选定研究语料库概览 标准 URL： https://sosoapi.ai/zh-hans/docs/api/research-api-projects-overview 契约：sha256:ab393e91e9b7f18a 读取确切已归档语料库的确定性计数；选定项目不代表受众或市场规模。需要 agent:research。 POST /research-api/projects/overview ## 验证与权限 - **接受的凭证类别：** user_session、delegated_oauth、personal_access_token - **委派能力:** agent:research - **最低工作区角色：** viewer - **访问范围：** 此用户获准访问的资源 - **需要所有工作区同意：** 否 - **变更状态：** 否 - **操作完成时:** 当前获授权的确切 Research 资源数据 令牌只能使用其所有者持有的权利。每次请求会检查工作区成员资格、资源拥有权、所选工作区及已授予能力。core 与 full 配置只变更显示的工具，不会授予访问权限。 ## 请求字段 ```json { "$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)$" }, "project_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)$" }, "project_revision": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "corpus_snapshot_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", "project_id", "project_revision", "corpus_snapshot_id" ], "additionalProperties": false } ``` ## 响应与完成 成功 HTTP 状态：200 成功 HTTP 响应可能表示请求已接受，并非已完成。背景工作请存储返回 ID，持续检查同一操作直到完成。已排程或已接受的帖子，只有平台确认后才算已发布；客户端逾时无法证明结果。 ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "project_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)$" }, "project_revision": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "corpus_snapshot_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)$" }, "method_version": { "type": "string", "const": "literal-mentions/v1" }, "coverage": { "type": "string", "enum": [ "supplied_set", "bounded_sample", "partial" ] }, "evidence_count": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "unique_items": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "brand_union_count": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "overlap_count": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "brands": { "maxItems": 20, "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)$" }, "name": { "type": "string", "minLength": 1, "maxLength": 100 }, "matched_items": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "observed_mention_share": { "anyOf": [ { "type": "number", "minimum": 0, "maximum": 1 }, { "type": "null" } ] }, "evidence": { "maxItems": 500, "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", "name", "matched_items", "observed_mention_share", "evidence" ] } }, "languages": { "maxItems": 501, "type": "array", "items": { "type": "object", "properties": { "language": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 35 }, { "type": "null" } ] }, "item_count": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "language", "item_count" ] } }, "platforms": { "maxItems": 8, "type": "array", "items": { "type": "object", "properties": { "platform": { "anyOf": [ { "type": "string", "enum": [ "threads", "instagram", "facebook", "youtube", "x", "reddit", "web" ] }, { "type": "null" } ] }, "item_count": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "platform", "item_count" ] } }, "sources": { "maxItems": 3, "type": "array", "items": { "type": "object", "properties": { "category": { "type": "string", "enum": [ "your_accounts", "public_posts", "team_notes" ] }, "item_count": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "category", "item_count" ] } }, "history": { "type": "object", "properties": { "eligible": { "type": "boolean", "const": false }, "reason": { "type": "string", "const": "insufficient_comparable_history" } }, "required": [ "eligible", "reason" ] } }, "required": [ "project_id", "project_revision", "corpus_snapshot_id", "method_version", "coverage", "evidence_count", "unique_items", "brand_union_count", "overlap_count", "brands", "languages", "platforms", "sources", "history" ] } ``` ## 错误与安全重试 检查 HTTP 状态和响应正文。400 验证错误可能包含 ZodError；处理程序错误使用 error、message 和 code 字段。保留 request_id 或 x-request-id 以便诊断，但不要保留凭证。先解决 401/403 访问错误再重试，并在收到 429 时遵循 Retry-After。如写入结果不确定或返回 5xx，先读取现有结果。仅在支持时复用幂等键；重试行为因操作而异，并不保证恰好交付一次。 ## 示例 这些示例使用已依schema检查的虚构值。请将 ID 替换为你有权使用的 ID、将媒体替换为已就绪素材，并将日期替换为已确认的发布时间。提交写入前，请检查账号资格。本页不会发送 API 请求。 在服务器上将 SOSOAPI_ACCESS_TOKEN 设为此操作接受的凭证，且不要放入浏览器代码。AI 智能代理 请使用 sosoapi auth login 通过浏览器登录，并由 CLI 更新凭证。 request.json ```json { "workspace_id": "11111111-1111-4111-8111-111111111111", "project_id": "11111111-1111-4111-8111-111111111111", "project_revision": 1, "corpus_snapshot_id": "11111111-1111-4111-8111-111111111111" } ``` cURL ```bash curl --request POST \ "https://gqeshlawtcexsapabaui.supabase.co/functions/v1/research-api/projects/overview" \ -H "Authorization: Bearer $SOSOAPI_ACCESS_TOKEN" \ -H "Content-Type: application/json" \ --data-binary @request.json ``` JavaScript ```js // 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/projects/overview", { method: "POST", headers: { "Content-Type": "application/json", Authorization: "Bearer " + token }, body: JSON.stringify({ "workspace_id": "11111111-1111-4111-8111-111111111111", "project_id": "11111111-1111-4111-8111-111111111111", "project_revision": 1, "corpus_snapshot_id": "11111111-1111-4111-8111-111111111111" }) }); const result = await response.json(); // Check response.ok, the operation-specific body and completion state before continuing. ``` CLI ```bash npx sosoapi api post /research-api/projects/overview < request.json ``` 合成响应示例 ```json { "project_id": "11111111-1111-4111-8111-111111111111", "project_revision": 1, "corpus_snapshot_id": "11111111-1111-4111-8111-111111111111", "method_version": "literal-mentions/v1", "coverage": "supplied_set", "evidence_count": 0, "unique_items": 0, "brand_union_count": 0, "overlap_count": 0, "brands": [], "languages": [], "platforms": [], "sources": [], "history": { "eligible": false, "reason": "insufficient_comparable_history" } } ``` ## 相关工具与指南 MCP： sosoapi_research_projects_overview [API 参考](https://sosoapi.ai/zh-hans/docs/api)