AI Prompt Template: Block untemplated requests - Plugin

Block untemplated requestsv3.6+

Configure the AI Prompt Template plugin with a template and block any requests that don’t include a template.

Prerequisites

AI Proxy plugin or AI Proxy Advanced plugin configured with an LLM service

Set up the plugin

Add this section to your declarative configuration file:

_format_version: "3.0"
plugins:
  - name: ai-prompt-template
    config:
      allow_untemplated_requests: false
      templates:
      - name: developer-chat
        template: |-
          {
              "messages": [
              {
                  "role": "system",
                  "content": "You are a {{program}} expert, in {{language}} programming language."
              },
              {
                  "role": "user",
                  "content": "Write me a {{program}} program."
              }
            ]
          }

Make the following request:

curl -i -X POST http://localhost:8001/plugins/ \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --data '
    {
      "name": "ai-prompt-template",
      "config": {
        "allow_untemplated_requests": false,
        "templates": [
          {
            "name": "developer-chat",
            "template": "{\n    \"messages\": [\n    {\n        \"role\": \"system\",\n        \"content\": \"You are a {{program}} expert, in {{language}} programming language.\"\n    },\n    {\n        \"role\": \"user\",\n        \"content\": \"Write me a {{program}} program.\"\n    }\n  ]\n}"
          }
        ]
      }
    }
    '

Make the following request:

curl -X POST https://{region}.api.konghq.com/v2/control-planes/{controlPlaneId}/core-entities/plugins/ \
    --header "accept: application/json" \
    --header "Content-Type: application/json" \
    --header "Authorization: Bearer $KONNECT_TOKEN" \
    --data '
    {
      "name": "ai-prompt-template",
      "config": {
        "allow_untemplated_requests": false,
        "templates": [
          {
            "name": "developer-chat",
            "template": "{\n    \"messages\": [\n    {\n        \"role\": \"system\",\n        \"content\": \"You are a {{program}} expert, in {{language}} programming language.\"\n    },\n    {\n        \"role\": \"user\",\n        \"content\": \"Write me a {{program}} program.\"\n    }\n  ]\n}"
          }
        ]
      }
    }
    '

Make sure to replace the following placeholders with your own values:

region: Geographic region where your Kong Konnect is hosted and operates.
controlPlaneId: The id of the control plane.
KONNECT_TOKEN: Your Personal Access Token (PAT) associated with your Konnect account.

See the Konnect API reference to learn about region-specific URLs and personal access tokens.

echo "
apiVersion: configuration.konghq.com/v1
kind: KongClusterPlugin
metadata:
  name: ai-prompt-template
  namespace: kong
  annotations:
    kubernetes.io/ingress.class: kong
  labels:
    global: 'true'
config:
  allow_untemplated_requests: false
  templates:
  - name: developer-chat
    template: |-
      {
          'messages': [
          {
              'role': 'system',
              'content': 'You are a {{program}} expert, in {{language}} programming language.'
          },
          {
              'role': 'user',
              'content': 'Write me a {{program}} program.'
          }
        ]
      }
plugin: ai-prompt-template
" | kubectl apply -f -

Prerequisite: Configure your Personal Access Token

terraform {
  required_providers {
    konnect = {
      source  = "kong/konnect"
    }
  }
}

provider "konnect" {
  personal_access_token = "$KONNECT_TOKEN"
  server_url            = "https://us.api.konghq.com/"
}

Add the following to your Terraform configuration to create a Konnect Gateway Plugin:

resource "konnect_gateway_plugin_ai_prompt_template" "my_ai_prompt_template" {
  enabled = true

  config = {
    allow_untemplated_requests = false
    templates = [
      {
        name = "developer-chat"
        template = <<EOF
{
    "messages": [
    {
        "role": "system",
        "content": "You are a {{program}} expert, in {{language}} programming language."
    },
    {
        "role": "user",
        "content": "Write me a {{program}} program."
    }
  ]
}
EOF
      }    ]
  }

  control_plane_id = konnect_gateway_control_plane.my_konnect_cp.id
}

Add this section to your declarative configuration file:

_format_version: "3.0"
plugins:
  - name: ai-prompt-template
    service: serviceName|Id
    config:
      allow_untemplated_requests: false
      templates:
      - name: developer-chat
        template: |-
          {
              "messages": [
              {
                  "role": "system",
                  "content": "You are a {{program}} expert, in {{language}} programming language."
              },
              {
                  "role": "user",
                  "content": "Write me a {{program}} program."
              }
            ]
          }

