Get Default Configurations

GET /api/v1/user/configurations/defaults — request parameters and responses from the Menace Voice API schema.

1 min read

get/api/v1/user/configurations/defaults

Request example

curl --request GET \
  --url https://voice.menaceui.com/api/v1/user/configurations/defaults

Response

{
  "llm": {},
  "tts": {},
  "stt": {},
  "embeddings": {},
  "realtime": {},
  "default_providers": {},
  "workflow_configurations": {
    "agent_setup": {
      "agent_brief": "<string>",
      "tone": "<string>",
      "language": "<string>",
      "voice_provider": "<string>",
      "voice_name": "<string>",
      "behavior_notes": "<string>",
      "workflow_stages": [
        "<string>"
      ],
      "agent_name": "<string>",
      "use_case": "<string>",
      "call_type": "inbound"
    },
    "voice_clone_id": "<string>",
    "ambient_noise_configuration": {
      "enabled": false,
      "volume": 0.3
    },
    "max_call_duration": 300,
    "max_user_idle_timeout": 10,
    "smart_turn_stop_secs": 2,
    "turn_start_strategy": "default",
    "turn_start_min_words": 3,
    "provisional_vad_pause_secs": 1.5,
    "turn_stop_strategy": "transcription",
    "dictionary": "",
    "context_compaction_enabled": false,
    "call_dispositions": [
      {
        "code": "<string>",
        "description": "<string>"
      }
    ],
    "text_chat_inactivity_timeout_seconds": 1800,
    "external_pbx_field_mappings": [
      {
        "context_path": "<string>",
        "destination_field": "<string>"
      }
    ],
    "external_pbx_lead_headers": [
      "<string>"
    ]
  },
  "default_call_dispositions": [
    {
      "code": "<string>",
      "description": "<string>"
    }
  ],
  "text_chat_inactivity_timeout_constraints": {
    "default_seconds": 1800,
    "minimum_seconds": 60,
    "maximum_seconds": 10500
  },
  "widget_text_defaults": {
    "endChatText": "End chat",
    "conversationEndedText": "Conversation ended.",
    "startNewChatText": "Start new chat",
    "chatRetryText": "Retry",
    "chatInputPlaceholder": "Type a message…",
    "sendMessageLabel": "Send message",
    "closeChatLabel": "Close chat",
    "voiceConnectingText": "Connecting…",
    "voiceEndCallText": "End Call",
    "voiceRetryText": "Retry",
    "voiceReadyTitle": "Ready to Connect",
    "voiceConnectingSubtext": "Please wait while we establish the connection",
    "voiceConnectedTitle": "Connected",
    "voiceConnectedSubtext": "Your voice call is now active",
    "voiceCallEndedTitle": "Call ended",
    "voiceCallEndedSubtext": "Click below to start a new call",
    "voiceConnectionFailedTitle": "Connection failed",
    "voiceConnectionFailedSubtext": "Please check your microphone and try again",
    "voiceConnectionLostTitle": "Connection lost",
    "voiceConnectionLostSubtext": "The call has been disconnected"
  }
}

get/api/v1/user/configurations/defaults

See authentication for workspace API access. Public embed and artifact endpoints use their documented session or access tokens.

Responses

application/json

Successful Response

llmobjectrequired#

Show child attributes

{key}object#

ttsobjectrequired#

Show child attributes

{key}object#

sttobjectrequired#

Show child attributes

{key}object#

embeddingsobjectrequired#

Show child attributes

{key}object#

realtimeobjectrequired#

Show child attributes

{key}object#

default_providersobjectrequired#

Show child attributes

{key}string#

workflow_configurationsobjectrequired#

Show child attributes

agent_setupobject · null#

Show child attributes

Any of

agent_briefstringrequired#

Length: 1–8000

tonestringrequired#

Length: 1–100

languagestringrequired#

Length: 1–100

voice_providerstringrequired#

Length: 1–100

voice_namestringrequired#

Length: 1–255

behavior_notesstring · null#

