v24

latestOpenAPI 3.1.0MITraw.githubusercontent.com2026-08-012843108.3 KB
Conversations

Create Conversation From Segments

Create a new conversation from structured transcript segments.

This endpoint is for advanced integrations that have speaker diarization and timing information. It processes the transcript segments through the full conversation pipeline.

Transcript Segments:

  • text: The text spoken (required)
  • speaker: Speaker identifier like 'SPEAKER_00', 'SPEAKER_01' (default: 'SPEAKER_00')
  • speaker_id: Numeric speaker ID (auto-calculated from speaker if not provided)
  • is_user: Whether this segment is from the user (default: False)
  • person_id: ID of known person speaking (optional)
  • start: Start time in seconds, e.g., 0.0, 1.5, 60.2 (required)
  • end: End time in seconds, e.g., 1.5, 3.0, 65.8 (required)

Other Parameters:

  • source: Source of conversation (default: external_integration). Options:
    • omi, friend, openglass, phone, desktop, apple_watch, bee, plaud, frame, etc.
  • started_at: When conversation started (defaults to now)
  • finished_at: When conversation finished (calculated from last segment if not provided)
  • language: Language code (default: 'en')
  • geolocation: Optional geolocation data

Example:

{
  "transcript_segments": [
    {
      "text": "Hey, how are you doing?",
      "speaker": "SPEAKER_00",
      "is_user": true,
      "start": 0.0,
      "end": 2.5
    },
    {
      "text": "I'm doing great, thanks!",
      "speaker": "SPEAKER_01",
      "is_user": false,
      "start": 2.8,
      "end": 5.2
    }
  ],
  "source": "phone",
  "language": "en"
}
post/v1/dev/user/conversations/from-segments

Request body

client_device_idstring nullable

Capture device id ({platform}_{hash})

client_platformstring nullable

Client platform (ios/android/macos)

client_session_idstring nullable

Stable client-generated session ID. When provided, retries return the same conversation ID.

finished_atstring date-time nullable

When conversation finished (calculated from segments duration if not provided)

languagestring nullable

Language code (ISO 639-1, e.g., 'en', 'es', 'fr')

source'friend' | 'omi' | 'fieldy' | 'bee' | 'plaud' | 'frame' | 'friend_com' | 'apple_watch' | 'phone' | 'phone_call' | 'desktop' | 'openglass' | 'screenpipe' | 'workflow' | 'sdcard' | 'external_integration' | 'limitless' | 'rayban_meta' | 'onboarding' | 'unknown'
started_atstring date-time nullable

When conversation started (defaults to now)

Response

Successful Response

discardedboolean required
idstring required
statusstring required