Make sure to replace the following placeholders with your own values:

serviceName|Id: The id or name of the service the plugin configuration will target.

Make the following request:

curl -i -X POST http://localhost:8001/services/{serviceName|Id}/plugins/ \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --data '
    {
      "name": "ai-prompt-template",
      "config": {
        "allow_untemplated_requests": false,
        "templates": [
          {
            "name": "developer-chat",
            "template": "{\n    \"messages\": [\n    {\n        \"role\": \"system\",\n        \"content\": \"You are a {{program}} expert, in {{language}} programming language.\"\n    },\n    {\n        \"role\": \"user\",\n        \"content\": \"Write me a {{program}} program.\"\n    }\n  ]\n}"
          }
        ]
      }
    }
    '

Make sure to replace the following placeholders with your own values:

serviceName|Id: The id or name of the service the plugin configuration will target.

Make the following request:

curl -X POST https://{region}.api.konghq.com/v2/control-planes/{controlPlaneId}/core-entities/services/{serviceId}/plugins/ \
    --header "accept: application/json" \
    --header "Content-Type: application/json" \
    --header "Authorization: Bearer $KONNECT_TOKEN" \
    --data '
    {
      "name": "ai-prompt-template",
      "config": {
        "allow_untemplated_requests": false,
        "templates": [
          {
            "name": "developer-chat",
            "template": "{\n    \"messages\": [\n    {\n        \"role\": \"system\",\n        \"content\": \"You are a {{program}} expert, in {{language}} programming language.\"\n    },\n    {\n        \"role\": \"user\",\n        \"content\": \"Write me a {{program}} program.\"\n    }\n  ]\n}"
          }
        ]
      }
    }
    '

Make sure to replace the following placeholders with your own values:

region: Geographic region where your Kong Konnect is hosted and operates.
controlPlaneId: The id of the control plane.
KONNECT_TOKEN: Your Personal Access Token (PAT) associated with your Konnect account.
serviceId: The id of the service the plugin configuration will target.

See the Konnect API reference to learn about region-specific URLs and personal access tokens.

echo "
apiVersion: configuration.konghq.com/v1
kind: KongPlugin
metadata:
  name: ai-prompt-template
  namespace: kong
  annotations:
    kubernetes.io/ingress.class: kong
config:
  allow_untemplated_requests: false
  templates:
  - name: developer-chat
    template: |-
      {
          'messages': [
          {
              'role': 'system',
              'content': 'You are a {{program}} expert, in {{language}} programming language.'
          },
          {
              'role': 'user',
              'content': 'Write me a {{program}} program.'
          }
        ]
      }
plugin: ai-prompt-template
" | kubectl apply -f -

Next, apply the KongPlugin resource by annotating the service resource:

kubectl annotate -n kong service SERVICE_NAME konghq.com/plugins=ai-prompt-template

Prerequisite: Configure your Personal Access Token

terraform {
  required_providers {
    konnect = {
      source  = "kong/konnect"
    }
  }
}

provider "konnect" {
  personal_access_token = "$KONNECT_TOKEN"
  server_url            = "https://us.api.konghq.com/"
}

Add the following to your Terraform configuration to create a Konnect Gateway Plugin:

resource "konnect_gateway_plugin_ai_prompt_template" "my_ai_prompt_template" {
  enabled = true

  config = {
    allow_untemplated_requests = false
    templates = [
      {
        name = "developer-chat"
        template = <<EOF
{
    "messages": [
    {
        "role": "system",
        "content": "You are a {{program}} expert, in {{language}} programming language."
    },
    {
        "role": "user",
        "content": "Write me a {{program}} program."
    }
  ]
}
EOF
      }    ]
  }

  control_plane_id = konnect_gateway_control_plane.my_konnect_cp.id
  service = {
    id = konnect_gateway_service.my_service.id
  }
}

Add this section to your declarative configuration file:

_format_version: "3.0"
plugins:
  - name: ai-prompt-template
    route: routeName|Id
    config:
      allow_untemplated_requests: false
      templates:
      - name: developer-chat
        template: |-
          {
              "messages": [
              {
                  "role": "system",
                  "content": "You are a {{program}} expert, in {{language}} programming language."
              },
              {
                  "role": "user",
                  "content": "Write me a {{program}} program."
              }
            ]
          }

