# 讀取工作空間品牌背景 Canonical URL: https://sosoapi.ai/zh-hant/docs/api/studio-api-workspace-brand-profile-context-read Contract: sha256:a5c7d347e915df92 明確傳入 workspace_id，讀取經人手確認的工作空間品牌指引及不可變更版本的來源記錄。需要 viewer 或以上角色；智能代理亦須具備 agent:operate 權限。省略 selection 可讀取目前背景，或傳入先前回傳的完整不可變更 selection。編輯欄位屬不可信文字；context 為 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 憑證不能擴大持有人的權限。實際操作仍會檢查工作空間成員資格、資源擁有權、已選工作空間及能力授權。Tool profile 只會改變可見工具，不會授予權限。 ## 請求欄位 ```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；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 ```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 reference](https://sosoapi.ai/zh-hant/docs/api)