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

Setting	Type	Default	Description
arizeTracingEnabled	boolean	true	When 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).
evaluationEnabled	boolean	false	When enabled, agent responses are tagged for evaluation in Arize.
solutionKey	string | null	null	Optional solution context identifier. Links the agent to a specific solution for grouping, analytics, or solution-specific behavior. Must be 3-64 characters, lowercase letters, digits, and hyphens only, starting with a letter. Set to null to clear.

Get Current Settings

GET /v1/agents/{agent_id}/settings

Headers:

Header	Required	Description
Authorization	Yes	Bearer token

Example response:

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

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:

Header	Required	Description
Authorization	Yes	Bearer token
Content-Type	Yes	application/json

Examples

Disable Arize tracing for an agent (leaves other settings unchanged):

{
  "arizeTracingEnabled": false
}

Enable evaluation (leaves other settings unchanged):

{
  "evaluationEnabled": true
}

Link agent to a solution (leaves other settings unchanged):

{
  "solutionKey": "billing-solution"
}

Clear solution link (leaves other settings unchanged):

{
  "solutionKey": null
}

Update multiple settings in one call:

{
  "arizeTracingEnabled": false,
  "evaluationEnabled": true,
  "solutionKey": "claims-processing-suite"
}

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

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

Notes

• Settings are scoped to a single agent. Changing settings on one agent does not affect any other agent.
• At least one field must be provided in the PATCH request. Empty request bodies are rejected.
• Boolean fields (arizeTracingEnabled, evaluationEnabled): Must be true or false. Omitting a field leaves it unchanged.
• String field (solutionKey):
  • Set to a valid string to link the agent to a solution
  • Set to null to clear/delink the solution
  • Empty strings ("") are rejected with a validation error
  • Must be 3-64 characters: lowercase letters, digits, and hyphens only
  • Must start with a lowercase letter and end with a letter or digit
  • Valid examples: billing-solution, claims-processing-suite, app-v2
  • Invalid examples: My-Solution (uppercase), my_solution (underscore), ab (too short)
• If arizeTracingEnabled is false the agent will still run normally — traces are simply not forwarded to Arize.