Skip to content
Aura Live Documentation

Create user live config

POST
/user-live-configs

👤 Authentification Utilisateur Requise

Ce point d’accès permet à l’utilisateur actuellement authentifié de créer et de sauvegarder un nouveau profil de configuration live.

Chaque profil doit avoir un nom unique pour l’utilisateur. La plupart des paramètres techniques ont des valeurs par défaut, vous n’avez donc besoin de spécifier que les champs que vous souhaitez personnaliser.

Example :

{
  "name": "Quiet Room Setup",
  "vad": false,
  "max_buffer": 2
}

Authorizations

Section titled “Authorizations ”

Request Body

Section titled “Request Body ”
object
name
required

A unique, human-readable name for the preset (e.g., ‘default’, ‘low-latency’, ‘high-accuracy’).

string
vad

Enable or disable Voice Activity Detection (VAD). If true, the engine will only process audio segments that contain speech, which can reduce processing load and improve accuracy by filtering out silence or noise.

boolean
Example
true
mode

The transcription mode, controlling how results are sent. Typically ‘partial’ for faster, intermediate results or ‘final’ for more accurate, completed segments.

string
Allowed values: partial final
Example
partial
min_buffer

The minimum amount of audio (in seconds) to buffer before sending it to the ASR model. Higher values can improve accuracy on short phrases but increase initial latency.

number format: float
Example
2
max_buffer

The maximum amount of audio (in seconds) to buffer before forcing a transcription. This acts as an upper bound on latency.

number format: float
Example
4
buffer_timeout

The maximum duration of silence (in seconds) to wait before considering a phrase complete and finalizing the transcription for the current buffer.

number format: float
Example
4
max_delay

The maximum allowed delay (in seconds) between the incoming audio and the returned transcription. The system may adjust buffer sizes to stay within this limit.

number format: float
Example
4
max_chars

The maximum number of characters to include in a single line of the returned transcription. Used for formatting the output for display.

integer
Example
40
max_lines

The maximum number of lines to display in the transcription output. When this limit is reached, older lines may be removed.

integer
Example
2
punctuate

Enable or disable punctuation. If true, the engine will add punctuation.

boolean
Example
true
Examples

Responses

Section titled “ Responses ”

200

Section titled “200 ”

201

Section titled “201 ”

Successful response (inferred from assertions)

object
data
required
object
id
required

The unique numeric identifier for this configuration preset.

integer
Example
1
name
required

A unique, human-readable name for the preset (e.g., ‘default’, ‘low-latency’, ‘high-accuracy’).

string
Example
default
vad

Enable or disable Voice Activity Detection (VAD). If true, the engine will only process audio segments that contain speech, which can reduce processing load and improve accuracy by filtering out silence or noise.

boolean
Example
true
mode

The transcription mode, controlling how results are sent. Typically ‘partial’ for faster, intermediate results or ‘final’ for more accurate, completed segments.

string
Allowed values: partial final
Example
partial
min_buffer

The minimum amount of audio (in seconds) to buffer before sending it to the ASR model. Higher values can improve accuracy on short phrases but increase initial latency.

number format: float
Example
2
max_buffer

The maximum amount of audio (in seconds) to buffer before forcing a transcription. This acts as an upper bound on latency.

number format: float
Example
4
buffer_timeout

The maximum duration of silence (in seconds) to wait before considering a phrase complete and finalizing the transcription for the current buffer.

number format: float
Example
4
max_delay

The maximum allowed delay (in seconds) between the incoming audio and the returned transcription. The system may adjust buffer sizes to stay within this limit.

number format: float
Example
4
max_chars

The maximum number of characters to include in a single line of the returned transcription. Used for formatting the output for display.

integer
Example
40
max_lines

The maximum number of lines to display in the transcription output. When this limit is reached, older lines may be removed.

integer
Example
2
punctuate

Enable or disable punctuation. If true, the engine will add punctuation.

boolean
Example
true
Example
{
  "data": {
    "name": "Quiet Room Setup",
    "vad": false,
    "max_buffer": 2,
    "id": "isDefined"
  }
}