Get workspace voice integration

GET

https://app.lumenia.net/api/v1/workspaces/:workspaceId/integrations/voice

GET

/api/v1/workspaces/:workspaceId/integrations/voice

$ curl https://app.lumenia.net/api/v1/workspaces/workspaceId/integrations/voice \
>      -H "X-Account-Id: X-Account-Id" \
>      -H "Authorization: Bearer <API_KEY>"

1 {
2   "voice": {
3     "connected": true,
4     "promptSource": "template",
5     "promptTemplate": {
6       "status": "published",
7       "templateId": "a1b2c3d4-5e6f-4a0b-8c1d-2e3f4a5b6c7d",
8       "templateName": "Dental clinic receptionist",
9       "variables": {
10         "company": "Acme Dental"
11       },
12       "version": 3,
13       "versionId": "d4e5f6a7-8091-4c3d-ae4f-5a6b7c8d9e0f"
14     },
15     "firstMessage": "Hello! How can I help you today?",
16     "prompt": "You are a friendly phone assistant…",
17     "voice": {
18       "provider": "vapi",
19       "voiceId": "Clara",
20       "model": null
21     },
22     "fallbackVoices": [],
23     "transcriber": {
24       "provider": "deepgram",
25       "model": "flux-general-en",
26       "language": "en"
27     },
28     "fallbackTranscribers": [],
29     "phoneNumber": "+14155551234"
30   }
31 }

Return a workspace voice integration.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <API_KEY>, where API_KEY is your API key.

Path parameters

workspaceIdstringRequired

Workspace whose voice integration to return.

Query parameters

includeRenderedbooleanOptional

Include rendered prompt text and first message in the template assignment.

Response

The workspace voice integration.

voiceobject

Voice integration settings. Returns { connected: false } when no integration is configured. Sensitive credentials are not returned.

Errors

403

Forbidden Error

404

Not Found Error

500

Internal Server Error

Authentication

Path parameters

Headers

Query parameters

Response

Errors