On this page
Audio OperationsStart RecordingPause RecordingResume RecordingStop RecordingUpdate Recording ParametersSwitch Recording ChannelControl Native Recording Floating WindowEvent Stream ControlAudio File OperationsGet Recording Transcription ListSearch Recording TranscriptionsUpdate Recording File InformationBatch Delete Recording FilesGet Total Audio Files SizeGet Compliant Audio Share PathManage Recording File Share LinkBatch Merge RecordingsCancel Merge RecordingsQuery Recording Merge StatusUpdate TagsOffline Transfer and Cloud SyncDownload Offline FilesQuery Device Offline File Download StatusSwitch AP/BLE Transfer ModeGet Cloud Sync Switch StatusSync Note RecordsSync Download Note AudioStart Import FilesRetry ImportCancel ImportCancel RetryGet Audio Import StatusSave cloud sync switch settingTranscription and SummaryGet Real-Time Transcription DataSave Transcription ResultSave Summary ResultUpdate Real-Time Transcription ResultQuery Transcription StatusQuery Transcription ResultTranscribe and Summarize RecordingQuery Recording Transcription DetailsQuery Recording Transcription SummaryQuery Recording Task StatusTranslationStart TranslationGet Translation Record ListGet Translation Record DetailsSend Translation to NoteBatch Delete Translation FilesList supported translation languagesDevice and Quick EntryGet Earphone Bluetooth Connection StatusSet Up MiniApp and Native ChannelGet Quick Entry ListEnable or Disable Quick EntryAudio Event ListenersReal-Time Translation Recording Event NotificationRemove Real-Time Translation Recording Event Notification ListenerRecording Transcription Amplitude Update Event ListenerRemove Recording Transcription Amplitude Update Event ListenerRecording Status Change Event ListenerRemove Recording Status Change Event ListenerRecording Finished Notification Event ListenerRemove Recording Finished Notification Event ListenerRecording Transcription File Upload Progress Event ListenerRemove Recording Transcription File Upload Progress Event ListenerAudio Source Switch Change Event ListenerRemove Audio Source Switch Change Event ListenerRecording Scene Battery Change Event ListenerRemove Recording Scene Battery Change Event ListenerRecording Quality Change Event ListenerRemove Recording Quality Change Event ListenerEarphone Bluetooth Connection Status Change Event ListenerRemove Earphone Bluetooth Connection Status Change Event ListenerOffline File Transfer Progress Event ListenerRemove Offline File Transfer Progress Event ListenerFile Import Status Event ListenerRemove File Import Status Event ListenerCloud Sync Switch Status Event ListenerRemove Cloud Sync Switch Status Event ListenerRecord Sync Status Event ListenerRemove Record Sync Status Event ListenerFile List Status Refresh Event ListenerRemove File List Status Refresh Event ListenerFile Merge Status Event ListenerRemove File Merge Status Event ListenerMiniApp Push Refresh Event ListenerRemove MiniApp Push Refresh Event ListenerQuick Entry Add Result Event ListenerRemove Quick Entry Add Result Event ListenerText Translation TTS Complete Event ListenerRemove Text Translation TTS Complete Event ListenerRecording & ContentMark a recording as read or unreadEdit transcription text contentEdit summary title and bodyCreate or update audio record metadataConfig & PreferencesGet configuration value by keyGet mind map footer branding configGet agent channel codeGet user preference settingsUpdate user preference settingsGet app popup switch config (V2)Feedback & TagsGet feedback tag list by business typeSubmit user feedback (like/dislike/cancel)Get user feedback detailsQuery historical tag library (up to 30)SharingQuery owner-side share link detailsGenerate share file link (v3)Summary TemplatesRecommended summary templates (max 6 per category)Paginated template list by categoryCreate a custom summary templateUpdate a custom summary templateDelete a custom summary templateList template iconsPolish user prompt with AIGet today's prompt polish usage countEntitlements & AccountFirst-time user gift (may grant quota)Get product purchase linkUser statistics overviewPurchase / consumption order listAccount entitlement detailsQuery remaining account quotaSubscription package configurationRecommended hardware product codesAction ItemsList summary action itemsBind multiple action itemsUpdate action item status

API

Audio Operations

Start Recording

Pause Recording

Resume Recording

Stop Recording

Update Recording Parameters

  • Description: Update recording parameters
  • API Details: updateParams

Switch Recording Channel

Control Native Recording Floating Window

Event Stream Control

Audio File Operations

Get Recording Transcription List

Search Recording Transcriptions

Update Recording File Information

Batch Delete Recording Files

  • Description: Batch or single delete recording files
  • API Details: removeFileList

