> ## 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.

# Obtenha uma política de guardrails de recurso

> Guardrails adicionais anexados a um agente salvo na equipe ativa ou a um endpoint de modelo de catálogo em toda a organização. As políticas de cluster, organização e equipe também são sempre aplicadas. Os aliases de modelo são resolvidos para IDs canônicos de modelo; auto não é um endpoint que possa ser anexado. Somente administradores/proprietários da organização podem alterar essas políticas. As políticas se aplicam às versões do agente salvo e às execuções em segundo plano futuras, independentemente de snapshots de versão. As políticas de endpoint configuradas para fallback e redirecionamento de imagens também são verificadas antes do envio, mesmo que um fallback não seja eventualmente necessário.



## OpenAPI

````yaml https://apigw.mka1.com/speakeasy.json?language=pt-BR get /api/v1/llm/guardrails/resource-policies
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: 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: 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
paths:
  /api/v1/llm/guardrails/resource-policies:
    get:
      tags:
        - Guardrails
      summary: Obtenha uma política de guardrails de recurso
      description: >-
        Guardrails adicionais anexados a um agente salvo na equipe ativa ou a um
        endpoint de modelo de catálogo em toda a organização. As políticas de
        cluster, organização e equipe também são sempre aplicadas. Os aliases de
        modelo são resolvidos para IDs canônicos de modelo; auto não é um
        endpoint que possa ser anexado. Somente administradores/proprietários da
        organização podem alterar essas políticas. As políticas se aplicam às
        versões do agente salvo e às execuções em segundo plano futuras,
        independentemente de snapshots de versão. As políticas de endpoint
        configuradas para fallback e redirecionamento de imagens também são
        verificadas antes do envio, mesmo que um fallback não seja eventualmente
        necessário.
      operationId: getGuardrailsResourcePolicy
      parameters:
        - name: resource_type
          in: query
          required: true
          schema:
            enum:
              - agent
              - model
            type: string
            description: Endpoint de modelo de agente ou catálogo salvo.
          allowEmptyValue: true
          example: model
        - name: resource_id
          in: query
          required: true
          schema:
            type: string
            minLength: 1
            maxLength: 255
            description: >-
              ID canônico de agente salvo ou ID de modelo do catálogo. Os
              aliases do modelo são resolvidos antes do armazenamento.
          allowEmptyValue: true
          example: meetkai:functionary-urdu-mini-pak
        - name: X-On-Behalf-Of
          in: header
          required: false
          schema:
            type: string
          description: Optional external end-user identifier forwarded by the API gateway.
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetGuardrailsResourcePolicyResponse'
              example:
                object: guardrails_resource_policy
                policy:
                  resource_type: model
                  resource_id: meetkai:functionary-urdu-mini-pak
                  team_id: null
                  guardrails:
                    - mode: ban_words
                      enabled: true
                      check_output: true
                      config:
                        words:
                          - confidential
                  updated_at: '2026-10-30T00:00:00Z'
      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/operations\"\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.Guardrails.GetGuardrailsResourcePolicy(ctx, operations.ResourceTypeModel, \"meetkai:functionary-urdu-mini-pak\", nil)\n    if err != nil {\n        log.Fatal(err)\n    }\n    if res.GetGuardrailsResourcePolicyResponse != nil {\n        // handle response\n    }\n}"
        - lang: csharp
          label: CSharp (SDK)
          source: |-
            using MeetKai.MKA1;
            using MeetKai.MKA1.Types.Components;
            using MeetKai.MKA1.Types.Requests;

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

            var res = await sdk.Guardrails.GetGuardrailsResourcePolicyAsync(
                resourceType: ResourceType.Model,
                resourceId: "meetkai:functionary-urdu-mini-pak"
            );

            // 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.guardrails.get_guardrails_resource_policy(resource_type="model", resource_id="meetkai:functionary-urdu-mini-pak")

                # 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.guardrails.getGuardrailsResourcePolicy({
                resourceType: "model",
                resourceId: "meetkai:functionary-urdu-mini-pak",
              });

              console.log(result);
            }

            run();
