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

# Get Settings

> This endpoint retrieves the settings for a specific agent by their unique identifier.

### Parameters

<ParamField name="id" type="integer" location="path">
  The unique identifier of the agent whose settings are being retrieved.
</ParamField>

### Response Fields

<ResponseField name="id" type="integer">
  The unique identifier of the agent.
</ResponseField>

<ResponseField name="test" type="string">
  A test field for the agent's settings.
</ResponseField>

<ResponseField name="agent_take_over_tag" type="boolean">
  Indicates whether the agent take over tag is enabled.
</ResponseField>

<ResponseField name="skip_emails" type="boolean">
  Indicates whether the agent should skip certain emails.
</ResponseField>

<ResponseField name="skip_tags" type="array">
  An array of tags that the agent should skip.
</ResponseField>

<ResponseField name="model_name" type="string">
  The name of the model used by the agent.
</ResponseField>

<ResponseField name="model_type" type="string">
  The type of model used by the agent.
</ResponseField>

<ResponseField name="model_provider" type="string">
  The provider of the model used by the agent.
</ResponseField>

<ResponseField name="temperature" type="float">
  The temperature setting for the model.
</ResponseField>

<ResponseField name="max_tokens" type="integer">
  The maximum number of tokens allowed in the agent's responses.
</ResponseField>

<ResponseField name="skip_subjects" type="array">
  An array of subjects that the agent should skip.
</ResponseField>

<ResponseField name="out_of_office_keywords" type="array">
  Keywords indicating out-of-office status that the agent should recognize.
</ResponseField>

<ResponseField name="skip_channels" type="array">
  An array of channels that the agent should skip.
</ResponseField>

<ResponseField name="skip_instagram_messages" type="boolean">
  Indicates whether the agent should skip Instagram messages.
</ResponseField>

<ResponseField name="agent_emails" type="array">
  An array of emails associated with the agent.
</ResponseField>

<ResponseField name="time_threshold" type="integer">
  The time threshold for the agent's operations, in minutes.
</ResponseField>

<ResponseField name="assignee_user_id" type="integer">
  The user ID of the person assigned to the agent.
</ResponseField>

<ResponseField name="allowed_intents" type="array">
  An array of intents that the agent is allowed to process.
</ResponseField>

<ResponseField name="health_concern_keywords" type="array">
  Keywords related to health concerns that the agent should recognize.
</ResponseField>

<ResponseField name="agent_takeover_phrases" type="array">
  Phrases that trigger the agent to take over a conversation.
</ResponseField>

<ResponseField name="escalation_team_id" type="integer">
  The team ID for escalations.
</ResponseField>

<ResponseField name="escalation_tag_name" type="string">
  The name of the tag used for escalations.
</ResponseField>

<ResponseField name="stateset_response_gorgias_email" type="string">
  The email used by the StateSet response system integrated with Gorgias.
</ResponseField>

<ResponseField name="stateset_response_gorgias_user_id" type="string">
  The user ID in the StateSet response system integrated with Gorgias.
</ResponseField>

<ResponseField name="stateset_response_name" type="string">
  The name of the response used by StateSet.
</ResponseField>

<ResponseField name="name_from" type="string">
  The name that appears in the "From" field of the agent's communications.
</ResponseField>

<ResponseField name="address_from" type="string">
  The address that appears in the "From" field of the agent's communications.
</ResponseField>

<ResponseField name="analytics_platform" type="string">
  The analytics platform used by the agent.
</ResponseField>

<ResponseField name="average_response_time" type="integer">
  The agent's average response time, in seconds.
</ResponseField>

<ResponseField name="backup_frequency" type="string">
  The frequency of backups for the agent's data.
</ResponseField>

<ResponseField name="backup_retention_period" type="string">
  The retention period for the agent's backups.
</ResponseField>

<ResponseField name="ccpa_compliant" type="boolean">
  Indicates whether the agent is compliant with CCPA regulations.
</ResponseField>

<ResponseField name="created_at" type="string">
  The timestamp when the agent was created.
</ResponseField>

<ResponseField name="crm_system" type="string">
  The CRM system used by the agent.
</ResponseField>

<ResponseField name="customer_satisfaction_score" type="float">
  The agent's customer satisfaction score.
