> ## Documentation Index
> Fetch the complete documentation index at: https://docs.mka1.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Substituir a política da ferramenta

> Substitua a política de ferramentas da sua organização (somente administrador da organização). Cada regra nomeia um tipo de ferramenta e uma ação: deny recusa solicitações que configuram a ferramenta, e require_approval retém cada chamada até que ela seja aprovada. As regras MCP podem ser limitadas a servidores por nome de host e a nomes de ferramentas; uma regra deny com tool_names remove essas ferramentas em vez de recusar a solicitação. A regra correspondente mais restritiva se aplica, e nada em uma solicitação ou agente salvo a relaxa. As alterações chegam a todos os servidores em até 10 segundos.



## OpenAPI

````yaml https://apigw.mka1.com/speakeasy.json?language=pt-BR put /api/v1/llm/tool_policy
openapi: 3.1.1
info:
  title: MKA1 API
  version: 1.1.0
  description: >-
    A API MKA1 é uma API RESTful que fornece acesso à plataforma MKA1. Aprenda
    como começar a usar a API e o SDK TypeScript
    [aqui](https://mka1.apidocumentation.com/guides/getting-started).
  license:
    name: Proprietário
servers:
  - url: https://apigw.mka1.com
    description: MKA1 API Gateway
  - url: /
    description: Relative server URL (configurable via SDK constructor)
security: []
tags:
  - name: Resource Authorization
    description: >-
      Gerencie permissões para recursos LLM. Crie recursos, conceda/revoque
      permissões e exclua recursos. Apenas os proprietários dos recursos podem
      conceder, revogar ou excluir permissões.
    x-displayName: Autorização de Recurso
  - name: Audit
    description: >-
      API de auditoria para proprietários e administradores da organização.
      Rastreie uma solicitação de ponta a ponta pelo seu X-Request-ID: tempo de
      processamento do gateway de API, as respostas que ele criou e suas
      invocações de modelo e chamadas de ferramenta.
    x-displayName: Auditoria
  - name: Embeddings
    description: >-
      Endpoints da API de incorporação de texto para gerar representações
      vetoriais de texto. Crie incorporações semânticas para busca, clustering e
      correspondência de similaridade usando vários modelos de incorporação.
    x-displayName: Incorporações
  - name: Feedback
    description: >-
      API de feedback do usuário para avaliar e comentar sobre as conclusões de
      chat. Coleta de classificações de positivo/negativo e feedback detalhado
      para melhorar as respostas do modelo e acompanhar a satisfação do usuário.
    x-displayName: Feedback
  - name: Images
    description: >-
      Pontos de extremidade da API de geração de imagens para criar imagens a
      partir de descrições de texto. Gere imagens com controle sobre tamanho,
      qualidade e estilo.
    x-displayName: Imagens
  - name: MCP Vault
    description: >-
      API do cofre MCP para armazenar configurações de servidor MCP de
      propriedade do usuário e credenciais criptografadas. Os agentes
      referenciam IDs de cofre para que os segredos sejam resolvidos apenas no
      momento da execução da ferramenta.
    x-displayName: Cofre MCP
  - name: Speech
    description: >-
      Pontos de extremidade da API de fala para processamento de áudio. Converta
      texto em fala com som natural (TTS) ou transcreva fala em texto (STT) em
      diferentes idiomas.
    x-displayName: Discurso
  - name: Usage
    description: >-
      API de rastreamento de uso e análise para monitoramento do consumo de
      tokens, contagem de solicitações e análise de custos. Veja estatísticas
      detalhadas por usuário, modelo e período de tempo.
    x-displayName: Uso
  - name: Extract
    description: >-
      API de extração de dados estruturados para extrair informações de
      arquivos. Defina esquemas JSON para extrair dados estruturados de imagens,
      PDFs e documentos. Suporta modelos de esquema reutilizáveis.
    x-displayName: Extração
  - name: Text Classification
    description: >-
      API de classificação de texto para categorizar textos em rótulos
      predefinidos. Use modelos de IA para classificar o conteúdo textual para
      análise de sentimento, categorização de tópicos e moderação de conteúdo.
    x-displayName: Classificação de Texto
  - name: Responses
    description: >-
      API de respostas com agentes para criar agentes de IA com uso autônomo de
      ferramentas. Crie assistentes conversacionais que possam usar busca na
      web, operações de arquivos, geração de imagens, execução de código e
      integrações MCP. Suporta processamento em segundo plano, streaming e
      acompanhamento de status em tempo real.
    x-displayName: Respostas
  - name: Files
    description: >-
      API de gerenciamento de arquivos para upload, armazenamento e
      gerenciamento de arquivos com expiração automática e integração com S3.
      Faça upload de arquivos que podem ser usados com Assistentes,
      Armazenamentos Vetoriais e outras funcionalidades. Os arquivos são
      armazenados no S3 com metadados rastreados no PostgreSQL. Suporta limpeza
      automática de arquivos expirados.
    x-displayName: Arquivos
  - name: Vector Stores
    description: >-
      API de armazenamento de vetores para armazenar e pesquisar documentos
      usando embeddings. Crie armazenamentos de vetores, faça upload de arquivos
      com divisão automática e geração de embeddings, e realize pesquisas
      semânticas. Os arquivos são processados de forma assíncrona usando fluxos
      de trabalho Temporais para durabilidade. Suporta limpeza automática de
      armazenamentos expirados e LanceDB para armazenamento eficiente de
      vetores.
    x-displayName: Armazenamentos de Vetores
  - name: Conversations
    description: >-
      API de gerenciamento de conversas para armazenar e recuperar o estado da
      conversa durante chamadas à API de Resposta. Crie conversas, adicione
      itens (mensagens do usuário, mensagens do assistente, mensagens do
      sistema) e mantenha o histórico da conversa. Suporta rastreamento de
      metadados e gerenciamento de estado de diálogo em múltiplas interações.
    x-displayName: Conversa
  - name: Guardrails
    description: >-
      API de diretrizes de segurança de IA para configurar moderação de conteúdo
      e políticas de segurança. Configure listas de palavras proibidas, detecção
      de injeção de prompts e prevenção de vazamento de prompts do sistema. As
      diretrizes aplicam-se a todas as solicitações de uma conta e podem ser
      testadas antes da implementação.
    x-displayName: Guarda-corpos
  - name: Tool Policy
    description: >-
      API de política de ferramentas da organização. Os administradores da
      organização negam tipos de ferramentas ou exigem aprovação antes que suas
      chamadas sejam executadas, para cada solicitação de Responses na
      organização, incluindo execuções de agentes salvas. A política substitui o
      que as solicitações e os agentes configuram.
    x-displayName: Política de Ferramentas
  - name: Models
    description: >-
      API de listagem de modelos para descobrir modelos disponíveis. Retorna IDs
      de modelos, propriedade e metadados de todos os modelos registrados no
      gateway.
    x-displayName: Modelos
  - name: Skills
    description: >-
      API de habilidades para gerenciar pacotes versionados de instruções e
      arquivos seguindo o padrão de Habilidades do Agente. Crie, versionar e
      baixe pacotes de habilidades reutilizáveis que incluam manifestos SKILL.md
      para ambientes de agentes.
    x-displayName: Habilidades
  - name: Chat Completions
    description: >-
      **Obsoleto: Use a API de Respostas (`/api/v1/llm/responses`) em vez
      disso.** Endpoints de conclusão de chat com suporte para streaming,
      chamadas de ferramentas e múltiplos provedores.
    x-deprecated: true
    x-displayName: Conclusões de Bate-Papo
  - name: Batches
    x-displayName: Lotes
  - name: Evals
    x-displayName: Avaliações
  - name: Fine-Tuning
    x-displayName: Ajuste Fino
  - name: Memory Stores
    x-displayName: Armazenamentos de Memória
  - name: Prompts
    x-displayName: Sugestões
  - name: API Key
    x-displayName: Chave da API
  - name: OAuth
    x-displayName: OAuth
  - name: Session
    x-displayName: Sessão
  - name: Organization
    x-displayName: Organização
  - name: Cluster Admin
    x-displayName: Administrador do cluster
  - name: Sessions
    description: Crie, inspecione, acesse e encerre sessões de sandbox.
    x-displayName: Sessões
  - name: Browser
    description: >-
      Conecte-se às sessões do navegador através do proxy da porta do gateway.
      As sessões do navegador expõem um endpoint do Chrome DevTools Protocol na
      porta 9222.
    x-displayName: Navegador
  - name: Execution
    description: >-
      Executar comandos shell e código dentro de uma sessão de sandbox
      existente.
    x-displayName: Execução
  - name: Workspace
    description: >-
      Inspecione o manifesto do espaço de trabalho, transfira arquivos ou
      arquivos compactados e baixe artefatos gerados.
    x-displayName: Espaço de trabalho
  - name: Sandbox Usage
    description: >-
      Agregue estatísticas de uso da sandbox entre sessões, execução e operações
      do espaço de trabalho.
    x-displayName: Uso do Sandbox
  - name: Sandbox Pricing
    description: >-
      Gerenciamento de cluster-admin da tabela de preços de computação da
      sandbox usada para gastos orçados.
    x-displayName: Preço da Sandbox
  - name: Sandbox GitHub
    description: >-
      Conecte uma conta do GitHub, clone seus repositórios em sessões do sandbox
      e envie branches e abra pull requests a partir de uma sessão. O token do
      GitHub permanece no serviço de sandbox e nunca entra em uma sessão.
    x-displayName: Sandbox do GitHub
  - name: Sandbox Environments
    description: >-
      Salvar a configuração de sessão reutilizável (repositórios, variáveis de
      ambiente, acesso à rede e um script de configuração) e executar o script
      de configuração em uma sessão.
    x-displayName: Ambientes de Sandbox
  - name: Sandbox Connectors
    description: >-
      Conecte servidores MCP remotos (Linear, Notion, Sentry e outros) à sua
      conta para que sessões do Coding Harness iniciadas a partir de um ambiente
      que os liste possam chamar as ferramentas deles. O serviço de sandbox
      mantém as credenciais de cada conector e nunca as coloca em uma sessão.
    x-displayName: Conectores de Sandbox
  - name: Agents
    description: Crie e gerencie definições de agentes reutilizáveis.
    x-displayName: Agentes
  - name: Agent Versions
    description: >-
      Inspecione o histórico de configuração de um agente e reverta para uma
      versão anterior.
    x-displayName: Versões do Agente
  - name: Agent Runs
    description: Execute agentes salvos e inspecione os resultados da execução persistidos.
    x-displayName: Executa Agente
  - name: Agent Connectors
    description: >-
      Conecte agentes salvos a canais de mensagens externos, como o Telegram,
      incluindo troca de texto, foto e documentos compatíveis.
    x-displayName: Conectores de Agente
  - name: Agent Schedules
    description: Crie e gerencie execuções de agentes salvos agendadas ou recorrentes.
    x-displayName: Agendas de Agentes
  - name: schema-4_other
    x-displayName: outro
  - name: Billing
    x-displayName: Cobrança
  - name: Budgets
    x-displayName: Orçamentos
  - name: Settings
    x-displayName: Configurações
  - name: Compute Jobs
    x-displayName: Jobs de Computação
  - name: Compute Services
    x-displayName: Serviços de Computação
  - name: Compute Catalog
    x-displayName: Catálogo de Computação
  - name: Compute Volumes
    x-displayName: Calcular volumes
  - name: Compute Pricing
    x-displayName: Calcular Preços
  - name: Compute Secrets
    x-displayName: Calcular Segredos
  - name: Compute Usage
    x-displayName: Uso de Computação
  - name: Compute Tenants
    x-displayName: Calcular Inquilinos
  - description: Criar, listar, ler, atualizar e excluir repositórios.
    name: Repositories
    x-displayName: Repositórios
  - name: Tracking Experiments
    description: Criar e consultar experimentos de locatário.
    x-displayName: Rastreamento de Experimentos
  - name: Tracking Runs
    description: Registrar e recuperar parâmetros, métricas e tags da execução.
    x-displayName: Acompanhamento de execuções
  - name: analytics.projects
    x-displayName: Projetos
    description: Criar, listar, renomear e arquivar projetos de análise.
  - name: analytics.keys
    x-displayName: Capturar chaves
    description: Criar e revogar chaves do projeto para enviar eventos.
  - name: analytics
    x-displayName: Eventos
    description: Envie eventos e consulte contagens de eventos ou visitantes únicos.
  - name: analytics.events
    x-displayName: Busca de eventos
    description: >-
      Liste eventos individuais com suas propriedades, do mais recente para o
      mais antigo.
  - name: analytics.visitors
    x-displayName: Busca de visitantes
    description: >-
      Liste os visitantes por sua atividade mais recente, com os horários de
      primeira e última visualização.
  - name: generators
    x-displayName: geradores
  - name: generations
    x-displayName: gerações
  - name: formats
    x-displayName: formatos
  - description: >-
      Flags, ambientes, avaliação e o log de auditoria. As operações
      administrativas exigem um administrador de cluster; a avaliação usa uma
      chave de avaliação específica do ambiente.
    name: Feature Flags
    x-displayName: Flags de Recursos
  - name: Service Status
    description: >-
      Status atual de cada serviço e o histórico de incidentes, para a região
      desta implantação.
    x-displayName: Status do Serviço
  - name: Support Cases
    description: >-
      Abra e acompanhe casos de suporte. Os proprietários e administradores da
      organização veem todos os casos da organização; os outros membros veem os
      casos que abriram.
    x-displayName: Casos de suporte
paths:
  /api/v1/llm/tool_policy:
    put:
      tags:
        - Tool Policy
      summary: Substituir a política da ferramenta
      description: >-
        Substitua a política de ferramentas da sua organização (somente
        administrador da organização). Cada regra nomeia um tipo de ferramenta e
        uma ação: deny recusa solicitações que configuram a ferramenta, e
        require_approval retém cada chamada até que ela seja aprovada. As regras
        MCP podem ser limitadas a servidores por nome de host e a nomes de
        ferramentas; uma regra deny com tool_names remove essas ferramentas em
        vez de recusar a solicitação. A regra correspondente mais restritiva se
        aplica, e nada em uma solicitação ou agente salvo a relaxa. As
        alterações chegam a todos os servidores em até 10 segundos.
      operationId: updateToolPolicy
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateToolPolicyRequest'
            example:
              rules:
                - type: code_interpreter
                  action: deny
                - type: mcp
                  action: require_approval
                - type: mcp
                  action: deny
                  server_domains:
                    - mcp.example.com
                  tool_names:
                    - delete_repository
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ToolPolicy'
              example:
                object: tool_policy
                rules:
                  - type: code_interpreter
                    action: deny
                  - type: mcp
                    action: require_approval
                  - type: mcp
                    action: deny
                    server_domains:
                      - mcp.example.com
                    tool_names:
                      - delete_repository
                updated_at: '2026-11-05T12:00:00.000Z'
      security:
        - bearerAuth: []
      x-codeSamples:
        - lang: go
          label: Go (SDK)
          source: "package main\n\nimport(\n\t\"context\"\n\tmka1 \"github.com/MeetKai/mka1-sdks/go\"\n\t\"github.com/MeetKai/mka1-sdks/go/models/components\"\n\t\"log\"\n)\n\nfunc main() {\n    ctx := context.Background()\n\n    s := mka1.New(\n        mka1.WithSecurity(\"<YOUR_BEARER_TOKEN_HERE>\"),\n    )\n\n    res, err := s.ToolPolicy.UpdateToolPolicy(ctx, components.UpdateToolPolicyRequest{\n        Rules: []components.ToolPolicyRule{\n            components.ToolPolicyRule{\n                Type: components.PolicyToolTypeCodeInterpreter,\n                Action: components.ToolPolicyActionDeny,\n            },\n            components.ToolPolicyRule{\n                Type: components.PolicyToolTypeMcp,\n                Action: components.ToolPolicyActionRequireApproval,\n            },\n            components.ToolPolicyRule{\n                Type: components.PolicyToolTypeMcp,\n                Action: components.ToolPolicyActionDeny,\n                ServerDomains: []string{\n                    \"mcp.example.com\",\n                },\n                ToolNames: []string{\n                    \"delete_repository\",\n                },\n            },\n        },\n    })\n    if err != nil {\n        log.Fatal(err)\n    }\n    if res.ToolPolicy != nil {\n        // handle response\n    }\n}"
        - lang: csharp
          label: CSharp (SDK)
          source: |-
            using MeetKai.MKA1;
            using MeetKai.MKA1.Types.Components;
            using System.Collections.Generic;

            var sdk = new SDK(bearerAuth: "<YOUR_BEARER_TOKEN_HERE>");

            UpdateToolPolicyRequest req = new UpdateToolPolicyRequest() {
                Rules = new List<ToolPolicyRule>() {
                    new ToolPolicyRule() {
                        Type = PolicyToolType.CodeInterpreter,
                        Action = ToolPolicyAction.Deny,
                    },
                    new ToolPolicyRule() {
                        Type = PolicyToolType.Mcp,
                        Action = ToolPolicyAction.RequireApproval,
                    },
                    new ToolPolicyRule() {
                        Type = PolicyToolType.Mcp,
                        Action = ToolPolicyAction.Deny,
                        ServerDomains = new List<string>() {
                            "mcp.example.com",
                        },
                        ToolNames = new List<string>() {
                            "delete_repository",
                        },
                    },
                },
            };

            var res = await sdk.ToolPolicy.UpdateToolPolicyAsync(req);

            // handle response
        - lang: python
          label: Python (SDK)
          source: |-
            from meetkai_mka1 import SDK


            with SDK(
                bearer_auth="<YOUR_BEARER_TOKEN_HERE>",
            ) as sdk:

                res = sdk.tool_policy.update_tool_policy(rules=[
                    {
                        "type": "code_interpreter",
                        "action": "deny",
                    },
                    {
                        "type": "mcp",
                        "action": "require_approval",
                    },
                    {
                        "type": "mcp",
                        "action": "deny",
                        "server_domains": [
                            "mcp.example.com",
                        ],
                        "tool_names": [
                            "delete_repository",
                        ],
                    },
                ])

                # Handle response
                print(res)
        - lang: typescript
          label: Typescript (SDK)
          source: |-
            import { SDK } from "@meetkai/mka1";

            const sdk = new SDK({
              bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
            });

            async function run() {
              const result = await sdk.toolPolicy.updateToolPolicy({
                rules: [
                  {
                    type: "code_interpreter",
                    action: "deny",
                  },
                  {
                    type: "mcp",
                    action: "require_approval",
                  },
                  {
                    type: "mcp",
                    action: "deny",
                    serverDomains: [
                      "mcp.example.com",
                    ],
                    toolNames: [
                      "delete_repository",
                    ],
                  },
                ],
              });

              console.log(result);
            }

            run();
components:
  schemas:
    UpdateToolPolicyRequest:
      type: object
      properties:
        rules:
          type: array
          maxItems: 200
          items:
            $ref: '#/components/schemas/ToolPolicyRule'
          description: >-
            A lista completa de regras, no máximo 200 regras e 64 KB. Ela
            substitui a política armazenada; uma lista vazia remove todas as
            restrições. Os domínios do servidor são armazenados normalizados.
      required:
        - rules
    ToolPolicy:
      type: object
      properties:
        object:
          const: tool_policy
        rules:
          type: array
          items:
            $ref: '#/components/schemas/StoredToolPolicyRule'
          description: >-
            As regras da organização. Quando várias regras correspondem a uma
            ferramenta, aplica-se a ação mais restritiva: negar, depois
            exigir_aprovação.
        updated_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          description: >-
            Quando a política foi alterada pela última vez; nulo quando a
            organização não tem uma política.
      required:
        - object
        - rules
        - updated_at
      title: Tool policy
      description: >-
        Uma política de ferramentas de uma organização. Ela se aplica a todas as
        solicitações de Responses na organização, incluindo execuções de agentes
        salvas, e substitui o que a solicitação ou o agente configura.
    ToolPolicyRule:
      type: object
      properties:
        type:
          $ref: '#/components/schemas/PolicyToolType'
        action:
          $ref: '#/components/schemas/ToolPolicyAction'
        server_domains:
          type: array
          minItems: 1
          maxItems: 100
          items:
            type: string
          description: >-
            Apenas regras de MCP. Limita a regra a servidores MCP cujo host da
            URL seja um destes nomes de host ou um subdomínio de um deles, seja
            a solicitação nomeando o servidor inline ou por meio do cofre MCP.
            Omitir para abranger todos os servidores MCP.
        tool_names:
          type: array
          minItems: 1
          maxItems: 100
          items:
            type: string
            minLength: 1
            maxLength: 255
          description: >-
            Somente regras MCP. Limita a regra a estes nomes de ferramentas. Uma
            regra de negação com tool_names remove essas ferramentas do servidor
            em vez de recusar a solicitação. Omitir para abranger todas as
            ferramentas nos servidores correspondentes.
      required:
        - type
        - action
      additionalProperties: false
      title: Tool policy rule
      description: Uma regra da política de ferramentas de uma organização.
    StoredToolPolicyRule:
      type: object
      properties:
        type:
          type: string
          description: >-
            O tipo de ferramenta que a regra governa; consulte o esquema da
            regra de PUT /tool_policy para os valores.
        action:
          $ref: '#/components/schemas/ToolPolicyAction'
        server_domains:
          type: array
          items:
            type: string
          description: >-
            Regras apenas do MCP: os nomes de host do servidor aos quais a regra
            é limitada, normalizados.
        tool_names:
          type: array
          items:
            type: string
          description: >-
            Regras do MCP apenas: o nome da ferramenta à qual a regra está
            limitada.
      required:
        - type
        - action
      title: Stored tool policy rule
      description: Uma regra armazenada da política de ferramentas de uma organização.
    PolicyToolType:
      enum:
        - function
        - custom
        - local_shell
        - file_search
        - web_search
        - code_interpreter
        - shell
        - image_generation
        - mcp
        - openapi
        - agent
        - history
        - sleep
      type: string
      description: >-
        O tipo de ferramenta que a regra governa. web_search abrange todas as
        variantes web_search e web_search_preview. As ferramentas function,
        custom e local_shell são executadas na aplicação do chamador, e history
        e sleep não são retidas para revisão, portanto a política pode negá-las,
        mas não pode exigir aprovação para elas.
    ToolPolicyAction:
      enum:
        - deny
        - require_approval
      type: string
      description: >-
        deny recusa solicitações que configuram a ferramenta (uma regra MCP que
        nomeia tool_names em vez disso remove essas ferramentas).
        require_approval retém todas as chamadas para uma decisão de aprovação
        antes de serem executadas, substituindo require_approval da solicitação.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: API Key
      description: >-
        Send Authorization: Bearer <credential>, using an MKA1 API key for
        automation or an OAuth API access token for a signed-in application. Use
        a dynamic security callback to refresh OAuth access tokens. Browser
        session-only operations still require their declared cookie.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.