Entity types
Workspace
Connection
Consumer
Conversation
Conversation stats
Knowledge
Organisation
API response types
All endpoint responses have dedicated types. Key ones:| Type | Description |
|---|---|
WorkspaceListResponse | { workspaces: WorkspaceListItem[] } |
WorkspaceDetailResponse | Full workspace with connections, tools, knowledge, guardrails, consumers, permissions, stats |
QueryResponse | Answer, tools called, cost, duration, conversation ID |
ConversationListResponse | Conversations with stats, total count, available filters |
ConversationDetailResponse | Conversation, messages (with audit data), stats |
DashboardResponse | Tickets, sentiment, compliance, cost, usage, recent conversations |
HealthResponse | Server status, setup state, counts |
Configuration types
| Type | Description |
|---|---|
WorkspaceConfig | Full runtime config (MCP servers, knowledge, consumers, guardrails, permissions) |
GuardrailsConfig | PII filter, write confirmation, cost cap, rate limit, blocked topics |
ConsumerConfig | Per-consumer-type config (channels, auth, settings) |
Permission | Enum of all permission types |