Make sure to replace the following placeholders with your own values:

routeName|Id: The id or name of the route the plugin configuration will target.

Make the following request:

curl -i -X POST http://localhost:8001/routes/{routeName|Id}/plugins/ \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --data '
    {
      "name": "ai-prompt-template",
      "config": {
        "allow_untemplated_requests": false,
        "templates": [
          {
            "name": "developer-chat",
            "template": "{\n    \"messages\": [\n    {\n        \"role\": \"system\",\n        \"content\": \"You are a {{program}} expert, in {{language}} programming language.\"\n    },\n    {\n        \"role\": \"user\",\n        \"content\": \"Write me a {{program}} program.\"\n    }\n  ]\n}"
          }
        ]
      }
    }
    '

Make sure to replace the following placeholders with your own values:

routeName|Id: The id or name of the route the plugin configuration will target.

Make the following request:

curl -X POST https://{region}.api.konghq.com/v2/control-planes/{controlPlaneId}/core-entities/routes/{routeId}/plugins/ \
    --header "accept: application/json" \
    --header "Content-Type: application/json" \
    --header "Authorization: Bearer $KONNECT_TOKEN" \
    --data '
    {
      "name": "ai-prompt-template",
      "config": {
        "allow_untemplated_requests": false,
        "templates": [
          {
            "name": "developer-chat",
            "template": "{\n    \"messages\": [\n    {\n        \"role\": \"system\",\n        \"content\": \"You are a {{program}} expert, in {{language}} programming language.\"\n    },\n    {\n        \"role\": \"user\",\n        \"content\": \"Write me a {{program}} program.\"\n    }\n  ]\n}"
          }
        ]
      }
    }
    '

Make sure to replace the following placeholders with your own values:

region: Geographic region where your Kong Konnect is hosted and operates.
controlPlaneId: The id of the control plane.
KONNECT_TOKEN: Your Personal Access Token (PAT) associated with your Konnect account.
routeId: The id of the route the plugin configuration will target.

See the Konnect API reference to learn about region-specific URLs and personal access tokens.

echo "
apiVersion: configuration.konghq.com/v1
kind: KongPlugin
metadata:
  name: ai-prompt-template
  namespace: kong
  annotations:
    kubernetes.io/ingress.class: kong
config:
  allow_untemplated_requests: false
  templates:
  - name: developer-chat
    template: |-
      {
          'messages': [
          {
              'role': 'system',
              'content': 'You are a {{program}} expert, in {{language}} programming language.'
          },
          {
              'role': 'user',
              'content': 'Write me a {{program}} program.'
          }
        ]
      }
plugin: ai-prompt-template
" | kubectl apply -f -

Next, apply the KongPlugin resource by annotating the httproute or ingress resource:

kubectl annotate -n kong httproute  konghq.com/plugins=ai-prompt-template

kubectl annotate -n kong ingress  konghq.com/plugins=ai-prompt-template

Prerequisite: Configure your Personal Access Token

terraform {
  required_providers {
    konnect = {
      source  = "kong/konnect"
    }
  }
}

provider "konnect" {
  personal_access_token = "$KONNECT_TOKEN"
  server_url            = "https://us.api.konghq.com/"
}

Add the following to your Terraform configuration to create a Konnect Gateway Plugin:

resource "konnect_gateway_plugin_ai_prompt_template" "my_ai_prompt_template" {
  enabled = true

  config = {
    allow_untemplated_requests = false
    templates = [
      {
        name = "developer-chat"
        template = <<EOF
{
    "messages": [
    {
        "role": "system",
        "content": "You are a {{program}} expert, in {{language}} programming language."
    },
    {
        "role": "user",
        "content": "Write me a {{program}} program."
    }
  ]
}
EOF
      }    ]
  }

  control_plane_id = konnect_gateway_control_plane.my_konnect_cp.id
  route = {
    id = konnect_gateway_route.my_route.id
  }
}

Add this section to your declarative configuration file:

_format_version: "3.0"
plugins:
  - name: ai-prompt-template
    consumer: consumerName|Id
    config:
      allow_untemplated_requests: false
      templates:
      - name: developer-chat
        template: |-
          {
              "messages": [
              {
                  "role": "system",
                  "content": "You are a {{program}} expert, in {{language}} programming language."
              },
              {
                  "role": "user",
                  "content": "Write me a {{program}} program."
              }
            ]
          }

