For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Contact us
DocumentationAPI Reference
DocumentationAPI Reference
  • Authentication
    • GETVerify API key
  • Documents
    • POSTUpload document
    • POSTUpload document into folder
    • GETList documents
    • GETList documents in folder
    • GETGet document
    • POSTCreate folder
    • DELDelete folder
    • POSTMove documents between folders
    • DELDelete documents
  • Workspaces
    • GETGet workspace
    • DELDelete workspace
    • POSTUpdate workspace
    • POSTAdd or remove workspace embeddings
    • GETList workspace tools
    • POSTAttach tool to workspace
    • DELDetach tool from workspace
  • Number Requests
    • GETList number requests
    • POSTRequest a phone number
    • GETGet number request
  • Numbers
    • GETList phone numbers
    • GETList phone numbers in organization
  • Organizations
    • GETList organizations
    • POSTCreate organization
    • GETGet organization
    • DELDelete organization
    • POSTUpdate organization
    • GETList workspaces in organization
    • POSTCreate workspace
    • GETList organization tools
    • POSTCreate organization tool
    • DELDelete organization tool
    • PATCHUpdate organization tool
  • Accounts
    • GETList accounts
    • POSTCreate account
  • Voice Integration
    • GETGet voice assistant config
    • PATCHUpdate voice assistant config
    • GETGet voice integration catalog
    • POSTProvision voice integration
    • GETList voice call logs
    • GETList workspace voice call logs
  • Whats App Integration
    • POSTMint a WhatsApp Business connect page token
    • GETRender WhatsApp Business connect iframe page
    • POSTFinalize WhatsApp Business onboarding (iframe-initiated)
    • DELDisconnect WhatsApp Business integration
Contact us
LogoLogo
Voice Integration

Get voice assistant config

GET
https://staging-app.lumenia.net/api/v1/workspace/:slug/voice-integration/assistant
GET
/api/v1/workspace/:slug/voice-integration/assistant
$curl https://staging-app.lumenia.net/api/v1/workspace/slug/voice-integration/assistant \
> -H "X-Account-Id: X-Account-Id" \
> -H "Authorization: Bearer <token>"
1{
2 "success": true,
3 "assistant": {
4 "model": {
5 "firstMessage": "Hello! How can I help you today?",
6 "prompt": "You are a friendly phone assistant…"
7 },
8 "voice": {
9 "provider": "vapi",
10 "voiceId": "Clara",
11 "model": null
12 },
13 "fallbackVoices": [],
14 "transcriber": {
15 "provider": "deepgram",
16 "language": "en",
17 "model": "flux-general-en"
18 },
19 "fallbackTranscribers": [],
20 "tools": []
21 }
22}

Get the voice assistant configuration (model prompt, voice, transcriber, tools) for a workspace. Requires a voice integration to exist for that workspace.

Was this page helpful?
Previous

Update voice assistant config

Next
Built with

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

slugstringRequired
Workspace slug

Headers

X-Account-IdstringRequired
Account uuid context. Must belong to the API key's partner. Routes that target an org additionally require the org to belong to this account.

Response

Assistant config with tools
successboolean
assistantobject

Client assistant shape: model, voice, transcriber, fallback lists, tools

Errors

400
Bad Request Error
403
Forbidden Error
404
Not Found Error
500
Internal Server Error