Create workspace voice integration

POST

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

POST

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

$ curl -X POST https://app.lumenia.net/api/v1/workspaces/workspaceId/integrations/voice \
>      -H "X-Account-Id: X-Account-Id" \
>      -H "Authorization: Bearer <API_KEY>" \
>      -H "Content-Type: application/json" \
>      -d '{
>   "firstMessage": "Hello! How can I help you today?",
>   "prompt": "You are a friendly phone assistant for Acme Plumbing. Keep responses concise and helpful. Offer to book an appointment when the caller describes a problem.",
>   "voice": {
>     "provider": "vapi",
>     "voiceId": "Clara",
>     "model": null
>   },
>   "fallbackVoices": [],
>   "transcriber": {
>     "provider": "deepgram",
>     "model": "flux-general-en",
>     "language": "en"
>   },
>   "fallbackTranscribers": []
> }'

1 {
2   "voice": {
3     "connected": true,
4     "promptSource": "manual",
5     "promptTemplate": null,
6     "firstMessage": "Hello! How can I help you today?",
7     "prompt": "You are a friendly phone assistant. Keep responses concise and helpful.",
8     "voice": {
9       "model": null,
10       "provider": "vapi",
11       "voiceId": "Clara"
12     },
13     "fallbackVoices": [],
14     "transcriber": {
15       "language": "en",
16       "model": "flux-general-en",
17       "provider": "deepgram"
18     },
19     "fallbackTranscribers": [],
20     "phoneNumber": "+14155551234"
21   }
22 }

Create a voice integration for a workspace.

Authentication

AuthorizationBearer

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

Path parameters

workspaceIdstringRequired

Workspace to configure.

Request

Voice settings. Omitted fields use defaults. Use the options endpoint for supported values.

firstMessagestringOptional

The greeting the assistant speaks first.

promptstringOptional

System prompt for the live voice conversation.

voiceobjectOptional

The text-to-speech voice. Values must match the options catalog.

fallbackVoiceslist of objectsOptional

Ordered fallback voices used if the primary voice fails. Each entry needs a provider.

transcriberobjectOptional

The speech-to-text transcriber. Values must match the options catalog.

fallbackTranscriberslist of objectsOptional

Ordered fallback transcribers. Each entry needs a provider.

Response

The created voice integration, including its routing number.

voiceobject

The new assistant config — see GET …/integrations/voice for the field notes.

Errors

400

Bad Request Error

403

Forbidden Error

404

Not Found Error

409

Conflict Error

500

Internal Server Error

Authentication

Path parameters

Headers

Request

Response

Errors