[]{
"status": "result",
"segment": 2,
"correlation_id": "550e8400-e29b-41d4-a716-446655440000",
"signals": [
{
"type": "agreement",
"start": 5,
"end": 10,
"probability": "high",
"rationale": "Subject nodded repeatedly while maintaining eye contact."
},
{
"type": "confidence",
"start": 5,
"end": 10,
"probability": "medium",
"rationale": "Steady voice with minimal hesitation."
}
],
"engagement_state": [
{
"start": 5,
"end": 10,
"state": "engaged"
}
],
"conversation_quality": {
"overall": {
"quality_index": 72,
"clarity": 67,
"authority": 68,
"energy": 80,
"rapport": 75,
"learning": 70
},
"timeline": [
{
"start": 5,
"end": 10,
"values": {
"quality_index": 74,
"clarity": 67,
"authority": 71,
"energy": 82,
"rapport": 77,
"learning": 72
}
}
]
}
}{
"status": "completed",
"segment": 2,
"correlation_id": "550e8400-e29b-41d4-a716-446655440000"
}{
"status": "error",
"segment": 2,
"correlation_id": "550e8400-e29b-41d4-a716-446655440000",
"error_id": "ih6002",
"link": "https://docs.interhuman.ai/api-reference/error-handling#ih6002-message-too-large",
"message": "WebSocket message too large. Individual video chunks must not exceed 32 MB."
}{
"status": "processing",
"segment": 2,
"correlation_id": "550e8400-e29b-41d4-a716-446655440000",
"bytes": 1200000
}Streaming Analyze
Analyze a video stream.
Documentation Index
Fetch the complete documentation index at: https://docs.interhuman.ai/llms.txt
Use this file to discover all available pages before exploring further.
[]{
"status": "result",
"segment": 2,
"correlation_id": "550e8400-e29b-41d4-a716-446655440000",
"signals": [
{
"type": "agreement",
"start": 5,
"end": 10,
"probability": "high",
"rationale": "Subject nodded repeatedly while maintaining eye contact."
},
{
"type": "confidence",
"start": 5,
"end": 10,
"probability": "medium",
"rationale": "Steady voice with minimal hesitation."
}
],
"engagement_state": [
{
"start": 5,
"end": 10,
"state": "engaged"
}
],
"conversation_quality": {
"overall": {
"quality_index": 72,
"clarity": 67,
"authority": 68,
"energy": 80,
"rapport": 75,
"learning": 70
},
"timeline": [
{
"start": 5,
"end": 10,
"values": {
"quality_index": 74,
"clarity": 67,
"authority": 71,
"energy": 82,
"rapport": 77,
"learning": 72
}
}
]
}
}{
"status": "completed",
"segment": 2,
"correlation_id": "550e8400-e29b-41d4-a716-446655440000"
}{
"status": "error",
"segment": 2,
"correlation_id": "550e8400-e29b-41d4-a716-446655440000",
"error_id": "ih6002",
"link": "https://docs.interhuman.ai/api-reference/error-handling#ih6002-message-too-large",
"message": "WebSocket message too large. Individual video chunks must not exceed 32 MB."
}{
"status": "processing",
"segment": 2,
"correlation_id": "550e8400-e29b-41d4-a716-446655440000",
"bytes": 1200000
}API key authentication. Include your API key in the Authorization header as 'Bearer <api_key>'.
Optional identifier supplied by the client to correlate this request with their own logs. When provided, the value is recorded alongside the server-assigned correlation ID in Interhuman logs to aid lookup and support investigations. This header is not echoed back in the response; the server returns its own correlation ID in the X-Correlation-ID HTTP response header.
Authentication credential supplied during the WebSocket handshake. Pass your API key here when your client cannot set an Authorization header for WebSocket connections.
Optional flags indicating which conversation quality sections to include in result messages. Repeat the parameter once per flag (for example ?include[]=conversation_quality_overall&include[]=conversation_quality_timeline).
Accepted values:
conversation_quality_overall: include the overall conversation quality index, cumulative across every segment processed so far in the session.conversation_quality_timeline: include the per-segment conversation quality entry for the current segment window.
When omitted, no optional sections are included. Unknown values are ignored.
Binary video segment sent by the client for analysis. Each segment must be at least 3 seconds long and must not exceed 32MB. Accepts the following formats: mp4, avi, mov, mkv, mpeg-ts, mpeg-2-ts, webm.
Contains the results of the analysis for the current segment. signals and engagement_state cover this segment only; conversation_quality is computed over every segment processed so far in the session and is only emitted when the client opts in via the include[] query parameter at WebSocket connect (include[]=conversation_quality_overall and/or include[]=conversation_quality_timeline).
Indicates that processing for the video segment has completed.
Indicates the operation failed and processing for this specific video segment has ceased without further updates.
Indicates that the video segment has been received and analysis is in progress.