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

# Update guardrails policy

> Replace a guardrails policy. Omit team_id to set the org-wide policy (org admin only); provide team_id to set that team's additional policy (org admins may target any team in their org, other callers only their own team). The org-wide policy applies to every team; a team policy is enforced in addition to it — configuring a team policy never weakens the org-wide one.



## OpenAPI

````yaml https://apigw.mka1.com/speakeasy.json put /api/v1/llm/guardrails
openapi: 3.1.1
info:
  title: MKA1 API
  version: 1.1.0
  description: >-
    The MKA1 API is a RESTful API that provides access to the MKA1 platform.
    Learn how to get started with the API and the TypeScript SDK
    [here](https://mka1.apidocumentation.com/guides/getting-started).
  license:
    name: Proprietary
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: >-
      Manage permissions for LLM resources. Create resources, grant/revoke
      permissions, and delete resources. Only resource owners can grant, revoke,
      or delete permissions.
    x-displayName: Resource Authorization
  - name: Embeddings
    description: >-
      Text embedding API endpoints for generating vector representations of
      text. Create semantic embeddings for search, clustering, and similarity
      matching using various embedding models.
    x-displayName: Embeddings
  - name: Feedback
    description: >-
      User feedback API for rating and commenting on chat completions. Collect
      thumbs up/down ratings and detailed feedback to improve model responses
      and track user satisfaction.
    x-displayName: Feedback
  - name: Images
    description: >-
      Image generation API endpoints for creating images from text descriptions.
      Generate images with control over size, quality, and style.
    x-displayName: Images
  - name: MCP Vault
    description: >-
      MCP vault API for storing user-owned MCP server configurations and
      encrypted credentials. Agents reference vault IDs so secrets are resolved
      only at tool execution time.
    x-displayName: MCP Vault
  - name: Speech
    description: >-
      Speech API endpoints for audio processing. Convert text to
      natural-sounding speech (TTS) or transcribe speech to text (STT) in
      different languages.
    x-displayName: Speech
  - name: Usage
    description: >-
      Usage tracking and analytics API for monitoring token consumption, request
      counts, and cost analysis. View detailed statistics per user, model, and
      time period.
    x-displayName: Usage
  - name: Extract
    description: >-
      Structured data extraction API for extracting information from files.
      Define JSON schemas to extract structured data from images, PDFs, and
      documents. Supports reusable schema templates.
    x-displayName: Extract
  - name: Text Classification
    description: >-
      Text classification API for categorizing text into predefined labels. Use
      AI models to classify text content for sentiment analysis, topic
      categorization, and content moderation.
    x-displayName: Text Classification
  - name: Responses
    description: >-
      Agent-powered responses API for creating AI agents with autonomous tool
      usage. Build conversational assistants that can use web search, file
      operations, image generation, code execution, computer use simulation, and
      MCP integrations. Supports background processing, streaming, and real-time
      status tracking.
    x-displayName: Responses
  - name: Files
    description: >-
      File management API for uploading, storing, and managing files with
      automatic expiration and S3 integration. Upload files that can be used
      with Assistants, Vector Stores, and other features. Files are stored in S3
      with metadata tracked in PostgreSQL. Supports automatic cleanup of expired
      files.
    x-displayName: Files
  - name: Vector Stores
    description: >-
      Vector store API for storing and searching documents using embeddings.
      Create vector stores, upload files with automatic chunking and embedding
      generation, and perform semantic search. Files are processed
      asynchronously using Temporal workflows for durability. Supports automatic
      cleanup of expired stores and LanceDB for efficient vector storage.
    x-displayName: Vector Stores
  - name: Conversations
    description: >-
      Conversation management API for storing and retrieving conversation state
      across Response API calls. Create conversations, add items (user messages,
      assistant messages, system messages), and maintain conversation history.
      Supports metadata tracking and multi-turn dialogue state management.
    x-displayName: Conversations
  - name: Guardrails
    description: >-
      AI safety guardrails API for configuring content moderation and security
      policies. Set up ban word lists, prompt injection detection, and system
      prompt leakage prevention. Guardrails apply to all requests from an
      account and can be tested before deployment.
    x-displayName: Guardrails
  - name: Models
    description: >-
      Model listing API for discovering available models. Returns model IDs,
      ownership, and metadata for all registered models in the gateway.
    x-displayName: Models
  - name: Skills
    description: >-
      Skills API for managing versioned bundles of instructions and files
      following the Agent Skills standard. Create, version, and download
      reusable skill packages that include SKILL.md manifests for agent
      environments.
    x-displayName: Skills
  - name: Chat Completions
    description: >-
      **Deprecated: Use the Responses API (`/api/v1/llm/responses`) instead.**
      Chat completion endpoints with support for streaming, tool calls, and
      multiple providers.
    x-deprecated: true
    x-displayName: Chat Completions
  - name: Batches
    x-displayName: Batches
  - name: Evals
    x-displayName: Evals
  - name: Fine-Tuning
    x-displayName: Fine-Tuning
  - name: Memory Stores
    x-displayName: Memory Stores
  - name: Prompts
    x-displayName: Prompts
  - name: Budgets
    x-displayName: Budgets
  - name: Tables
    description: Manage table schemas, data operations, search, and indices.
    x-displayName: Tables
  - name: Text Store
    description: >-
      Manage text stores with hybrid (vector + full-text) search and grouped
      text sets.
    x-displayName: Text Store
  - name: GraphRAG
    description: >-
      Construct and query lightweight knowledge graphs backed by Redis and
      LanceDB.
    x-displayName: GraphRAG
  - name: API Key
    x-displayName: API Key
  - name: Sessions
    description: Create, inspect, access, and terminate sandbox sessions.
    x-displayName: Sessions
  - name: Browser
    description: >-
      Connect to browser sessions through the gateway port proxy. Browser
      sessions expose a Chrome DevTools Protocol endpoint on port 9222.
    x-displayName: Browser
  - name: Execution
    description: Run shell commands and code inside an existing sandbox session.
    x-displayName: Execution
  - name: Workspace
    description: >-
      Inspect the workspace manifest, transfer files or archives, and download
      generated artifacts.
    x-displayName: Workspace
  - name: Sandbox Usage
    x-displayName: Sandbox Usage
  - name: Agents
    description: Create and manage reusable agent definitions.
    x-displayName: Agents
  - name: Agent Versions
    description: Inspect an agent's configuration history and roll back to a prior version.
    x-displayName: Agent Versions
  - name: Agent Runs
    description: Execute saved agents and inspect persisted run results.
    x-displayName: Agent Runs
  - name: Agent Schedules
    description: Create and manage scheduled or recurring saved agent runs.
    x-displayName: Agent Schedules
  - name: schema-5_other
    x-displayName: other
paths:
  /api/v1/llm/guardrails:
    put:
      tags:
        - Guardrails
      summary: Update guardrails policy
      description: >-
        Replace a guardrails policy. Omit team_id to set the org-wide policy
        (org admin only); provide team_id to set that team's additional policy
        (org admins may target any team in their org, other callers only their
        own team). The org-wide policy applies to every team; a team policy is
        enforced in addition to it — configuring a team policy never weakens the
        org-wide one.
      operationId: updateGuardrails
      parameters:
        - name: X-On-Behalf-Of
          in: header
          required: false
          schema:
            type: string
          description: Optional external end-user identifier forwarded by the API gateway.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateGuardrailsRequest'
            example:
              guardrails:
                - mode: ban_words
                  enabled: true
                  config:
                    words:
                      - spam
                      - inappropriate
              team_id: team-alpha
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateGuardrailsResponse'
              example:
                object: guardrails_settings
                guardrails:
                  - mode: ban_words
                    enabled: true
                    config:
                      words:
                        - spam
                        - inappropriate
                team_id: team-alpha
                updated_at: 1704067200
      security:
        - bearerAuth: []
      x-codeSamples:
        - lang: python
          label: Python (SDK)
          source: |-
            from meetkai_mka1 import SDK


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

                res = sdk.guardrails.update_guardrails(guardrails=[
                    {
                        "mode": "ban_words",
                        "enabled": True,
                        "config": {
                            "words": [
                                "spam",
                                "inappropriate",
                            ],
                        },
                    },
                ], team_id="team-alpha")

                # 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.updateGuardrails({
                updateGuardrailsRequest: {
                  guardrails: [
                    {
                      mode: "ban_words",
                      enabled: true,
                      config: {
                        words: [
                          "spam",
                          "inappropriate",
                        ],
                      },
                    },
                  ],
                  teamId: "team-alpha",
                },
              });

              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: "<YOUR_BEARER_TOKEN_HERE>");


            var res = await sdk.Guardrails.UpdateGuardrailsAsync(body: new
            MeetKai.MKA1.Types.Components.UpdateGuardrailsRequest() {
                Guardrails = new List<GuardrailConfig>() {
                    GuardrailConfig.CreateBanWords(
                        new BanWordsGuardrail() {
                            Config = new BanWordsConfig() {
                                Words = new List<string>() {
                                    "spam",
                                    "inappropriate",
                                },
                            },
                        }
                    ),
                },
                TeamId = "team-alpha",
            });


            // handle response
