Read an agent's model and behaviour settings

The agent’s whitelisted model/behaviour settings. An agent with no settings row yet returns configured: false with every field null rather than a 404.

GET /api/v1/agents/{id}/settings

cURL

curl --request GET \
  --url 'https://response.stateset.com/api/v1/agents/{id}/settings' \
  --header "Authorization: Bearer $RESPONSECX_API_KEY"

200

{
  "object": "agent.settings",
  "configured": true,
  "model_name": "string",
  "model_provider": "string",
  "model_type": "string",
  "temperature": 1.5,
  "max_tokens": 1,
  "top_p": 1.5,
  "escalation_tag_name": "string",
  "escalation_team_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "agent_take_over_tag": "string"
}

Path parameters

id · string (uuid) · required

The agent id.

Response

object

object · string · required

configured · boolean · required

False when no settings row exists yet for this agent (every other field is then null).

model_name · string,null · required

model_provider · string,null · required

model_type · string,null · required

temperature · number,null · required

max_tokens · integer,null · required

top_p · number,null · required

escalation_tag_name · string,null · required

escalation_team_id · string,null · required

agent_take_over_tag · string,null · required

Status codes

Code	Meaning
200	The agent’s whitelisted model/behaviour settings. An agent with no settings row yet returns configured: false with every field null rather than a 404.
401	Missing, invalid, or expired API key.
403	The key lacks a required scope.
404	Not found, or not in the organization that owns the key.
429	Rate limit exceeded.

Access

Required scope	agents:read
Rate limit	120 requests per minute

cURL

curl --request GET \
  --url 'https://response.stateset.com/api/v1/agents/{id}/settings' \
  --header "Authorization: Bearer $RESPONSECX_API_KEY"

200

{
  "object": "agent.settings",
  "configured": true,
  "model_name": "string",
  "model_provider": "string",
  "model_type": "string",
  "temperature": 1.5,
  "max_tokens": 1,
  "top_p": 1.5,
  "escalation_tag_name": "string",
  "escalation_team_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "agent_take_over_tag": "string"
}