Skip to main content

SupportTicketRequestCategoryRead

A reusable agent-scoped category describing what the customer wanted to ask, solve, change, confirm, or complain about in a support ticket. Active non-system rows are offered to the classifier as options; inactive rows are retained for reporting history.

idIdrequired

Unique numeric identifier of the record.

agent_idAgent Idrequired

ID of the agent (a configured AI assistant / bot persona) this record belongs to.

keyKeyrequired

Stable normalized identifier derived from the display name.

display_nameDisplay Namerequired

Human-readable category name shown in settings and analytics.

descriptionDescriptionrequired

Guidance for when this category should be used.

examplesstring[]required

Short example customer goals that fit this category.

sourceSupportTicketRequestCategorySourcerequired

Whether the category was created manually, proposed by the LLM, or reserved by the system.

Possible values: [manual, llm, system]

is_activeIs Activerequired

Whether the classifier can currently choose this category.

created_atdate-timerequired

Creation time (UTC, ISO 8601).

updated_atdate-timerequired

Last modification time (UTC, ISO 8601).

SupportTicketRequestCategoryRead
{
"id": 0,
"agent_id": 0,
"key": "string",
"display_name": "string",
"description": "string",
"examples": [
"string"
],
"source": "manual",
"is_active": true,
"created_at": "2024-07-29T15:51:28.071Z",
"updated_at": "2024-07-29T15:51:28.071Z"
}