# 读取工作空间品牌上下文 标准 URL： https://sosoapi.ai/zh-hans/docs/api/studio-api-workspace-brand-profile-context-read 契约：sha256:a5c7d347e915df92 明确传入 workspace_id，读取经人工确认的品牌指引及不可变版本的来源信息。需要 viewer 或更高角色；智能代理访问还需要 agent:operate。省略 selection 可读取当前上下文，或传入此前返回的完全相同的不可变 selection。编辑字段属于不可信文本；上下文为 null 或 missing 时，没有可用指引。此读取操作不会生成文案、抓取来源、修改设置或发布内容。 POST /studio-api/workspace-brand-profile/context-read ## 验证与权限 - **接受的凭证类别：** user_session、delegated_oauth、personal_access_token - **委派能力：** agent:operate - **最低工作区角色：** viewer - **访问范围：** 此用户获准访问的资源 - **需要所有工作区同意：** 否 - **变更状态：** 否 - **操作完成时：** workspace_brand_immutable_manual_context_read 令牌只能使用其所有者持有的权利。每次请求会检查工作区成员资格、资源拥有权、所选工作区及已授予能力。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)$" }, "selection": { "type": "object", "properties": { "profile_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)$" }, "version_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 }, "content_digest": { "type": "string", "pattern": "^[a-f0-9]{64}$" }, "context_digest": { "type": "string", "pattern": "^[a-f0-9]{64}$" } }, "required": [ "profile_id", "version_id", "revision", "content_digest", "context_digest" ], "additionalProperties": false } }, "required": [ "workspace_id" ], "additionalProperties": false } ``` ## 响应与完成 成功 HTTP 状态：200 成功 HTTP 响应可能表示请求已接受，并非已完成。背景工作请存储返回 ID，持续检查同一操作直到完成。已排程或已接受的帖子，只有平台确认后才算已发布；客户端逾时无法证明结果。 ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "context": { "anyOf": [ { "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)$" }, "selection": { "type": "object", "properties": { "profile_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)$" }, "version_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 }, "content_digest": { "type": "string", "pattern": "^[a-f0-9]{64}$" }, "context_digest": { "type": "string", "pattern": "^[a-f0-9]{64}$" } }, "required": [ "profile_id", "version_id", "revision", "content_digest", "context_digest" ] }, "availability": { "type": "string", "enum": [ "available", "missing" ] }, "profile_state": { "anyOf": [ { "type": "string", "enum": [ "active", "archived" ] }, { "type": "null" } ] }, "content": { "anyOf": [ { "type": "object", "properties": { "name": { "type": "string", "maxLength": 120 }, "audience": { "type": "string", "maxLength": 2000 }, "voice": { "type": "string", "maxLength": 2000 }, "language": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 64 }, { "type": "null" } ] }, "preferred_terms": { "maxItems": 50, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 120 } }, "prohibited_terms": { "maxItems": 50, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 120 } }, "locked_facts": { "maxItems": 50, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 500 } }, "call_to_action": { "anyOf": [ { "type": "string", "maxLength": 1000 }, { "type": "null" } ] } }, "required": [ "name", "audience", "voice", "language", "preferred_terms", "prohibited_terms", "locked_facts", "call_to_action" ] }, { "type": "null" } ] }, "sources": { "type": "object", "properties": { "website": { "type": "string", "enum": [ "available", "not_available" ] }, "logo": { "type": "string", "enum": [ "none", "present", "missing" ] }, "own_posts": { "type": "object", "properties": { "selected": { "type": "integer", "minimum": 0, "maximum": 10 }, "available": { "type": "integer", "minimum": 0, "maximum": 10 }, "unavailable": { "type": "integer", "minimum": 0, "maximum": 10 }, "erased": { "type": "integer", "minimum": 0, "maximum": 10 } }, "required": [ "selected", "available", "unavailable", "erased" ] } }, "required": [ "website", "logo", "own_posts" ] } }, "required": [ "workspace_id", "selection", "availability", "profile_state", "content", "sources" ] }, { "type": "null" } ] } }, "required": [ "context" ] } ``` ## 错误与安全重试 检查 HTTP 状态和响应正文。400 验证错误可能包含 ZodError；处理程序错误使用 error、message 和 code 字段。保留 request_id 或 x-request-id 以便诊断，但不要保留凭证。先解决 401/403 访问错误再重试，并在收到 429 时遵循 Retry-After。如写入结果不确定或返回 5xx，先读取现有结果。仅在支持时复用幂等键；重试行为因操作而异，并不保证恰好交付一次。 ## 示例 这些示例使用已依schema检查的虚构值。请将 ID 替换为你有权使用的 ID、将媒体替换为已就绪素材，并将日期替换为已确认的发布时间。提交写入前，请检查账号资格。本页不会发送 API 请求。 在服务器上将 SOSOAPI_ACCESS_TOKEN 设为此操作接受的凭证，且不要放入浏览器代码。agent 请使用 sosoapi auth login 通过浏览器登录，并由 CLI 更新凭证。 request.json ```json { "workspace_id": "11111111-1111-4111-8111-111111111111" } ``` cURL ```bash curl --request POST \ "https://gqeshlawtcexsapabaui.supabase.co/functions/v1/studio-api/workspace-brand-profile/context-read" \ -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/studio-api/workspace-brand-profile/context-read", { method: "POST", headers: { "Content-Type": "application/json", Authorization: "Bearer " + token }, body: JSON.stringify({ "workspace_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 /studio-api/workspace-brand-profile/context-read < request.json ``` 合成响应示例 ```json { "context": null } ``` ## 相关工具与指南 MCP: sosoapi_get_workspace_brand_context [API 参考](https://sosoapi.ai/zh-hans/docs/api)