</ResponseField>

<ResponseField name="customer_satisfaction_target" type="float">
  The target customer satisfaction score for the agent.
</ResponseField>

<ResponseField name="encryption_level" type="string">
  The level of encryption used by the agent.
</ResponseField>

<ResponseField name="data_retention_period" type="string">
  The data retention period for the agent's data.
</ResponseField>

<ResponseField name="fallback_agent_id" type="integer">
  The ID of the fallback agent in case of issues.
</ResponseField>

<ResponseField name="gdpr_compliant" type="boolean">
  Indicates whether the agent is GDPR compliant.
</ResponseField>

<ResponseField name="first_contact_resolution_rate" type="float">
  The rate at which the agent resolves issues on first contact.
</ResponseField>

<ResponseField name="handle_time" type="integer">
  The average handle time for the agent's tasks, in seconds.
</ResponseField>

<ResponseField name="intent_skip_email" type="boolean">
  Indicates whether the agent should skip emails based on intent.
</ResponseField>

<ResponseField name="ip_whitelist" type="array">
  A list of IP addresses that are whitelisted for the agent.
</ResponseField>

<ResponseField name="language_preferences" type="array">
  The language preferences set for the agent.
</ResponseField>

<ResponseField name="max_conversation_duration" type="integer">
  The maximum duration of a conversation handled by the agent, in minutes.
</ResponseField>

<ResponseField name="org_id" type="integer">
  The organization ID associated with the agent.
</ResponseField>

<ResponseField name="pci_dss_compliant" type="boolean">
  Indicates whether the agent is PCI DSS compliant.
</ResponseField>

<ResponseField name="profanity_filter" type="boolean">
  Indicates whether the agent has a profanity filter enabled.
</ResponseField>

<ResponseField name="resolution_rate" type="float">
  The resolution rate for the agent's tasks.
</ResponseField>

<ResponseField name="resolution_rate_target" type="float">
  The target resolution rate for the agent's tasks.
</ResponseField>

<ResponseField name="response_time_threshold" type="integer">
  The threshold for the agent's response time, in seconds.
</ResponseField>

<ResponseField name="sentiment_analysis_threshold" type="float">
  The threshold for the agent's sentiment analysis.
</ResponseField>

<ResponseField name="ticketing_system" type="string">
  The ticketing system used by the agent.
</ResponseField>

<ResponseField name="training_data_sources" type="array">
  The data sources used for training the agent.
</ResponseField>

<ResponseField name="training_frequency" type="string">
  The frequency of the agent's training sessions.
</ResponseField>

<ResponseField name="training_last_updated" type="string">
  The last date the agent's training was updated.
</ResponseField>

<ResponseField name="two_factor_auth_required" type="boolean">
  Indicates whether two-factor authentication is required for the agent.
</ResponseField>

<ResponseField name="updated_at" type="string">
  The timestamp when the agent's settings were last updated.
</ResponseField>

<RequestExample>
  ```bash cURL theme={null}
  curl --location --request GET 'https://api.stateset.com/v1/agent_settings/123' \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Token <token>'
  ```
</RequestExample>

<ResponseExample>
  ```json theme={null}
  {
    "id": 123,
    "test": "Test field value",
    "agent_take_over_tag": true,
    "skip_emails": false,
    "skip_tags": ["spam", "promotions"],
    "model_name": "StateSet AI Model",
    "model_type": "NLP",
    "model_provider": "StateSet AI",
    "temperature": 0.7,
    "max_tokens": 2048,
    "skip_subjects": ["marketing", "ads"],
    "out_of_office_keywords": ["out of office", "vacation"],
    "skip_channels": ["Facebook", "Twitter"],
    "skip_instagram_messages": true,
    "agent_emails": ["agent@example.com"],
    "time_threshold": 30,
    "assignee_user_id": 456,
    "allowed_intents": ["order_status", "cancellation"],
    "health_concern_keywords": ["allergy", "side effect"],
    "agent_takeover_phrases": ["Let me take over", "I got this"],
    "escalation_team_id": 789,
    "escalation_tag_name": "urgent",
    "stateset_response_gorgias_email": "gorgias@example.com",
    "stateset_response_gorgias_user_id": "gorgias_user_123",
  }

  ```
</ResponseExample>