Show child attributes

workflow_stagesstring[]#

Optional template hints; the planner chooses the stages from the brief.

Items: max 8

agent_namestringrequired#

Length: 1–255

use_casestringrequired#

Length: 1–2000

call_typeenum<string>required#

Options:inboundoutbound

voice_clone_idstring · null#

Show child attributes

Any of

ambient_noise_configurationobject#

Show child attributes

enabledboolean#

Default: false

volumenumber#

Default: 0.3

max_call_durationinteger#

Default: 300

Range: 0 < x <= 1200

max_user_idle_timeoutnumber#

Default: 10

smart_turn_stop_secsnumber#

Default: 2

turn_start_strategyenum<string>#

Default: "default"

Options:defaultmin_wordsprovisional_vad

turn_start_min_wordsinteger#

Default: 3

provisional_vad_pause_secsnumber#

Default: 1.5

turn_stop_strategyenum<string>#

Default: "transcription"

Options:transcriptionturn_analyzer

dictionarystring#

Default: ""

context_compaction_enabledboolean#

Default: false

call_dispositionsobject[]#

Allowed business outcomes for terminal call classification. Each entry defines the exact stored code and the criteria for selecting it.

Items: max 50

Show child attributes

codestringrequired#

Stable code recorded when this outcome is selected.

Length: 1–64Pattern: ^[A-Za-z][A-Za-z0-9_-]*$

descriptionstringrequired#

Business criteria for selecting this disposition.

Length: 1–1000

text_chat_inactivity_timeout_secondsinteger#

Default: 1800

Range: 60–10500

external_pbx_field_mappingsobject[]#

Items: max 100

Show child attributes

context_pathstringrequired#

Length: 1–255

destination_fieldstringrequired#

Pattern: ^[A-Za-z][A-Za-z0-9_]{0,63}$

external_pbx_lead_headersstring[]#

Items: max 50

default_call_dispositionsobject[]required#

Built-in suggestions for call-disposition extraction. They do not enable extraction until saved in workflow_configurations.call_dispositions.

Show child attributes

codestringrequired#

Stable code recorded when this outcome is selected.

Length: 1–64Pattern: ^[A-Za-z][A-Za-z0-9_-]*$

descriptionstringrequired#

Business criteria for selecting this disposition.

Length: 1–1000

text_chat_inactivity_timeout_constraintsobjectrequired#

Backend-owned timeout metadata consumed by generated API clients.

Show child attributes

default_secondsinteger#

Default: 1800

minimum_secondsinteger#

Default: 60

maximum_secondsinteger#

Default: 10500

widget_text_defaultsobjectrequired#

Every visitor-facing string the embed widget can render.

Show child attributes

endChatTextstring#

Default: "End chat"

conversationEndedTextstring#

Default: "Conversation ended."

startNewChatTextstring#

Default: "Start new chat"

chatRetryTextstring#

Default: "Retry"

chatInputPlaceholderstring#

Default: "Type a message…"

sendMessageLabelstring#

Default: "Send message"

closeChatLabelstring#

Default: "Close chat"

voiceConnectingTextstring#

Default: "Connecting…"

voiceEndCallTextstring#

Default: "End Call"

voiceRetryTextstring#

Default: "Retry"

voiceReadyTitlestring#

Default: "Ready to Connect"

voiceConnectingSubtextstring#

Default: "Please wait while we establish the connection"

voiceConnectedTitlestring#

Default: "Connected"

voiceConnectedSubtextstring#

Default: "Your voice call is now active"

voiceCallEndedTitlestring#

Default: "Call ended"

voiceCallEndedSubtextstring#

Default: "Click below to start a new call"

voiceConnectionFailedTitlestring#

Default: "Connection failed"

voiceConnectionFailedSubtextstring#

Default: "Please check your microphone and try again"

voiceConnectionLostTitlestring#

Default: "Connection lost"

voiceConnectionLostSubtextstring#

Default: "The call has been disconnected"

Get Turn Credentials Get Auth User