Get Total Audio Files Size

  • Description: Get the total storage used by audio files
  • API Details: getAudioFilesSize

Get Compliant Audio Share Path

Batch Merge Recordings

Cancel Merge Recordings

Query Recording Merge Status

Update Tags

Offline Transfer and Cloud Sync

Download Offline Files

Query Device Offline File Download Status

Switch AP/BLE Transfer Mode

Get Cloud Sync Switch Status

Sync Note Records

Sync Download Note Audio

Start Import Files

  • Description: Start importing files
  • API Details: startImport

Retry Import

Cancel Import

Cancel Retry

Get Audio Import Status

Save cloud sync switch setting

  • Description: Save cloud sync switch setting
  • API Details: saveSyncSwitch

Transcription and Summary

Get Real-Time Transcription Data

Save Transcription Result

Save Summary Result

Update Real-Time Transcription Result

Query Transcription Status

Query Transcription Result

Transcribe and Summarize Recording

Query Recording Transcription Details

Query Recording Transcription Summary

Query Recording Task Status

Translation

Start Translation

Get Translation Record List

Get Translation Record Details

Send Translation to Note

  • Description: Send translation to Note/summary
  • API Details: sendToNote

Batch Delete Translation Files

List supported translation languages

Device and Quick Entry

Get Earphone Bluetooth Connection Status

Set Up MiniApp and Native Channel

Get Quick Entry List

Enable or Disable Quick Entry

Audio Event Listeners

Real-Time Translation Recording Event Notification

Remove Real-Time Translation Recording Event Notification Listener

Recording Transcription Amplitude Update Event Listener

Remove Recording Transcription Amplitude Update Event Listener

Recording Status Change Event Listener

Remove Recording Status Change Event Listener

Recording Finished Notification Event Listener

Remove Recording Finished Notification Event Listener

Recording Transcription File Upload Progress Event Listener

Remove Recording Transcription File Upload Progress Event Listener

Audio Source Switch Change Event Listener

Remove Audio Source Switch Change Event Listener

Recording Scene Battery Change Event Listener

Remove Recording Scene Battery Change Event Listener

Recording Quality Change Event Listener

Remove Recording Quality Change Event Listener

Earphone Bluetooth Connection Status Change Event Listener

Remove Earphone Bluetooth Connection Status Change Event Listener

Offline File Transfer Progress Event Listener

Remove Offline File Transfer Progress Event Listener

File Import Status Event Listener

Remove File Import Status Event Listener

Cloud Sync Switch Status Event Listener

Remove Cloud Sync Switch Status Event Listener

Record Sync Status Event Listener

Remove Record Sync Status Event Listener

File List Status Refresh Event Listener

Remove File List Status Refresh Event Listener

File Merge Status Event Listener

Remove File Merge Status Event Listener

MiniApp Push Refresh Event Listener

Remove MiniApp Push Refresh Event Listener

Quick Entry Add Result Event Listener

Remove Quick Entry Add Result Event Listener

Text Translation TTS Complete Event Listener

Remove Text Translation TTS Complete Event Listener

Recording & Content

Mark a recording as read or unread

Edit transcription text content

Edit summary title and body

  • Description: Edit summary title and body
  • API Details: editSummary

Create or update audio record metadata

  • Description: Create or update audio record metadata
  • API Details: addAudioRecord

Config & Preferences

Get configuration value by key

  • Description: Get configuration value by key
  • API Details: getConfigByKey

Get agent channel code

  • Description: Get agent channel code
  • API Details: getChannel

Get user preference settings

  • Description: Get user preference settings
  • API Details: getPreference

Update user preference settings

Get app popup switch config (V2)

Feedback & Tags

Get feedback tag list by business type

  • Description: Get feedback tag list by business type
  • API Details: getTagList

Submit user feedback (like/dislike/cancel)

  • Description: Submit user feedback (like/dislike/cancel)
  • API Details: submitFeedback

Get user feedback details

Query historical tag library (up to 30)

  • Description: Query historical tag library (up to 30)
  • API Details: getTagHistory

Sharing

  • Description: Query owner-side share link details
  • API Details: queryShareLink

Summary Templates

Paginated template list by category

Create a custom summary template

Update a custom summary template

Delete a custom summary template

List template icons

Polish user prompt with AI

  • Description: Polish user prompt with AI
  • API Details: polishPrompt

Get today's prompt polish usage count

Entitlements & Account

First-time user gift (may grant quota)

  • Description: First-time user gift (may grant quota)
  • API Details: getFirstTimeGift

User statistics overview

Purchase / consumption order list

Account entitlement details

Query remaining account quota

Subscription package configuration

Action Items

List summary action items

Bind multiple action items

Update action item status