Skip to main content

Agent Settings

Each agent has a set of per-agent settings that control its runtime behavior. These settings are independent of the agent's configuration (model, prompt, tools) and can be updated at any time without redeploying or recreating the agent.

Available Settings

SettingTypeDefaultDescription
arizeTracingEnabledbooleantrueWhen enabled, LLM calls made by this agent are traced and sent to Arize for observability. Disable to stop sending traces for a specific agent (e.g., during development or for cost control).
evaluationEnabledbooleanfalseWhen enabled, agent responses are tagged for evaluation in Arize.

Get Current Settings

GET /v1/agents/{agent_id}/settings

Headers:

HeaderRequiredDescription
AuthorizationYesBearer token

Example response:

{
"agentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"settings": {
"arizeTracingEnabled": true,
"evaluationEnabled": false
}
}

Update Settings

PATCH /v1/agents/{agent_id}/settings

The PATCH endpoint uses partial-patch semantics: only the fields you include in the request body are updated. Any field you omit is left unchanged. You can therefore enable or disable a single setting without knowing or repeating the current value of the other.

Headers:

HeaderRequiredDescription
AuthorizationYesBearer token
Content-TypeYesapplication/json

Examples

Disable Arize tracing for an agent (leaves evaluationEnabled unchanged):

{
"arizeTracingEnabled": false
}

Enable evaluation (leaves arizeTracingEnabled unchanged):

{
"evaluationEnabled": true
}

Update both settings in one call:

{
"arizeTracingEnabled": false,
"evaluationEnabled": true
}

Example response (returns the full settings object after the update):

{
"agentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"settings": {
"arizeTracingEnabled": false,
"evaluationEnabled": true
}
}

Notes

  • Settings are scoped to a single agent. Changing settings on one agent does not affect any other agent.
  • Both fields accept true or false. null values are ignored (treated as “no change”), but at least one field must be provided with a non-null value.
  • If arizeTracingEnabled is false the agent will still run normally — traces are simply not forwarded to Arize.