# ワークスペースのブランドコンテキストを取得 正規URL： https://sosoapi.ai/ja/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の場合は、まず既存の結果を取得してください。冪等性キーは対応する操作でのみ再利用します。再試行の挙動は操作ごとに異なり、厳密に一回の配信は保証しません。 ## 例 スキーマ確認済みの架空値の例です。認可されたID、準備済みメディア、確認済みの公開日時に置き換え、書き込み前に適格性を確認してください。このページはAPIを呼びません。 サーバーのSOSOAPI_ACCESS_TOKENに操作が受け付ける認証情報を設定し、ブラウザーコードに含めないでください。エージェントは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/ja/docs/api)