components:
  schemas:
    GetGuardrailsResourcePolicyResponse:
      type: object
      properties:
        object:
          const: guardrails_resource_policy
        policy:
          anyOf:
            - $ref: '#/components/schemas/GuardrailsResourcePolicy'
            - type: 'null'
      required:
        - object
        - policy
    GuardrailsResourcePolicy:
      type: object
      properties:
        resource_type:
          enum:
            - agent
            - model
          type: string
          description: Endpoint de agente ou modelo de catálogo salvo.
        resource_id:
          type: string
          minLength: 1
          maxLength: 255
          description: >-
            ID canônico de agente salvo ou ID de modelo do catálogo. Os aliases
            do modelo são resolvidos antes do armazenamento.
        team_id:
          anyOf:
            - type: string
            - type: 'null'
          description: >-
            Equipe do agente, ou nulo para uma política de endpoint de modelo em
            toda a organização.
        guardrails:
          type: array
          items:
            $ref: '#/components/schemas/GuardrailConfig'
        updated_at:
          type: string
          format: date-time
      required:
        - resource_type
        - resource_id
        - team_id
        - guardrails
        - updated_at
    GuardrailConfig:
      anyOf:
        - $ref: '#/components/schemas/BanWordsGuardrail'
        - $ref: '#/components/schemas/PromptInjectionGuardrail'
        - $ref: '#/components/schemas/LeakageGuardrail'
        - $ref: '#/components/schemas/ClassifierGuardrail'
      discriminator:
        propertyName: mode
        mapping:
          ban_words: '#/components/schemas/BanWordsGuardrail'
          prompt_injection: '#/components/schemas/PromptInjectionGuardrail'
          leakage: '#/components/schemas/LeakageGuardrail'
          classifier: '#/components/schemas/ClassifierGuardrail'
    BanWordsGuardrail:
      type: object
      properties:
        mode:
          const: ban_words
        enabled:
          type: boolean
          default: true
          description: Se essa proteção lateral está habilitada
        check_output:
          type: boolean
          description: >-
            Aplique também essa proteção na saída do modelo, não apenas na
            solicitação
        output_timing:
          enum:
            - final
            - streaming
          type: string
          description: >-
            Quando esta regra verifica a saída do modelo: final (padrão)
            verifica o texto final uma vez, depois que ele foi transmitido;
            streaming mantém o texto transmitido em uma janela e libera apenas o
            texto que esta regra já aprovou
        output_window:
          $ref: '#/components/schemas/OutputWindow'
          description: >-
            Janela para verificações da saída em streaming; omita para usar os
            padrões do gateway. Uma verificação é executada quando max_chars
            caracteres ou max_ms milissegundos de texto não verificado tiverem
            se acumulado, o que ocorrer primeiro
        input_sources:
          type: array
          items:
            $ref: '#/components/schemas/GuardrailInputSource'
          description: >-
            Solicite as fontes que esta regra de proteção verifica antes que
            elas cheguem ao modelo. Omitir para usar o padrão do modo: todas as
            fontes para classifier; todas as fontes exceto system para
            ban_words, já que as instruções frequentemente nomeiam os termos que
            proíbem; apenas o que o usuário envia para prompt_injection e
            leakage, cujos padrões de palavras-chave correspondem a instruções,
            respostas e documentos comuns. Uma lista vazia não verifica nenhuma
            entrada, então a regra verifica apenas a saída quando check_output
            está definido. Regras salvas antes de este campo existir eram
            definidas apenas para mensagens do usuário.
        config:
          $ref: '#/components/schemas/BanWordsConfig'
          description: Configuração de palavras proibidas
      required:
        - mode
      description: Guia de palavras proibidas
    PromptInjectionGuardrail:
      type: object
      properties:
        mode:
          const: prompt_injection
        enabled:
          type: boolean
          default: true
          description: Se essa proteção lateral está habilitada
        check_output:
          type: boolean
          description: >-
            Aplique também essa proteção na saída do modelo, não apenas na
            solicitação
        output_timing:
          enum:
            - final
            - streaming
          type: string
          description: >-
            Quando esta regra verifica a saída do modelo: final (padrão)
            verifica o texto final uma vez, depois que ele foi transmitido;
            streaming mantém o texto transmitido em uma janela e libera apenas o
            texto que esta regra já aprovou
        output_window:
          $ref: '#/components/schemas/OutputWindow'
          description: >-
            Janela para verificações da saída em streaming; omita para usar os
            padrões do gateway. Uma verificação é executada quando max_chars
            caracteres ou max_ms milissegundos de texto não verificado tiverem
            se acumulado, o que ocorrer primeiro
        input_sources:
          type: array
          items:
            $ref: '#/components/schemas/GuardrailInputSource'
          description: >-
            Solicite as fontes que esta regra de proteção verifica antes que
            elas cheguem ao modelo. Omitir para usar o padrão do modo: todas as
            fontes para classifier; todas as fontes exceto system para
            ban_words, já que as instruções frequentemente nomeiam os termos que
            proíbem; apenas o que o usuário envia para prompt_injection e
            leakage, cujos padrões de palavras-chave correspondem a instruções,
            respostas e documentos comuns. Uma lista vazia não verifica nenhuma
            entrada, então a regra verifica apenas a saída quando check_output
            está definido. Regras salvas antes de este campo existir eram
            definidas apenas para mensagens do usuário.
        config:
          $ref: '#/components/schemas/PromptInjectionConfig'
          description: Configuração de injeção de prompt
      required:
        - mode
      description: Barreira de proteção contra injeção de prompt
    LeakageGuardrail:
      type: object
      properties:
        mode:
          const: leakage
        enabled:
          type: boolean
          default: true
          description: Se essa proteção lateral está habilitada
        check_output:
          type: boolean
          description: >-
            Aplique também essa proteção na saída do modelo, não apenas na
            solicitação
        output_timing:
          enum:
            - final
            - streaming
          type: string
          description: >-
            Quando esta regra verifica a saída do modelo: final (padrão)
            verifica o texto final uma vez, depois que ele foi transmitido;
            streaming mantém o texto transmitido em uma janela e libera apenas o
            texto que esta regra já aprovou
        output_window:
          $ref: '#/components/schemas/OutputWindow'
          description: >-
            Janela para verificações da saída em streaming; omita para usar os
            padrões do gateway. Uma verificação é executada quando max_chars
            caracteres ou max_ms milissegundos de texto não verificado tiverem
            se acumulado, o que ocorrer primeiro
        input_sources:
          type: array
          items:
            $ref: '#/components/schemas/GuardrailInputSource'
          description: >-
            Solicite as fontes que esta regra de proteção verifica antes que
            elas cheguem ao modelo. Omitir para usar o padrão do modo: todas as
            fontes para classifier; todas as fontes exceto system para
            ban_words, já que as instruções frequentemente nomeiam os termos que
            proíbem; apenas o que o usuário envia para prompt_injection e
            leakage, cujos padrões de palavras-chave correspondem a instruções,
            respostas e documentos comuns. Uma lista vazia não verifica nenhuma
            entrada, então a regra verifica apenas a saída quando check_output
            está definido. Regras salvas antes de este campo existir eram
            definidas apenas para mensagens do usuário.
        config:
          $ref: '#/components/schemas/LeakageConfig'
          description: Configuração de vazamento
      required:
        - mode
      description: Guarda-corpo contra vazamentos
    ClassifierGuardrail:
      type: object
      properties:
        mode:
          const: classifier
        enabled:
          type: boolean
          default: true
          description: Se essa proteção lateral está habilitada
        check_output:
          type: boolean
          description: >-
            Aplique também essa proteção na saída do modelo, não apenas na
            solicitação
        output_timing:
          enum:
            - final
            - streaming
          type: string
          description: >-
            Quando esta regra verifica a saída do modelo: final (padrão)
            verifica o texto final uma vez, depois que ele foi transmitido;
            streaming mantém o texto transmitido em uma janela e libera apenas o
            texto que esta regra já aprovou
        output_window:
          $ref: '#/components/schemas/OutputWindow'
          description: >-
            Janela para verificações da saída em streaming; omita para usar os
            padrões do gateway. Uma verificação é executada quando max_chars
            caracteres ou max_ms milissegundos de texto não verificado tiverem
            se acumulado, o que ocorrer primeiro
        input_sources:
          type: array
          items:
            $ref: '#/components/schemas/GuardrailInputSource'
          description: >-
            Solicite as fontes que esta regra de proteção verifica antes que
            elas cheguem ao modelo. Omitir para usar o padrão do modo: todas as
            fontes para classifier; todas as fontes exceto system para
            ban_words, já que as instruções frequentemente nomeiam os termos que
            proíbem; apenas o que o usuário envia para prompt_injection e
            leakage, cujos padrões de palavras-chave correspondem a instruções,
            respostas e documentos comuns. Uma lista vazia não verifica nenhuma
            entrada, então a regra verifica apenas a saída quando check_output
            está definido. Regras salvas antes de este campo existir eram
            definidas apenas para mensagens do usuário.
        config:
          $ref: '#/components/schemas/ClassifierConfig'
      required:
        - mode
        - config
    OutputWindow:
      type: object
      properties:
        max_chars:
          type: integer
          minimum: 100
          maximum: 9007199254740991
          description: >-
            Verifique quando acumular essa quantidade de caracteres de texto não
            verificado
        max_ms:
          type: integer
          minimum: 250
          maximum: 2147483647
          description: >-
            Verifique se o texto não marcado mais antigo foi mantido por esta
            quantidade de milissegundos
      description: >
        Quando uma verificação de saída de streaming é executada: o que ocorrer
        primeiro entre max_chars e max_ms
    GuardrailInputSource:
      enum:
        - user
        - system
        - assistant
        - tool
        - retrieval
        - image
        - audio
      type: string
      description: >-
        Uma fonte de entrada do modelo: usuário (mensagens do usuário e texto
        enviado para uma resposta em espera), sistema (mensagens do sistema e do
        desenvolvedor, instruções e resumos de compactação), assistente
        (mensagens anteriores do assistente), ferramenta (resultados de função,
        ferramenta personalizada, MCP, shell e interpretador de código),
        recuperação (pesquisa de arquivo, pesquisa na web, resultados de página
        da web, arquivo enviado e pesquisa no histórico), imagem (texto lido de
        imagens nas mensagens) ou áudio (transcrições de áudio nas mensagens)
    BanWordsConfig:
      type: object
      properties:
        words:
          type: array
          items:
            type: string
          default: []
          description: Lista de palavras ou frases proibidas
        rejection_message:
          type: string
          default: >-
            I'm sorry, but I can't process this request as it contains content
            that isn't allowed. Please rephrase your message.
          description: >-
            A mensagem a ser retornada quando esta barreira de proteção for
            acionada.
      description: Configuração para guarda-rede de palavras banidas
    PromptInjectionConfig:
      type: object
      properties:
        threshold:
          type: number
          minimum: 0
          maximum: 1
          default: 0.7
          description: Limite de detecção (0-1)
        rejection_message:
          type: string
          default: >-
            I'm sorry, but I can't process this request. Please rephrase your
            message in a different way.
          description: >-
            A mensagem a ser retornada quando esta barreira de proteção for
            acionada.
      description: Configuração para a detecção de injeção de prompt guardrail
    LeakageConfig:
      type: object
      properties:
        threshold:
          type: number
          minimum: 0
          maximum: 1
          default: 0.7
          description: Limite de detecção (0-1)
        rejection_message:
          type: string
          default: >-
            I'm sorry, but I can't help with that type of request. Please ask me
            something else.
          description: >-
            A mensagem a ser retornada quando esta barreira de proteção for
            acionada.
      description: >-
        Configuração para detecção de vazamento de prompt do sistema
        guarda-chuva
    ClassifierConfig:
      type: object
      properties:
        model:
          type: string
          minLength: 1
          description: ID exato do modelo disponível no registro da organização do chamador
        prompt:
          type: string
          minLength: 1
          maxLength: 16000
          description: >-
            Instruções que definem quando bloquear ou permitir conteúdo; o
            conteúdo é fornecido separadamente
        on_error:
          enum:
            - fail_closed
            - fail_open
          type: string
          default: fail_closed
          description: >-
            Interrompa a solicitação ou ignore este classificador quando a
            avaliação falhar
        rejection_message:
          type: string
          default: This request is not allowed by your organization's content policy.
          description: Mensagem retornada quando a classificação bloqueia o conteúdo
      required:
        - model
        - prompt
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: API Key
      description: >-
        Gateway auth: send `Authorization: Bearer <mka1-api-key>`. For
        multi-user server-side integrations, you can also send `X-On-Behalf-Of:
        <external-user-id>`.

````

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