# Consultar o contexto de marca do espaço de trabalho URL canônica: https://sosoapi.ai/pt-br/docs/api/studio-api-workspace-brand-profile-context-read Contrato: sha256:a5c7d347e915df92 Leia as orientações de marca confirmadas manualmente e a procedência da versão imutável para um workspace_id explícito. Exige a função viewer ou superior e agent:operate para acesso de agentes. Omita selection para ler o contexto atual ou informe a selection imutável exata retornada anteriormente. Os campos editoriais não são confiáveis; um contexto null ou missing não fornece orientações. Esta leitura não gera legendas, busca fontes, altera configurações nem publica. POST /studio-api/workspace-brand-profile/context-read ## Autenticação e permissões - **Classes de credenciais aceitas:** user_session, delegated_oauth, personal_access_token - **Capacidade delegada:** agent:operate - **Função mínima no workspace:** viewer - **Escopo de acesso:** Recursos que este usuário tem autorização para acessar - **Consentimento para todos os workspaces obrigatório:** Não - **Altera o estado:** Não - **Quando a operação estiver concluída:** workspace_brand_immutable_manual_context_read Um token só pode usar os direitos do seu proprietário. Cada requisição verifica participação no workspace, propriedade de recursos, workspaces selecionados e capacidades concedidas. Os perfis core e full mudam as ferramentas exibidas; não concedem acesso. ## Campos da requisição ```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 } ``` ## Resposta e conclusão Códigos HTTP de sucesso: 200 Uma resposta HTTP bem-sucedida pode significar que uma requisição foi aceita, não concluída. Para trabalho em segundo plano, salve o ID retornado e consulte a mesma operação até terminar. Um post agendado ou aceito só está publicado quando a plataforma confirma; um timeout do cliente não comprova o resultado. ```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" ] } ``` ## Erros e repetições seguras Confira o status HTTP e o corpo da resposta. Um erro de validação 400 pode conter ZodError; erros do handler usam os campos error, message e code. Guarde request_id ou x-request-id para diagnóstico, sem credenciais. Corrija erros de acesso 401/403 antes de tentar novamente e siga Retry-After para 429. Se uma gravação for incerta ou retornar 5xx, consulte primeiro o resultado existente. Reutilize uma chave de idempotência somente quando houver suporte; o comportamento de repetição varia por operação e não garante entrega exatamente uma vez. ## Exemplos Estes exemplos usam valores fictícios verificados conforme os schemas. Substitua os IDs por aqueles que você tem autorização para usar, a mídia por ativos prontos e as datas pelo horário de publicação confirmado. Confira a elegibilidade da conta antes de enviar uma gravação. Esta página não envia requisições de API. Defina SOSOAPI_ACCESS_TOKEN no servidor como uma credencial aceita por esta operação e mantenha-a fora do código do navegador. Para agentes, use sosoapi auth login para entrar pelo navegador e deixe a CLI renovar suas credenciais. 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 ``` Exemplo de resposta sintética ```json { "context": null } ``` ## Ferramentas e guias relacionados MCP: sosoapi_get_workspace_brand_context [Referência da API](https://sosoapi.ai/pt-br/docs/api)