Skip to main content
PUT
/
v2
/
auto-monitor-setups
/
by-external-id
/
{external_id}
Upsert an Auto Monitor Setup by External ID
curl --request PUT \
  --url https://app.traceloop.com/api/v2/auto-monitor-setups/by-external-id/{external_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "selector": [
    {}
  ],
  "evaluators": [
    "<string>"
  ],
  "evaluator_configs": [
    {}
  ]
}
'

Documentation Index

Fetch the complete documentation index at: https://enrolla-gz-add-pr-758-to-docs.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

Idempotent full-replace of an auto monitor setup keyed by external_id. If no setup with the given external_id exists for the org/project, one is created and the response is 201 Created. If a setup already exists, all fields in the body fully replace the existing record and the response is 200 OK. The env_project_id is preserved across updates — it is only set on the create branch.
All API requests require authentication. Pass your API key as a Bearer token in the Authorization header. See Authentication for details.

Path Parameters

external_id
string
required
The external ID of the auto monitor setup to create or replace.Example: "my-agent-monitor-1"

Request Body

selector
object[]
required
An array of filter rules used to match spans. Each rule specifies an attribute key, a value to match, and a source indicating where the attribute lives. Only spans matching all provided rules will be evaluated. Must contain at least one filter.Each rule has the following fields:
FieldTypeRequiredDescription
keystringYesThe attribute key to filter on (e.g., gen_ai.system, service.name)
valuestringConditionalThe value to match against. Required for equals, not_equals, contains, not_contains operators
valuesstring[]ConditionalList of values to match against. Required for in, not_in operators
sourcestringYesWhere the attribute lives: span_attributes or resource_attributes
operatorstringNoComparison operator. Defaults to equals. One of: equals, not_equals, contains, not_contains, exists, not_exists, in, not_in
evaluators
string[]
List of evaluator slugs to run on matched spans. One of evaluators or evaluator_configs is required.Example: ["answer-relevancy", "toxicity-detector"]See the full list of available slugs in the Evaluator Slugs reference.
evaluator_configs
object[]
Per-evaluator configuration, used in place of evaluators when you need to pass evaluator-specific options. One of evaluators or evaluator_configs is required.

Example Request

curl -X PUT https://api.traceloop.com/v2/auto-monitor-setups/by-external-id/my-agent-monitor-1 \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "evaluators": ["answer-relevancy", "toxicity-detector"],
    "selector": [
      {"key": "gen_ai.system", "value": "openai", "source": "span_attributes"},
      {"key": "gen_ai.request.model", "value": "gpt-4o", "source": "span_attributes"}
    ]
  }'

Response

200 OK

Returned when an existing setup was replaced. The response body is the updated auto monitor setup.

201 Created

Returned when a new setup was created. The response body is the newly created auto monitor setup. See the Create endpoint for the full response shape.
{
  "id": "cmm...",
  "external_id": "my-agent-monitor-1",
  "org_id": "c108269c-...",
  "project_id": "cm9v2g95l...",
  "env_project_id": "cm9v2ga9i...",
  "init_rules": [
    {
      "key": "gen_ai.system",
      "value": "openai",
      "source": "span_attributes",
      "operator": "equals"
    },
    {
      "key": "gen_ai.request.model",
      "value": "gpt-4o",
      "source": "span_attributes",
      "operator": "equals"
    }
  ],
  "evaluators": [
    {
      "evaluator_type": "answer-relevancy",
      "status": "pending"
    },
    {
      "evaluator_type": "toxicity-detector",
      "status": "pending"
    }
  ],
  "status": "pending",
  "created_at": "2026-01-15T10:30:00Z",
  "updated_at": "2026-01-15T10:30:00Z"
}

400 Bad Request

Returned when the request body is invalid (e.g. empty selector, missing both evaluators and evaluator_configs, or an unknown evaluator slug).
{
  "error": "selector must have at least 1 filter"
}

500 Internal Server Error

{
  "error": "internal server error"
}