@scenaro/sdk/protocol.
ConfigPayload
Sent on theconfig topic at session start.
| Field | Type | Description |
|---|---|---|
features | FeatureDefinition[] | Features and their tools |
collections | unknown[] | Collection metadata for features |
company_id | string | number | Tenant identifier |
restore_state | RestoreState | Checkpoint for state restoration |
voice_stack | string | Active voice provider stack |
audio_dictation | boolean | Dictation mode enabled |
conversation_id | string | Active conversation ID |
avatar_enabled | boolean | Avatar output enabled |
FeatureDefinition
ToolConfig
ConfigAckPayload
ConversationMessage
Sent onmessage:new.
| Field | Type | Description |
|---|---|---|
id | string | Message ID |
role | 'user' | 'assistant' | 'tool' | 'event' | Speaker role |
content | string | Message text |
timestamp | string | ISO timestamp |
tool_calls | unknown[] | Tool invocations (assistant) |
tool_call_id | string | Tool result reference |
interrupted | boolean | Speech was interrupted |
experience_state | Record<string, unknown> | UI state snapshot |
SessionEndPayload
API types (client)
Used byScenaroClient for HTTP calls: