API Reference
Overview
Detailed Reference
start-recording Starts audio capture for a session
| Parameter | Type | Required | Description |
|---|---|---|---|
session-id | string | — |
pause-recording Temporarily halts audio capture.
| Parameter | Type | Required | Description |
|---|---|---|---|
session-id | string | — |
resume-recording Resumes paused audio capture.
| Parameter | Type | Required | Description |
|---|---|---|---|
session-id | string | — |
stop-recording Ends audio capture for a session.
| Parameter | Type | Required | Description |
|---|---|---|---|
session-id | string | — |
play-audio Plays back a recorded session from a specific timestamp.
| Parameter | Type | Required | Description |
|---|---|---|---|
recording-id | string | — | |
timestamp | number | — |
browse-library Fetches available practices.
select-practice Retrieves a specific practice by ID.
| Parameter | Type | Required | Description |
|---|---|---|---|
practice-id | string | — |
start-session Starts a new conversation session using a specific format.
| Parameter | Type | Required | Description |
|---|---|---|---|
format-id | string | — | |
participants | array | — |
mark-moment Creates a timestamped flag during an active session.
| Parameter | Type | Required | Description |
|---|---|---|---|
session-id | string | — | |
timestamp | number | — |
end-session Ends an active conversation session.
| Parameter | Type | Required | Description |
|---|---|---|---|
session-id | string | — |
search-memory Searches transcripts and notes for a text query.
| Parameter | Type | Required | Description |
|---|---|---|---|
query | string | — |
add-note Attaches a personal reflection to a marker or transcript segment.
| Parameter | Type | Required | Description |
|---|---|---|---|
marker-id | string | — | |
content | string | — | |
visibility | string | — | 'private' or 'shared' |
update-privacy Updates the visibility of a specific note, transcript, or marker.
| Parameter | Type | Required | Description |
|---|---|---|---|
target-id | string | — | |
visibility | string | — |
query-ai Processes a voice query against the relationship memory.
| Parameter | Type | Required | Description |
|---|---|---|---|
voice-query | string | — |
request-transcription Queues a recording for transcription.
| Parameter | Type | Required | Description |
|---|---|---|---|
recording-id | string | — |
pair-device Initiates a Bluetooth pairing sequence with a partner's device.
sync-data Synchronizes encrypted local data with a paired device.
| Parameter | Type | Required | Description |
|---|---|---|---|
target-device-id | string | — |
recording-started | Parameter | Type | Required | Description |
|---|---|---|---|
session-id | string | — | |
timestamp | Date | — |
recording-stopped | Parameter | Type | Required | Description |
|---|---|---|---|
session-id | string | — | |
duration | number | — |
session-started Emitted when a new session begins.
| Parameter | Type | Required | Description |
|---|---|---|---|
session-id | string | — | |
format-id | string | — | |
timestamp | Date | — |
moment-marked Emitted when a user taps to mark an important moment.
| Parameter | Type | Required | Description |
|---|---|---|---|
marker-id | string | — | |
session-id | string | — | |
timestamp | Date | — |
session-ended Emitted when a session concludes.
| Parameter | Type | Required | Description |
|---|---|---|---|
session-id | string | — | |
duration | number | — | |
timestamp | Date | — |
insight-generated | Parameter | Type | Required | Description |
|---|---|---|---|
session-id | string | — | |
type | string | — | |
description | string | — |
privacy-updated | Parameter | Type | Required | Description |
|---|---|---|---|
target-id | string | — | |
visibility | string | — |
transcription-completed | Parameter | Type | Required | Description |
|---|---|---|---|
session-id | string | — | |
transcript-id | string | — |
device-paired | Parameter | Type | Required | Description |
|---|---|---|---|
device-id | string | — | |
timestamp | Date | — |
data-synced | Parameter | Type | Required | Description |
|---|---|---|---|
target-device-id | string | — | |
timestamp | Date | — |
load-audio Loads a physical audio file for playback.
| Parameter | Type | Required | Description |
|---|---|---|---|
recording-id | string | — |
enforce-timing Manages the turn-taking and timers defined by a format.
| Parameter | Type | Required | Description |
|---|---|---|---|
session-id | string | — | |
format-id | string | — |
detect-patterns Analyzes a transcript to identify recurring themes, contradictions, or unmet needs.
| Parameter | Type | Required | Description |
|---|---|---|---|
transcript | object | — |
transcribe-audio Converts an audio buffer into a structured Transcript with timestamps.
| Parameter | Type | Required | Description |
|---|---|---|---|
audio-data | object | — | Buffer |
| Parameter | Type | Required | Description |
|---|---|---|---|
id | string | ✓ | |
length | number | ✓ |
Declared Errors
transcription-failed
resolve-conflicts Merges local and remote state changes.
| Parameter | Type | Required | Description |
|---|---|---|---|
local-data | object | — | |
remote-data | object | — |
| Error ID | Code | Category | Description |
|---|---|---|---|
recording-failed | TODO | | Thrown when audio cannot be captured. |
session-not-found | TODO | | Thrown when a requested session does not exist. |
pattern-detection-failed | TODO | | Thrown when the local AI model fails to process a transcript. |
transcription-failed | TODO | | Thrown when audio cannot be transcribed locally. |
sync-failed | TODO | | Thrown when the peer-to-peer connection drops or fails to authenticate. |