OneSay API
    • OneSay Core
      • Session
        • Create a OneSay session
        • Check voice readiness without creating a voice session
        • Fetch a session snapshot
        • Consume transient dictionary learning candidates
        • Mark a session as inserted
        • Cancel a session
      • Realtime
        • Read dedicated realtime gateway health
        • Open the dedicated realtime health socket
        • Open a reusable realtime lease gateway
      • Refine
        • Refine transcript text
      • Question Answer
        • Create an ask-anything response
      • Text To Speech
        • Create a text-to-speech response
      • Billing
        • Read usage ledger entries
        • Read an entitlement snapshot
        • Check quota availability
        • Consume quota
        • Reconcile an entitlement snapshot
      • Reliability
        • Read service health snapshots
        • Read one status service snapshot
        • Read one status probe snapshot
        • List observer monitor targets
      • Privacy
        • Grant diagnostic consent
        • Revoke a consent
        • Record an audit trail
        • List audit trails
        • List consents
      • Insights
        • Generate Insights metadata
        • Generate Insights AI memory outcomes
      • Realtime Lease
        • Create a realtime lease and first business session
        • Read an active realtime lease
        • Revoke a realtime lease
        • Claim a fresh business session on an active lease
        • Validate a session against an active realtime lease
    • OneSay Platform
      • Identity
        • Load an identity subject seam snapshot
        • Load an account-link seam snapshot
        • Load an access-context seam snapshot
        • Load the admin authProvider contract snapshot
        • Load workflow and machine-identity seam snapshots
    • OneSay Control Plane
      • Usage
        • List admin usage entries
        • Read one admin usage entry
      • Provider Usage
        • List provider usage ledger events
      • Provider Control
        • Load provider control routing
        • Replace the LLM provider route
        • Load runtime provider route
      • Entitlements
        • List admin entitlements
        • Read one admin entitlement record
        • Reconcile one admin entitlement record
      • Privacy
        • List admin privacy consents
        • Read one admin privacy consent record
        • List admin privacy audit trails
        • Read one admin privacy audit trail record
      • Service Status
        • List admin service-status resources
        • Read one admin service-status resource
        • List retained incident-history records for one admin service-status resource
        • Read one retained incident-history record for an admin service-status resource
        • Acknowledge one retained incident for an admin service-status resource
        • Resolve one retained incident for an admin service-status resource
        • Reopen one retained incident for an admin service-status resource
      • Telemetry
        • List admin telemetry events
        • Read one admin telemetry event
    • usage.metering
      • Read current authenticated user's usage and TinyShip account state
      • Ingest a usage event
    • usage.entitlements
      • Check whether the current user can use a service or feature
    • usage.quota
      • Atomically reserve weekly input-character quota before a billable provider action
      • Commit actual input characters for a completed quota reservation
      • Release a failed or cancelled quota reservation
    • admin.usage
      • Read admin usage overview
      • Read raw usage event drilldown
      • Read weekly usage aggregates
      • Browse quota state for every TinyShip user, including users with zero usage
      • Read a user's usage detail
    • admin.billing
      • Read a user's TinyShip billing account state
    • voice.observability
      • Create or upsert a privacy-safe voice trace summary
      • Insert a bounded privacy-safe voice trace event batch
      • Record privacy-safe client insert acknowledgement
    • admin.voice
      • Read one user's voice diagnostics overview
      • List privacy-safe traces for one user
      • Read one user's device voice diagnostics
      • Read a privacy-safe voice trace waterfall
      • Read fleet-level voice diagnostics overview
      • Read fleet-level voice performance dashboard
      • Explore privacy-safe slow voice traces
      • Read voice performance data quality
      • Read one user's voice performance profile
    • getPointsExchangeSummary
      GET
    • exchangePointsForPro30D
      POST
    • getPointsExchangeHistory
      GET
    • getPointsExchangeCodes
      GET
    • revealOwnedCodeAllocation
      POST
    • getReferralRewardSummary
      GET
    • getReferralRewardHistory
      GET
    • getOneSayNotifications
      GET
    • markOneSayNotificationRead
      POST
    • markAllOneSayNotificationsRead
      POST
    • getReferralQualificationSnapshots
      POST
    • listAdminReferralRewards
      GET
    • mutateAdminReferralReward
      POST
    • listAdminPointsExchanges
      GET
    • 数据模型
      • WritingMode
      • VoiceWorkflow
      • WritingTone
      • DetectedTextLanguage
      • RewriteCommandKind
      • AskAnythingMode
      • BillingPlan
      • BillingQuotaSource
      • BillingConsumeReason
      • SessionBillingState
      • SessionPrivacyFlag
      • SessionStatus
      • PrivacyConsentScope
      • PrivacyConsentSource
      • AuditAction
      • AuditAuthorizationState
      • AuditOutcome
      • DataClassification
      • IncidentSeverity
      • IncidentState
      • ServiceHealthStatus
      • ServiceHealthCheckKind
      • ServiceHealthCheckState
      • IdentityProviderVendor
      • CommerceIdentityProvider
      • IdentityBindingState
      • EntitlementReconciliationSource
      • SessionCapabilitySnapshot
      • SessionProviderRoute
      • SessionBillingStatus
      • SessionPrivacyFlags
      • Session
      • VoiceReadinessStatus
      • VoiceReadinessAuthState
      • VoiceReadinessEntitlementState
      • VoiceReadinessResponse
      • SessionCreationRequest
      • ProcessedSpeechSessionCreationRequest
      • InstructionSpeechSessionCreationRequest
      • SessionCancelRequest
      • SessionCreateResponse
      • SessionGetResponse
      • SessionInsertResponse
      • SessionCancelResponse
      • TranscriptPartial
      • TranscriptFinal
      • RefineRequest
      • ProcessedSpeechRefineRequest
      • InstructionRefineRequest
      • RefineResponse
      • RealtimeGatewayAudioFrame
      • RealtimeGatewayConnectResponse
      • RealtimeGatewayHealthSnapshot
      • RealtimeGatewayHealthResponse
      • RealtimeGatewayHealthSocketResponse
      • RealtimePartialTranscriptEvent
      • RealtimeFinalTranscriptEvent
      • RealtimeRefineCompletedEvent
      • RefineFailure
      • RealtimeRefineFailedEvent
      • RealtimeSessionEvent
      • RealtimeGatewayEventResponse
      • AskAnythingRequest
      • AskAnythingExternalSearchSource
      • AskAnythingResponse
      • TextToSpeechRequest
      • TextToSpeechResult
      • TextToSpeechResponse
      • RewriteCommand
      • DictionaryWord
      • DictionaryLearningCandidate
      • DictionaryLearningCandidatesResponse
      • UsageLedgerEntry
      • AdminUsageEntryRecord
      • BillingLedgerEntry
      • EntitlementSnapshot
      • AdminEntitlementRecord
      • QuotaCheckRequest
      • QuotaCheckResult
      • QuotaConsumeRequest
      • EntitlementReconciliationRequest
      • EntitlementReconciliationRecord
      • UsageResponse
      • EntitlementsResponse
      • EntitlementReconciliationResponse
      • AdminUsageEntriesListResponse
      • AdminUsageEntryResponse
      • AdminProviderKey
      • AdminProviderOperation
      • AdminProviderCatalogItem
      • AdminProviderRoute
      • AdminProviderControlSnapshot
      • AdminProviderLLMRouteUpdateRequest
      • AdminProviderRuntimeRoute
      • AdminProviderUsageFamily
      • AdminProviderUsageStatus
      • AdminProviderUsageBillReconciliationStatus
      • AdminProviderUsageEventRecord
      • AdminProviderUsageBreakdownRecord
      • AdminProviderUsageSummary
      • AdminProviderUsageListResponse
      • AdminEntitlementsListResponse
      • AdminEntitlementResponse
      • AdminEntitlementReconciliationRequest
      • AdminEntitlementReconciliationResponse
      • AdminPrivacyConsentRecord
      • AdminPrivacyConsentsListResponse
      • AdminPrivacyConsentResponse
      • QuotaCheckResponse
      • QuotaConsumeResponse
      • PrivacyConsent
      • PrivacyDiagnosticConsentRequest
      • PrivacyDiagnosticConsentResponse
      • PrivacyConsentRevocationRequest
      • PrivacyConsentRevocationResponse
      • AuditTarget
      • AuditTrail
      • PrivacyAuditTrailRecordRequest
      • PrivacyAuditTrailRecordResponse
      • PrivacyConsentsResponse
      • AuditTrailListResponse
      • AdminPrivacyAuditTrailRecord
      • AdminPrivacyAuditTrailsListResponse
      • AdminPrivacyAuditTrailResponse
      • IdentitySubjectRecord
      • IdentityAccountLinkRecord
      • IdentityAccessContextRecord
      • AdminAuthProviderContractSnapshot
      • WorkflowIdentityBindingRecord
      • MachineIdentityPrincipalRecord
      • WorkflowMachineIdentitySnapshot
      • IdentitySubjectResponse
      • IdentityAccountLinkResponse
      • IdentityAccessContextResponse
      • AdminAuthProviderContractSnapshotResponse
      • WorkflowMachineIdentitySnapshotResponse
      • IncidentRecord
      • ServiceHealthCheckSnapshot
      • ServiceStatusSnapshot
      • AdminServiceStatusRecord
      • AdminServiceStatusDetailRecord
      • StatusResponse
      • StatusServiceResponse
      • ServiceProbeSnapshot
      • StatusProbeResponse
      • StatusMonitorTargetCategory
      • StatusMonitorTargetTransport
      • StatusMonitorTargetAuthMode
      • StatusMonitorTargetSnapshot
      • StatusMonitorTargetsResponse
      • AdminServiceStatusListResponse
      • AdminServiceStatusResponse
      • AdminServiceStatusIncidentHistoryListResponse
      • AdminServiceStatusIncidentHistoryResponse
      • AdminServiceStatusIncidentMutationResponse
      • AdminTelemetryEventLevel
      • AdminTelemetryEventRecord
      • AdminTelemetryEventsListResponse
      • AdminTelemetryEventResponse
      • TranslationTargetLanguage
      • EnglishVoiceInputLanguageLocale
      • ChineseVoiceInputLanguageLocale
      • SpanishVoiceInputLanguageLocale
      • FrenchVoiceInputLanguageLocale
      • PortugueseVoiceInputLanguageLocale
      • VoiceInputLanguageVariants
      • RecognitionPreferences
      • SpeechProcessingPreferences
      • FormattingIntent
      • PersonalStylePreference
      • AppTonePreset
      • PersonalStyleSettings
      • AppContext
      • AppToneExpression
      • ExpressionContext
      • AppliedExpression
      • InsightSourceKind
      • InsightEntryKind
      • InsightEntryImportance
      • InsightMetadataLocalContext
      • InsightMetadataRequest
      • InsightMetadataTask
      • InsightMetadataDecision
      • InsightMetadataResult
      • InsightMetadataResponse
      • InsightAiInsightsRequest
      • InsightAiInsightsResult
      • InsightAiInsightsResponse
      • AiTaskKind
      • StructuredOutputLevel
      • StructuredOutputFallbackReason
      • StructuredOutputMeta
      • TokenUsage
      • ProviderAttempt
      • AiResponseMeta
      • AiContentBlockHeading
      • AiContentBlockParagraph
      • AiContentBlockBulletList
      • AiContentBlockNumberedList
      • AiTodoListItem
      • AiContentBlockTodoList
      • AiContentBlockQuote
      • AiContentBlockCode
      • AiContentBlockTable
      • AiContentBlock
      • AiResponseRender
      • FallbackTextPayload
      • VoiceInputPayload
      • TranslationPayload
      • RewritePayload
      • AskAnythingPayload
      • InsightMetadataPayload
      • InsightDigestPayload
      • RefineAiPayload
      • AskAnythingAiPayload
      • InsightMetadataAiPayload
      • InsightDigestAiPayload
      • AiResponseEnvelope
      • RefineAiResponseEnvelope
      • AskAnythingAiResponseEnvelope
      • InsightMetadataAiResponseEnvelope
      • InsightDigestAiResponseEnvelope
      • AiApiSuccess
      • AiApiErrorBody
      • AiApiError
      • RealtimeLeaseBinding
      • RealtimeLease
      • RealtimeLeaseCreateRequest
      • RealtimeLeaseSessionClaimRequest
      • RealtimeLeaseResponse
      • EmptyObject
      • AffiliateMode
      • ReferralRewardStatus
      • PointsExchangeStatus
      • CodeAllocationStatus
      • PointsExchangeSummary
      • PointsExchange
      • CodeAllocation
      • ReferralRewardSummary
      • ReferralReward
      • ReferralQualificationRequest
      • ReferralQualificationSnapshot
      • Notification
      • BusinessError
      • UsageService
      • UsageFeature
      • UsageEventStatus
      • UsageMetrics
      • UsageCost
      • UsageUserIdentity
      • UsageEvent
      • UsageEventIngestionRequest
      • UsageEventIngestionResponse
      • UsageAggregate
      • UsageWeeklyAggregate
      • UsageSummary
      • AccountProfile
      • BillingAccount
      • UserEntitlement
      • QuotaState
      • QuotaSnapshot
      • EntitlementCheckRequest
      • EntitlementCheckResponse
      • QuotaReservationRequest
      • QuotaCommitRequest
      • QuotaReservation
      • QuotaReservationResponse
      • CurrentUserUsageResponse
      • AdminUsageSummaryResponse
      • AdminUsageEventsResponse
      • AdminUsageWeeklyResponse
      • AdminUsageQuotaRow
      • AdminUsageQuotasResponse
      • AdminUserUsageResponse
      • BillingAccountResponse
      • VoiceTraceOutcome
      • VoiceTraceFailureStage
      • VoiceTraceBottleneckClassification
      • VoiceTraceNetworkQuality
      • VoiceTraceNetworkDiagnosis
      • VoiceTraceEndpointMode
      • VoiceTraceEndpointReason
      • VoiceTraceRefineDecisionReason
      • VoiceTraceRefineModelTier
      • VoiceTraceProxyRouteConfidence
      • VoiceTraceProxyDetectionStatus
      • VoiceTraceProxyDetectionConfidence
      • VoiceTraceProxyEffectiveRoute
      • VoiceTraceSystemProxyType
      • VoiceTraceProxyDetectionReason
      • VoiceRuntimeWarmState
      • VoiceTraceFrameType
      • VoiceTraceForbiddenField
      • VoiceTracePayloadPolicy
      • VoiceTraceSafePayload
      • VoiceTraceSummary
      • VoiceTraceSummaryUpsertRequest
      • VoiceTraceTimingMetrics
      • VoiceTraceCounts
      • VoiceTraceProviderSnapshot
      • VoiceTraceInsertSnapshot
      • VoiceTraceNetworkSnapshot
      • VoiceTraceSummaryUpsertResponse
      • VoiceTraceEvent
      • VoiceTraceEventBatchRequest
      • VoiceTraceEventBatchResponse
      • VoiceTraceClientInsertAckRequest
      • VoiceTraceClientInsertAckResponse
      • VoiceTraceEventName
      • VoiceRealtimeFrame
      • VoiceRealtimeStartFrame
      • VoiceRealtimeStartAckFrame
      • VoiceRealtimeAudioFrame
      • VoiceRealtimeAudioAckFrame
      • VoiceRealtimeResultAckFrame
      • VoiceRealtimeClientInsertAckFrame
      • VoiceRealtimeErrorFrame
      • VoiceRealtimePingPongFrame
      • VoiceTracePercentiles
      • AdminUserVoiceOverviewResponse
      • AdminVoiceOverviewResponse
      • VoiceTraceUserIdentity
      • VoiceLatencyBudget
      • VoicePerformanceDataQualityMetric
      • VoicePerformanceDataQualitySummary
      • VoicePerformanceCostUsageBoundary
      • VoicePerformanceOptimizationItem
      • VoiceRefineOptimizationBucket
      • VoiceRefineOptimizationStats
      • VoiceColdStartBucket
      • VoiceColdStartPanel
      • VoiceEndpointBreakdown
      • VoiceRealtimeLeaseOptimizationStats
      • AdminVoicePerformanceOverviewResponse
      • AdminVoiceSlowTracesResponse
      • AdminVoicePerformanceDataQualityResponse
      • AdminVoiceUserPerformanceResponse
      • AdminUserVoiceTracesResponse
      • AdminUserVoiceDeviceResponse
      • AdminVoiceTraceDetailResponse
      • VoiceTraceWaterfallSegment
      • VoiceTraceBreakdownItem
      • VoiceTraceRefineProfile
      • VoiceTraceRefineMode
      • VoiceTraceRefineFallbackMode
      • VoiceTraceSchemaVersion
      • VoiceTraceFeatureVersion
      • VoiceTraceClockDomain

    VoiceRealtimeStartFrame

    {
        "trace_schema_version": "voice-trace-v4",
        "trace_feature_version": "voice-chain-v4",
        "type": "start",
        "trace_id": "string",
        "session_id": "string",
        "client_session_id": "string",
        "device_id": "string",
        "app_launch_id": "string",
        "feature_source": "string",
        "workflow": "string",
        "source_surface": "string",
        "app_version": "string",
        "electron_git_head": "string",
        "os_name": "string",
        "os_version": "string",
        "readiness_status": "ready",
        "readiness_used_for_session": true,
        "readiness_failure_code": "string",
        "first_voice_after_launch": true,
        "first_voice_after_login": true,
        "voice_runtime_warm_state": "cold",
        "timings": {
            "physicalKeyToInsertDoneMs": 0,
            "captureStopToInsertDoneMs": 0,
            "physicalKeyToCaptureStartMs": 0,
            "physicalKeyToFirstAudioFrameMs": 0,
            "physicalKeyToFirstAudioPacketSentMs": 0,
            "sessionCreateMs": 0,
            "webSocketConnectMs": 0,
            "startAckRttMs": 0,
            "firstAudioAckRttMs": 0,
            "resultAckRttMs": 0,
            "pingRttMs": 0,
            "avgPingRttMs": 0,
            "maxPingRttMs": 0,
            "gatewayFirstAudioToProviderWriteMs": 0,
            "firstAudioToFirstPartialMs": 0,
            "asrFinalizeMs": 0,
            "providerConnectMs": 0,
            "readinessLatencyMs": 0,
            "readinessAgeMs": 0,
            "aiProviderMs": 0,
            "orchestratorRefineMs": 0,
            "aiServiceOverheadMs": 0,
            "insertMs": 0,
            "physicalKeyToHudMs": 0,
            "captureMs": 0,
            "captureStopToFinishRequestMs": 0,
            "finishRequestToFinalPacketSentMs": 0,
            "finalPacketSentToFinalReceivedMs": 0,
            "insertDoneToHudHiddenMs": 0,
            "finalAudioAckRttMs": 0,
            "gatewayFinalizeOverheadMs": 0,
            "telemetryExportMs": 0,
            "targetAppResolveMs": 0,
            "focusResolveMs": 0,
            "accessibilityInsertMs": 0,
            "clipboardSaveMs": 0,
            "clipboardWriteMs": 0,
            "pasteTriggerMs": 0,
            "clipboardRestoreMs": 0,
            "simulatedTypingMs": 0,
            "voiceResultReceivedToInsertStartMs": 0,
            "voiceResultReceivedToAskRequestStartMs": 0,
            "askRequestToResponseMs": 0,
            "askResponseToInsertStartMs": 0,
            "askExternalSearchProviderMs": 0
        },
        "client_timezone": "string",
        "client_locale": "string",
        "proxy_mode": "string",
        "proxy_detection_status": "string",
        "proxy_detection_confidence": "string",
        "proxy_detection_reasons": [
            "string"
        ],
        "system_proxy_configured": true,
        "system_proxy_types": [
            "string"
        ],
        "effective_proxy_for_api": "string",
        "electron_proxy_for_api": "string",
        "vpn_or_tunnel_interface_detected": true,
        "proxy_env_detected": true,
        "proxy_bypass_for_onesay": true,
        "proxy_detection_source_version": "string",
        "endpoint_host": "string",
        "endpoint_region": "string",
        "endpoint_mode": "string",
        "endpoint_reason": "string",
        "direct_rule_suggestion_shown": true
    }
    Built with