Make sure to replace the following placeholders with your own values:

consumerName|Id: The id or name of the consumer the plugin configuration will target.

Make the following request:

curl -i -X POST http://localhost:8001/consumers/{consumerName|Id}/plugins/ \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --data '
    {
      "name": "ai-prompt-template",
      "config": {
        "allow_untemplated_requests": false,
        "templates": [
          {
            "name": "developer-chat",
            "template": "{\n    \"messages\": [\n    {\n        \"role\": \"system\",\n        \"content\": \"You are a {{program}} expert, in {{language}} programming language.\"\n    },\n    {\n        \"role\": \"user\",\n        \"content\": \"Write me a {{program}} program.\"\n    }\n  ]\n}"
          }
        ]
      }
    }
    '

Make sure to replace the following placeholders with your own values:

consumerName|Id: The id or name of the consumer the plugin configuration will target.

Make the following request:

curl -X POST https://{region}.api.konghq.com/v2/control-planes/{controlPlaneId}/core-entities/consumers/{consumerId}/plugins/ \
    --header "accept: application/json" \
    --header "Content-Type: application/json" \
    --header "Authorization: Bearer $KONNECT_TOKEN" \
    --data '
    {
      "name": "ai-prompt-template",
      "config": {
        "allow_untemplated_requests": false,
        "templates": [
          {
            "name": "developer-chat",
            "template": "{\n    \"messages\": [\n    {\n        \"role\": \"system\",\n        \"content\": \"You are a {{program}} expert, in {{language}} programming language.\"\n    },\n    {\n        \"role\": \"user\",\n        \"content\": \"Write me a {{program}} program.\"\n    }\n  ]\n}"
          }
        ]
      }
    }
    '

Make sure to replace the following placeholders with your own values:

region: Geographic region where your Kong Konnect is hosted and operates.
controlPlaneId: The id of the control plane.
KONNECT_TOKEN: Your Personal Access Token (PAT) associated with your Konnect account.
consumerId: The id of the consumer the plugin configuration will target.

See the Konnect API reference to learn about region-specific URLs and personal access tokens.

echo "
apiVersion: configuration.konghq.com/v1
kind: KongPlugin
metadata:
  name: ai-prompt-template
  namespace: kong
  annotations:
    kubernetes.io/ingress.class: kong
config:
  allow_untemplated_requests: false
  templates:
  - name: developer-chat
    template: |-
      {
          'messages': [
          {
              'role': 'system',
              'content': 'You are a {{program}} expert, in {{language}} programming language.'
          },
          {
              'role': 'user',
              'content': 'Write me a {{program}} program.'
          }
        ]
      }
plugin: ai-prompt-template
" | kubectl apply -f -

Next, apply the KongPlugin resource by annotating the KongConsumer resource:

kubectl annotate -n kong  CONSUMER_NAME konghq.com/plugins=ai-prompt-template

Prerequisite: Configure your Personal Access Token

terraform {
  required_providers {
    konnect = {
      source  = "kong/konnect"
    }
  }
}

provider "konnect" {
  personal_access_token = "$KONNECT_TOKEN"
  server_url            = "https://us.api.konghq.com/"
}

Add the following to your Terraform configuration to create a Konnect Gateway Plugin:

resource "konnect_gateway_plugin_ai_prompt_template" "my_ai_prompt_template" {
  enabled = true

  config = {
    allow_untemplated_requests = false
    templates = [
      {
        name = "developer-chat"
        template = <<EOF
{
    "messages": [
    {
        "role": "system",
        "content": "You are a {{program}} expert, in {{language}} programming language."
    },
    {
        "role": "user",
        "content": "Write me a {{program}} program."
    }
  ]
}
EOF
      }    ]
  }

  control_plane_id = konnect_gateway_control_plane.my_konnect_cp.id
  consumer = {
    id = konnect_gateway_consumer.my_consumer.id
  }
}

Add this section to your declarative configuration file:

_format_version: "3.0"
plugins:
  - name: ai-prompt-template
    consumer_group: consumerGroupName|Id
    config:
      allow_untemplated_requests: false
      templates:
      - name: developer-chat
        template: |-
          {
              "messages": [
              {
                  "role": "system",
                  "content": "You are a {{program}} expert, in {{language}} programming language."
              },
              {
                  "role": "user",
                  "content": "Write me a {{program}} program."
              }
            ]
          }

