v3
latestOpenAPI 3.0.02026-08-081996601.2 MBList sessions routed via this alias
Lists sessions originally created via this alias (sessions whose alias_key matches). Sessions are also reachable under their resolved agent's URL. This endpoint is the alias-scoped view.
Path parameters
The unique key that identifies an alias. Alias keys are independent of agent keys. The same string can exist as both an alias key and an agent key in the same customer account. Calls to /v2/agent_aliases/{key}/... target the alias. Calls to /v2/agents/{key}/... target the agent.
Query parameters
The opaque cursor returned in metadata.page_key of the previous response. Omit it to fetch the first page.
Headers
The platform makes a best effort to complete the request in the specified seconds, or it times out.
The platform makes a best effort to complete the request in the specified milliseconds, or it times out.
Response
Sessions created via this alias.
Example response
{
"sessions": [
{
"key": "customer_support_chat",
"agent_key": "customer_support",
"name": "Customer Support Session",
"description": "Helping customer troubleshoot widget installation issues",
"metadata": {
"customer_id": "12345",
"priority": "high",
"channel": "web_chat"
},
"current_step_name": "billing",
"enabled": true,
"status": "stopped",
"created_by_agent_key": "customer_support",
"created_by_session_key": "customer_support_chat",
"tti_minutes": 60,
"created_at": "2024-01-15T10:30:00Z",
"session_context_usage": {
"input_tokens": {
"count": 120,
"cached_tokens": 100
},
"output_tokens": {
"count": 30
},
"total_tokens": 150,
"model_context_window": 200000
},
"effective_compaction": {
"enabled": true,
"threshold_percent": 80,
"keep_recent_inputs": 1
},
"alias_key": "support",
"secrets": {
"slack_user_token": "****"
}
}
],
"metadata": {
"page_key": "eyJvZmZzZXQiOjF9"
}
}