components:
  schemas:
    UpdateGuardrailsRequest:
      type: object
      properties:
        guardrails:
          type: array
          items:
            $ref: '#/components/schemas/GuardrailConfig'
          description: List of guardrails to configure
        team_id:
          anyOf:
            - type: string
              minLength: 1
            - type: 'null'
          description: >-
            Target team for this policy. Omit or pass null to set the org-wide
            policy that applies to every team (org admin only). Non-admin
            callers may only target their own team.
      required:
        - guardrails
    UpdateGuardrailsResponse:
      type: object
      properties:
        object:
          const: guardrails_settings
        guardrails:
          type: array
          items:
            $ref: '#/components/schemas/GuardrailConfig'
        team_id:
          anyOf:
            - type: string
            - type: 'null'
          description: Team this policy targets; null for the org-wide policy
        updated_at:
          type: number
          description: Unix timestamp of when the policy was updated
      required:
        - object
        - guardrails
        - team_id
        - updated_at
    GuardrailConfig:
      anyOf:
        - $ref: '#/components/schemas/BanWordsGuardrail'
        - $ref: '#/components/schemas/PromptInjectionGuardrail'
        - $ref: '#/components/schemas/LeakageGuardrail'
      discriminator:
        propertyName: mode
        mapping:
          ban_words:
            $ref: '#/components/schemas/BanWordsGuardrail'
          prompt_injection:
            $ref: '#/components/schemas/PromptInjectionGuardrail'
          leakage:
            $ref: '#/components/schemas/LeakageGuardrail'
    BanWordsGuardrail:
      type: object
      properties:
        mode:
          const: ban_words
        enabled:
          type: boolean
          default: true
          description: Whether this guardrail is enabled
        check_output:
          type: boolean
          description: Also apply this guardrail to model output, not just the request
        config:
          $ref: '#/components/schemas/BanWordsConfig'
          description: Banned words configuration
      required:
        - mode
      description: Banned words guardrail
    PromptInjectionGuardrail:
      type: object
      properties:
        mode:
          const: prompt_injection
        enabled:
          type: boolean
          default: true
          description: Whether this guardrail is enabled
        check_output:
          type: boolean
          description: Also apply this guardrail to model output, not just the request
        config:
          $ref: '#/components/schemas/PromptInjectionConfig'
          description: Prompt injection configuration
      required:
        - mode
      description: Prompt injection guardrail
    LeakageGuardrail:
      type: object
      properties:
        mode:
          const: leakage
        enabled:
          type: boolean
          default: true
          description: Whether this guardrail is enabled
        check_output:
          type: boolean
          description: Also apply this guardrail to model output, not just the request
        config:
          $ref: '#/components/schemas/LeakageConfig'
          description: Leakage configuration
      required:
        - mode
      description: Leakage guardrail
    BanWordsConfig:
      type: object
      properties:
        words:
          type: array
          items:
            type: string
          default: []
          description: List of banned words or phrases
        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: The message to return when this guardrail is triggered
      description: Configuration for banned words guardrail
    PromptInjectionConfig:
      type: object
      properties:
        threshold:
          type: number
          minimum: 0
          maximum: 1
          default: 0.7
          description: Detection threshold (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: The message to return when this guardrail is triggered
      description: Configuration for prompt injection detection guardrail
    LeakageConfig:
      type: object
      properties:
        threshold:
          type: number
          minimum: 0
          maximum: 1
          default: 0.7
          description: Detection threshold (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: The message to return when this guardrail is triggered
      description: Configuration for system prompt leakage detection guardrail
  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>`.

````