Make sure to replace the following placeholders with your own values:

consumerGroupName|Id: The id or name of the consumer group the plugin configuration will target.

Make the following request:

curl -i -X POST http://localhost:8001/consumer_groups/{consumerGroupName|Id}/plugins/ \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --data '
    {
      "name": "ai-prompt-template",
      "config": {
        "allow_untemplated_requests": false,
        "templates": [
          {
            "name": "developer-chat",
            "template": "{\n    \"messages\": [\n    {\n        \"role\": \"system\",\n        \"content\": \"You are a {{program}} expert, in {{language}} programming language.\"\n    },\n    {\n        \"role\": \"user\",\n        \"content\": \"Write me a {{program}} program.\"\n    }\n  ]\n}"
          }
        ]
      }
    }
    '

Make sure to replace the following placeholders with your own values:

consumerGroupName|Id: The id or name of the consumer group the plugin configuration will target.

Make the following request:

curl -X POST https://{region}.api.konghq.com/v2/control-planes/{controlPlaneId}/core-entities/consumer_groups/{consumerGroupId}/plugins/ \
    --header "accept: application/json" \
    --header "Content-Type: application/json" \
    --header "Authorization: Bearer $KONNECT_TOKEN" \
    --data '
    {
      "name": "ai-prompt-template",
      "config": {
        "allow_untemplated_requests": false,
        "templates": [
          {
            "name": "developer-chat",
            "template": "{\n    \"messages\": [\n    {\n        \"role\": \"system\",\n        \"content\": \"You are a {{program}} expert, in {{language}} programming language.\"\n    },\n    {\n        \"role\": \"user\",\n        \"content\": \"Write me a {{program}} program.\"\n    }\n  ]\n}"
          }
        ]
      }
    }
    '

Make sure to replace the following placeholders with your own values:

region: Geographic region where your Kong Konnect is hosted and operates.
controlPlaneId: The id of the control plane.
KONNECT_TOKEN: Your Personal Access Token (PAT) associated with your Konnect account.
consumerGroupId: The id of the consumer group the plugin configuration will target.

See the Konnect API reference to learn about region-specific URLs and personal access tokens.

echo "
apiVersion: configuration.konghq.com/v1
kind: KongPlugin
metadata:
  name: ai-prompt-template
  namespace: kong
  annotations:
    kubernetes.io/ingress.class: kong
config:
  allow_untemplated_requests: false
  templates:
  - name: developer-chat
    template: |-
      {
          'messages': [
          {
              'role': 'system',
              'content': 'You are a {{program}} expert, in {{language}} programming language.'
          },
          {
              'role': 'user',
              'content': 'Write me a {{program}} program.'
          }
        ]
      }
plugin: ai-prompt-template
" | kubectl apply -f -

Next, apply the KongPlugin resource by annotating the KongConsumerGroup resource:

kubectl annotate -n kong  CONSUMERGROUP_NAME konghq.com/plugins=ai-prompt-template

Prerequisite: Configure your Personal Access Token

terraform {
  required_providers {
    konnect = {
      source  = "kong/konnect"
    }
  }
}

provider "konnect" {
  personal_access_token = "$KONNECT_TOKEN"
  server_url            = "https://us.api.konghq.com/"
}

Add the following to your Terraform configuration to create a Konnect Gateway Plugin:

resource "konnect_gateway_plugin_ai_prompt_template" "my_ai_prompt_template" {
  enabled = true

  config = {
    allow_untemplated_requests = false
    templates = [
      {
        name = "developer-chat"
        template = <<EOF
{
    "messages": [
    {
        "role": "system",
        "content": "You are a {{program}} expert, in {{language}} programming language."
    },
    {
        "role": "user",
        "content": "Write me a {{program}} program."
    }
  ]
}
EOF
      }    ]
  }

  control_plane_id = konnect_gateway_control_plane.my_konnect_cp.id
  consumer_group = {
    id = konnect_gateway_consumer_group.my_consumer_group.id
  }
}

AI Prompt Template

Block untemplated requestsv3.6+

Prerequisites

Set up the plugin

Help us make these docs great!

Still need help