Skip to main content
PUT
/
applications
/
{applicationId}
/
monitoring
Configure monitoring
curl --request PUT \
  --url https://app.trusys.ai/api/external/applications/{applicationId}/monitoring \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "metrics": [
    {
      "type": "answer-relevance",
      "threshold": 0.7
    }
  ],
  "plugins": {
    "harmful": [
      "harmful:hate"
    ]
  },
  "securityPurpose": "Customer support chatbot handling account queries",
  "securityConfig": {
    "purpose": "Customer support chatbot handling account queries",
    "hasAccessTo": "Help center knowledge base, customer profile metadata (non-sensitive)",
    "userTypes": "Retail customers, customer support agents"
  }
}
'
{
  "success": true,
  "data": {
    "metrics": [
      {}
    ],
    "plugins": {},
    "securityPurpose": "<string>",
    "securityConfig": {
      "purpose": "<string>",
      "hasAccessTo": "<string>",
      "doesNotHaveAccessTo": "<string>",
      "userTypes": "<string>",
      "securityRequirements": "<string>",
      "sensitiveDataTypes": "<string>",
      "exampleIdentifiers": "<string>",
      "criticalActions": "<string>",
      "forbiddenTopics": "<string>",
      "competitors": "<string>",
      "redteamUser": "<string>"
    },
    "logLocation": "<string>"
  }
}

Authorizations

​
x-api-key
string
header
required

Your Trusys API key. Create and manage keys in the Trusys UI under Settings → API Keys.

Include the key on every request:

x-api-key: <your-api-key>

Path Parameters

​
applicationId
string<uuid>
required

Unique identifier (UUID) of the application. Returned by POST /applications.

Body

application/json

Monitoring settings. Metric type values come from GET /metrics/eval; plugin IDs from GET /metrics/security.

Monitoring configuration update. At least one field is required.

​
metrics
object[]

Quality evaluation metrics to run. Each item is a metric object; include type from the eval catalog and any metric-specific options (for example threshold).

​
plugins
object

Security plugins grouped by risk category. Values are arrays of plugin IDs (for example harmful:hate).

​
securityPurpose
string

Shorthand for securityConfig.purpose. Prefer securityConfig when setting multiple security context fields. If both are provided, securityPurpose sets purpose after securityConfig is applied.

​
securityConfig
object

Application security context used to tailor adversarial security testing. All fields are optional on update; omitted keys are left unchanged. Provide purpose (or top-level securityPurpose) to describe what the AI application does.

Response

Monitoring configuration saved.

​
success
boolean
​
data
object

Monitoring evaluation metrics, security plugins, and application security context.