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.

string

A test field for the agent’s settings.

boolean

Indicates whether the agent take over tag is enabled.

boolean

Indicates whether the agent should skip certain emails.

array

An array of tags that the agent should skip.

string

The name of the model used by the agent.

string

The type of model used by the agent.

string

The provider of the model used by the agent.

float

The temperature setting for the model.

integer

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

array

An array of subjects that the agent should skip.

array

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

array

An array of channels that the agent should skip.

boolean

Indicates whether the agent should skip Instagram messages.

array

An array of emails associated with the agent.

integer

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

integer

The user ID of the person assigned to the agent.

array

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

array

Keywords related to health concerns that the agent should recognize.

array

Phrases that trigger the agent to take over a conversation.

integer

The team ID for escalations.

string

The name of the tag used for escalations.

string

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

string

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

string

The name of the response used by StateSet.

string

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

string

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

string

The analytics platform used by the agent.

integer

The agent’s average response time, in seconds.

string

The frequency of backups for the agent’s data.

string

The retention period for the agent’s backups.

boolean

Indicates whether the agent is compliant with CCPA regulations.

string

The timestamp when the agent was created.

string

The CRM system used by the agent.

float

The agent’s customer satisfaction score.

float

The target customer satisfaction score for the agent.

string

The level of encryption used by the agent.

string

The data retention period for the agent’s data.

integer

The ID of the fallback agent in case of issues.

Indicates whether the agent is GDPR compliant.

float

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

integer

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

boolean

Indicates whether the agent should skip emails based on intent.

array

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

array

The language preferences set for the agent.

integer

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

integer

The organization ID associated with the agent.

boolean

Indicates whether the agent is PCI DSS compliant.

boolean

Indicates whether the agent has a profanity filter enabled.

float

The resolution rate for the agent’s tasks.

float

The target resolution rate for the agent’s tasks.

integer

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

float

The threshold for the agent’s sentiment analysis.

string

The ticketing system used by the agent.

array

The data sources used for training the agent.

string

The frequency of the agent’s training sessions.

string

The last date the agent’s training was updated.

boolean

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

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

StateSet One API

StateSet API v1

Customer Management

Order Management

Checkouts

Returns Management

Warranty Management

Wholesale Management

Inventory Management

ASN Management

Purchase Orders

Manufacturing

Warehouse Operations

CRM

Suppliers

E-commerce

Financial

Fulfillment

Communication

System

StateSet Response API

StateSet Cloud API

StateSet Commerce API

List Settings

Parameters

Response Fields

​Parameters

​Response Fields

Parameters

Response Fields