StateSet API Docs

curl --location --request GET 'https://api.stateset.com/v1/agent_settings/123' \
--header 'Content-Type: application/json' \
--header 'Authorization: Token <token>'

{
  "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",
}

GET

settings

curl --location --request GET 'https://api.stateset.com/v1/agent_settings/123' \
--header 'Content-Type: application/json' \
--header 'Authorization: Token <token>'

{
  "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",
}

Parameters

Response Fields

integer

The unique identifier of the agent.

test

string

A test field for the agent’s settings.

agent_take_over_tag

boolean

Indicates whether the agent take over tag is enabled.

skip_emails

boolean

Indicates whether the agent should skip certain emails.

skip_tags

array

An array of tags that the agent should skip.

model_name

string

The name of the model used by the agent.

model_type

string

The type of model used by the agent.

model_provider

string

The provider of the model used by the agent.

temperature

float

The temperature setting for the model.

max_tokens

integer

The maximum number of tokens allowed in the agent’s responses.

skip_subjects

array

An array of subjects that the agent should skip.

out_of_office_keywords

array

Keywords indicating out-of-office status that the agent should recognize.

skip_channels

array

An array of channels that the agent should skip.

skip_instagram_messages

boolean

Indicates whether the agent should skip Instagram messages.

agent_emails

array

An array of emails associated with the agent.

time_threshold

integer

The time threshold for the agent’s operations, in minutes.

assignee_user_id

integer

The user ID of the person assigned to the agent.

allowed_intents

array

An array of intents that the agent is allowed to process.

health_concern_keywords

array

Keywords related to health concerns that the agent should recognize.

agent_takeover_phrases

array

Phrases that trigger the agent to take over a conversation.

escalation_team_id

integer

The team ID for escalations.

escalation_tag_name

string

The name of the tag used for escalations.

stateset_response_gorgias_email

string

The email used by the StateSet response system integrated with Gorgias.

stateset_response_gorgias_user_id

string

The user ID in the StateSet response system integrated with Gorgias.

stateset_response_name

string

The name of the response used by StateSet.

name_from

string

The name that appears in the “From” field of the agent’s communications.

address_from

string

The address that appears in the “From” field of the agent’s communications.

analytics_platform

string

The analytics platform used by the agent.

average_response_time

integer

The agent’s average response time, in seconds.

backup_frequency

string

The frequency of backups for the agent’s data.

backup_retention_period

string

The retention period for the agent’s backups.

ccpa_compliant

boolean

Indicates whether the agent is compliant with CCPA regulations.

created_at

string

The timestamp when the agent was created.

crm_system

string

The CRM system used by the agent.

customer_satisfaction_score

float

The agent’s customer satisfaction score.

customer_satisfaction_target

float

The target customer satisfaction score for the agent.

encryption_level

string

The level of encryption used by the agent.

data_retention_period

string

The data retention period for the agent’s data.

fallback_agent_id

integer

The ID of the fallback agent in case of issues.

Indicates whether the agent is GDPR compliant.

first_contact_resolution_rate

float

The rate at which the agent resolves issues on first contact.

handle_time

integer

The average handle time for the agent’s tasks, in seconds.

intent_skip_email

boolean

Indicates whether the agent should skip emails based on intent.

ip_whitelist

array

A list of IP addresses that are whitelisted for the agent.

language_preferences

array

The language preferences set for the agent.

max_conversation_duration

integer

The maximum duration of a conversation handled by the agent, in minutes.

org_id

integer

The organization ID associated with the agent.

pci_dss_compliant

boolean

Indicates whether the agent is PCI DSS compliant.

profanity_filter

boolean

Indicates whether the agent has a profanity filter enabled.

resolution_rate

float

The resolution rate for the agent’s tasks.

resolution_rate_target

float

The target resolution rate for the agent’s tasks.

response_time_threshold

integer

The threshold for the agent’s response time, in seconds.

sentiment_analysis_threshold

float

The threshold for the agent’s sentiment analysis.

ticketing_system

string

The ticketing system used by the agent.

training_data_sources

array

The data sources used for training the agent.

training_frequency

string

The frequency of the agent’s training sessions.

training_last_updated

string

The last date the agent’s training was updated.

two_factor_auth_required

boolean

Indicates whether two-factor authentication is required for the agent.

updated_at

string

The timestamp when the agent’s settings were last updated.

curl --location --request GET 'https://api.stateset.com/v1/agent_settings/123' \
--header 'Content-Type: application/json' \
--header 'Authorization: Token <token>'

{
  "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",
}

Delete User Get Settings

​Parameters

​Response Fields

Parameters

Response Fields