Skip to content
POST/api/v1/gateway/semantic-cache

Configure semantic-cache settings

Accepts a semantic-cache configuration payload and echoes it back — it does NOT persist anything. camelCase body, all optional: `enabled` (boolean), `threshold` (0-1), `maxEntries` (1-10,000,000), `ttlSec` (1-2,592,000). The response is the submitted values merged over hardcoded literals (`enabled: true`, `similarityThreshold: 0.92`, `maxEntries: 10000`, `ttlSec: 3600`) plus `updatedAt`; the running cache is unaffected and its live settings continue to come from the `EVALGUARD_GATEWAY_CACHE_*` environment variables (whose ttl default is 600, not 3600). Returns the merged config, not SuccessResponse-wrapped stats.

Authentication

Send Authorization: Bearer YOUR_API_KEY on every request. Generate API keys at /dashboard/settings/api-keys.

Request body required

Example

{
  "enabled": false,
  "threshold": 0,
  "maxEntries": 1,
  "ttlSec": 1
}
Schema
{
  "application/json": {
    "schema": {
      "type": "object",
      "properties": {
        "enabled": {
          "type": "boolean"
        },
        "threshold": {
          "type": "number",
          "minimum": 0,
          "maximum": 1,
          "description": "Similarity threshold (echoed as similarityThreshold)."
        },
        "maxEntries": {
          "type": "integer",
          "minimum": 1,
          "maximum": 10000000
        },
        "ttlSec": {
          "type": "integer",
          "minimum": 1,
          "maximum": 2592000
        }
      },
      "additionalProperties": false
    }
  }
}

Response

200 example

{
  "success": true
}

All status codes

200Merged cache config.
400(no description)
401(no description)
403Forbidden — the credential is valid but lacks the API-key scope, member role, or plan entitlement this operation requires.
429(no description)
500Internal Server Error — an unhandled error was converted to the standard error envelope (INTERNAL_ERROR).

Code samples

cURL

curl -X POST \
  https://evalguard.ai/api/v1/gateway/semantic-cache \
  -H "Authorization: Bearer $EVALGUARD_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "enabled": false, "threshold": 0, "maxEntries": 1, "ttlSec": 1 }'

TypeScript

// The TypeScript SDK (@evalguard/sdk) exposes TYPED methods — runEval,
// getEval, runSecurityScan, checkFirewall, … — not a generic request().
// For an arbitrary endpoint, call it directly:

const res = await fetch("https://evalguard.ai/api/v1/gateway/semantic-cache", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.EVALGUARD_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "enabled": false,
    "threshold": 0,
    "maxEntries": 1,
    "ttlSec": 1
  }),
});
console.log(res.status, await res.json());

Python

# The Python SDK (pip install evalguardai) exposes TYPED methods on
# EvalGuardClient — run_eval, get_eval, … — not a generic request().
# For an arbitrary endpoint, call it directly:

import os
import requests

headers = {"Authorization": f"Bearer {os.environ['EVALGUARD_API_KEY']}"}
headers["Content-Type"] = "application/json"

response = requests.request(
    "POST",
    "https://evalguard.ai/api/v1/gateway/semantic-cache",
    headers=headers,
    json={
    "enabled": False,
    "threshold": 0,
    "maxEntries": 1,
    "ttlSec": 1
},
)
print(response.status_code, response.json())

Go

package main

import (
	"context"
	"fmt"
	"net/http"
	"os"
	"strings"
)

func main() {
	body := strings.NewReader(`{"enabled":false,"threshold":0,"maxEntries":1,"ttlSec":1}`)
	req, _ := http.NewRequestWithContext(context.Background(), "POST", "https://evalguard.ai/api/v1/gateway/semantic-cache", body)
	req.Header.Set("Authorization", "Bearer "+os.Getenv("EVALGUARD_API_KEY"))
	req.Header.Set("Content-Type", "application/json")
	resp, err := http.DefaultClient.Do(req)
	if err != nil { panic(err) }
	defer resp.Body.Close()
	fmt.Println(resp.Status)
}

Errors

400401403429500

Other Gateway endpoints