> ## Documentation Index
> Fetch the complete documentation index at: https://docs.stateset.com/llms.txt
> Use this file to discover all available pages before exploring further.

# 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.

### Path parameters

<ParamField path="id" type="string (uuid)" required>
  The agent id.
</ParamField>

### Response

`object`

<ResponseField name="object" type="string" required />

<ResponseField name="configured" type="boolean" required>
  False when no settings row exists yet for this agent (every other field is then null).
</ResponseField>

<ResponseField name="model_name" type="string,null" required />

<ResponseField name="model_provider" type="string,null" required />

<ResponseField name="model_type" type="string,null" required />

<ResponseField name="temperature" type="number,null" required />

<ResponseField name="max_tokens" type="integer,null" required />

<ResponseField name="top_p" type="number,null" required />

<ResponseField name="escalation_tag_name" type="string,null" required />

<ResponseField name="escalation_team_id" type="string,null" required />

<ResponseField name="agent_take_over_tag" type="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 |

<RequestExample>
  ```bash cURL theme={null}
  curl --request GET \
    --url 'https://response.stateset.com/api/v1/agents/{id}/settings' \
    --header "Authorization: Bearer $RESPONSECX_API_KEY"
  ```
</RequestExample>

<ResponseExample>
  ```json 200 theme={null}
  {
    "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"
  }
  ```
</ResponseExample>
