> ## 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. # Atualizar as proteções padrão do cluster > Substitua as proteções padrão aplicadas a todas as organizações inscritas e ative-as ou desative-as para todo o cluster. Os administradores da organização podem adicionar regras além do padrão do cluster, mas não podem enfraquecê-lo ou removê-lo. Os modelos classificadores devem estar ativos no registro da organização do cluster; suas chamadas são executadas e contabilizadas como a organização do cluster, de modo que os inquilinos não precisam de acesso ao modelo e seus orçamentos não são cobrados. ## OpenAPI ````yaml https://apigw.mka1.com/speakeasy.json?language=pt-BR put /api/v1/llm/guardrails/cluster-default 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: 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/cluster-default: put: tags: - Guardrails summary: Atualizar as proteções padrão do cluster description: >- Substitua as proteções padrão aplicadas a todas as organizações inscritas e ative-as ou desative-as para todo o cluster. Os administradores da organização podem adicionar regras além do padrão do cluster, mas não podem enfraquecê-lo ou removê-lo. Os modelos classificadores devem estar ativos no registro da organização do cluster; suas chamadas são executadas e contabilizadas como a organização do cluster, de modo que os inquilinos não precisam de acesso ao modelo e seus orçamentos não são cobrados. operationId: updateClusterDefaultGuardrails requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/UpdateClusterDefaultGuardrailsRequest' example: enabled: true guardrails: - mode: prompt_injection enabled: true config: threshold: 0.7 - mode: leakage enabled: true config: threshold: 0.7 - mode: classifier enabled: true config: model: meetkai:custom-classifier prompt: >- Block content that expresses hate toward people based on a protected characteristic, threatens or glorifies violence, is sexually explicit or sexualizes minors, or encourages or instructs self-harm. Allow neutral educational, news, medical and support discussion of these topics. on_error: fail_closed rejection_message: >- This request is not allowed by your organization's content policy. responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ClusterDefaultGuardrailsResponse' example: object: guardrails_cluster_default enabled: true guardrails: - mode: prompt_injection enabled: true config: threshold: 0.7 - mode: leakage enabled: true config: threshold: 0.7 - mode: classifier enabled: true config: model: meetkai:custom-classifier prompt: >- Block content that expresses hate toward people based on a protected characteristic, threatens or glorifies violence, is sexually explicit or sexualizes minors, or encourages or instructs self-harm. Allow neutral educational, news, medical and support discussion of these topics. on_error: fail_closed rejection_message: >- This request is not allowed by your organization's content policy. built_in: false settings_unreadable: false updated_by: user-cluster-admin-1 updated_at: '2026-10-16T12:00:00.000Z' security: - bearerAuth: [] x-codeSamples: - lang: python label: Python (SDK) source: |- from meetkai_mka1 import SDK with SDK( bearer_auth="", ) as sdk: res = sdk.guardrails.update_cluster_default_guardrails(enabled=True, guardrails=[ { "mode": "prompt_injection", "enabled": True, "config": { "threshold": 0.7, }, }, { "mode": "leakage", "enabled": True, "config": { "threshold": 0.7, }, }, { "mode": "classifier", "enabled": True, "config": { "model": "meetkai:custom-classifier", "prompt": "Block content that expresses hate toward people based on a protected characteristic, threatens or glorifies violence, is sexually explicit or sexualizes minors, or encourages or instructs self-harm. Allow neutral educational, news, medical and support discussion of these topics.", "on_error": "fail_closed", "rejection_message": "This request is not allowed by your organization's content policy.", }, }, ]) # Handle response print(res) - lang: typescript label: Typescript (SDK) source: |- import { SDK } from "@meetkai/mka1"; const sdk = new SDK({ bearerAuth: "", }); async function run() { const result = await sdk.guardrails.updateClusterDefaultGuardrails({ enabled: true, guardrails: [ { mode: "prompt_injection", enabled: true, config: { threshold: 0.7, }, }, { mode: "leakage", enabled: true, config: { threshold: 0.7, }, }, { mode: "classifier", enabled: true, config: { model: "meetkai:custom-classifier", prompt: "Block content that expresses hate toward people based on a protected characteristic, threatens or glorifies violence, is sexually explicit or sexualizes minors, or encourages or instructs self-harm. Allow neutral educational, news, medical and support discussion of these topics.", onError: "fail_closed", rejectionMessage: "This request is not allowed by your organization's content policy.", }, }, ], }); console.log(result); } run(); - lang: csharp label: CSharp (SDK) source: >- using MeetKai.MKA1; using MeetKai.MKA1.Types.Components; using System.Collections.Generic; var sdk = new SDK(bearerAuth: ""); UpdateClusterDefaultGuardrailsRequest req = new UpdateClusterDefaultGuardrailsRequest() { Enabled = true, Guardrails = new List() { GuardrailConfig.CreatePromptInjection( new PromptInjectionGuardrail() { Config = new PromptInjectionConfig() {}, } ), GuardrailConfig.CreateLeakage( new LeakageGuardrail() { Config = new LeakageConfig() {}, } ), GuardrailConfig.CreateClassifier( new ClassifierGuardrail() { Config = new ClassifierConfig() { Model = "meetkai:custom-classifier", Prompt = "Block content that expresses hate toward people based on a protected characteristic, threatens or glorifies violence, is sexually explicit or sexualizes minors, or encourages or instructs self-harm. Allow neutral educational, news, medical and support discussion of these topics.", }, } ), }, }; var res = await sdk.Guardrails.UpdateClusterDefaultGuardrailsAsync(req); // handle response components: schemas: UpdateClusterDefaultGuardrailsRequest: type: object properties: enabled: type: boolean description: >- Switch do cluster. Quando falso, o padrão do cluster se aplica a nenhuma organização. guardrails: type: array items: $ref: '#/components/schemas/GuardrailConfig' description: >- Guardrails aplicados em todas as organizações inscritas. Os modelos classificadores são resolvidos no registro da organização do cluster e faturados para ela. required: - enabled - guardrails ClusterDefaultGuardrailsResponse: type: object properties: object: const: guardrails_cluster_default enabled: type: boolean description: >- Switch do cluster. Quando falso, o padrão do cluster se aplica a nenhuma organização. guardrails: type: array items: $ref: '#/components/schemas/GuardrailConfig' description: Restrições aplicadas a cada organização inscrita built_in: type: boolean description: > Verdadeiro enquanto o cluster estiver executando o padrão interno (detecção de injeção de prompt e vazamento) porque nenhum operador salvou um settings_unreadable: type: boolean description: >- Verdadeiro quando o padrão do cluster salvo não pode ser lido: as regras integradas mostradas aqui são aplicadas em seu lugar. Salve uma política para substituí-lo; não salve estas regras de volta, a menos que isso seja intencional updated_by: anyOf: - type: string - type: 'null' description: >- Usuário que alterou por último o padrão do cluster; nulo enquanto o padrão integrado se aplica updated_at: anyOf: - type: string format: date-time - type: 'null' description: >- Quando o padrão do cluster foi alterado pela última vez; nulo enquanto o padrão integrado se aplica required: - object - enabled - guardrails - built_in - settings_unreadable - updated_by - 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 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 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 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 config: $ref: '#/components/schemas/ClassifierConfig' required: - mode - config 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 `. For multi-user server-side integrations, you can also send `X-On-Behalf-Of: `. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.