Client events

1
// Example initialization metadata
2
{
3
  "type": "conversation_initiation_metadata",
4
  "conversation_initiation_metadata_event": {
5
    "conversation_id": "conv_123",
6
    "agent_output_audio_format": "pcm_44100",  // TTS output format
7
    "user_input_audio_format": "pcm_16000"    // ASR input format
8
  }
9
}

1
  // Example ping event structure
2
  {
3
    "ping_event": {
4
      "event_id": 123456,
5
      "ping_ms": 50  // Optional, estimated latency in milliseconds
6
    },
7
    "type": "ping"
8
  }

1
// Example audio event structure
2
{
3
  "audio_event": {
4
    "audio_base_64": "base64_encoded_audio_string",
5
    "event_id": 12345,
6
    "alignment": {  // Character-level timing data
7
      "chars": ["H", "e", "l", "l", "o"],
8
      "char_durations_ms": [50, 30, 40, 40, 60],
9
      "char_start_times_ms": [0, 50, 80, 120, 160]
10
    }
11
  },
12
  "type": "audio"
13
}

1
// Example transcript event structure
2
{
3
  "type": "user_transcript",
4
  "user_transcription_event": {
5
    "user_transcript": "Hello, how can you help me today?"
6
  }
7
}

1
// Example response event structure
2
{
3
  "type": "agent_response",
4
  "agent_response_event": {
5
    "agent_response": "Hello, how can I assist you today?"
6
  }
7
}

1
// Example response correction event structure
2
{
3
  "type": "agent_response_correction",
4
  "agent_response_correction_event": {
5
    "original_agent_response": "Let me tell you about the complete history...",
6
    "corrected_agent_response": "Let me tell you about..."  // Truncated after interruption
7
  }
8
}

1
// Example agent response metadata event structure
2
{
3
  "type": "agent_response_metadata",
4
  "agent_response_metadata_event": {
5
    "metadata": {
6
      // Any key-value pairs returned by your custom LLM
7
      "key": "value"
8
    },
9
    "event_id": 12345
10
  }
11
}

1
// Example tool call event structure
2
{
3
  "type": "client_tool_call",
4
  "client_tool_call": {
5
    "tool_name": "search_database",
6
    "tool_call_id": "call_123456",
7
    "parameters": {
8
      "query": "user information",
9
      "filters": {
10
        "date": "2024-01-01"
11
      }
12
    }
13
  }
14
}

1
// Example agent tool response event structure
2
{
3
  "type": "agent_tool_response",
4
  "agent_tool_response": {
5
    "tool_name": "skip_turn",
6
    "tool_call_id": "skip_turn_c82ca55355c840bab193effb9a7e8101",
7
    "tool_type": "system",
8
    "is_error": false
9
  }
10
}

1
// Example agent tool response full payload event structure
2
{
3
  "type": "agent_tool_response_full_payload",
4
  "agent_tool_response_full_payload": {
5
    "tool_name": "lookup_order",
6
    "tool_call_id": "lookup_order_c82ca55355c840bab193effb9a7e8101",
7
    "tool_type": "webhook",
8
    "is_error": false,
9
    "full_tool_result": "{\"order_id\": \"ORD-789\", \"status\": \"shipped\"}",
10
    "truncated": false
11
  }
12
}

1
// Example VAD score event
2
{
3
  "type": "vad_score",
4
  "vad_score_event": {
5
    "vad_score": 0.95
6
  }
7
}

1
{
2
  "type": "mcp_tool_call",
3
  "mcp_tool_call": {
4
    "service_id": "xJ8kP2nQ7sL9mW4vR6tY",
5
    "tool_call_id": "call_123456",
6
    "tool_name": "search_database",
7
    "tool_description": "Search the database for user information",
8
    "parameters": {
9
      "query": "user information",
10
    },
11
    "timestamp": "2024-09-30T14:23:45.123456+00:00",
12
    "state": "loading",
13
    "approval_timeout_secs": 10
14
  }
15
}

1
// Example start event
2
{
3
  "type": "agent_chat_response_part",
4
  "text_response_part": {
5
    "type": "start",
6
    "text": "",
7
    "event_id": "evt_123456"
8
  }
9
}

1
// Example delta event with text chunk
2
{
3
  "type": "agent_chat_response_part",
4
  "text_response_part": {
5
    "type": "delta",
6
    "text": "Hello, how can I",
7
    "event_id": "evt_123456"
8
  }
9
}

1
// Example stop event
2
{
3
  "type": "agent_chat_response_part",
4
  "text_response_part": {
5
    "type": "stop",
6
    "text": "",
7
    "event_id": "evt_123456"
8
  }
9
}

1
// Example agent response complete event structure
2
{
3
  "type": "agent_response_complete",
4
  "agent_response_complete_event": {
5
    "event_id": 12345
6
  }
7
}

1
// Example guardrail triggered event structure
2
{
3
  "type": "guardrail_triggered"
4
}