# Obter contexto da Organization URL canônica: https://sosoapi.ai/pt-br/docs/api/identity-api-agent-organization-context Contrato: sha256:563d2d581da0ad29 Consulte o mapa atual de suas Organizations, seus Workspaces e Channels com ids e funções. Use quando precisar de ids de Organization ou Channel. Para publicar no Workspace, reutilize um id de Workspace retornado; não consulte também o contexto do workspace. POST /identity-api/agent/organization-context ## 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:** Não há função mínima de workspace neste contrato; as verificações de propriedade e permissão continuam valendo. - **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:** synchronous_http_response 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": { "organization_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)$" } }, "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": { "contract_version": { "type": "string", "const": "organization-agent-context/v1" }, "organizations": { "maxItems": 100, "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": 200 }, "role": { "type": "string", "enum": [ "owner", "admin", "member" ] }, "status": { "type": "string", "enum": [ "active", "deletion_pending", "deleted" ] }, "workspaces": { "maxItems": 100, "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": 200 }, "role": { "anyOf": [ { "type": "string", "enum": [ "owner", "editor", "reviewer", "viewer" ] }, { "type": "null" } ] }, "channels": { "maxItems": 500, "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)$" }, "organization_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)$" }, "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)$" }, "platform": { "type": "string", "enum": [ "instagram", "threads", "facebook", "youtube", "x" ] }, "status": { "type": "string", "enum": [ "setup_incomplete", "attached", "action_required", "disconnected" ] } }, "required": [ "id", "organization_id", "workspace_id", "platform", "status" ] } } }, "required": [ "id", "name", "role", "channels" ] } } }, "required": [ "id", "name", "role", "status", "workspaces" ] } } }, "required": [ "contract_version", "organizations" ] } ``` ## 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 {} ``` cURL ```bash curl --request POST \ "https://gqeshlawtcexsapabaui.supabase.co/functions/v1/identity-api/agent/organization-context" \ -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/identity-api/agent/organization-context", { method: "POST", headers: { "Content-Type": "application/json", Authorization: "Bearer " + token }, body: JSON.stringify({}) }); const result = await response.json(); // Check response.ok, the operation-specific body and completion state before continuing. ``` CLI ```bash npx sosoapi api post /identity-api/agent/organization-context < request.json ``` Exemplo de resposta sintética ```json { "contract_version": "organization-agent-context/v1", "organizations": [] } ``` ## Ferramentas e guias relacionados MCP: sosoapi_get_organization_context [Referência da API](https://sosoapi.ai/pt-br/docs/api)