Skip to content

Commit dd03e01

Browse files
authored
Add server credentialId docs (#669)
* custom credential authentication * remove mdc: from non-cursor rule files
1 parent 2b1a094 commit dd03e01

13 files changed

+540
-94
lines changed

fern/calls/assistant-based-warm-transfer.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -323,6 +323,6 @@ Configure your transfer assistant to:
323323
## Next steps
324324

325325
Now that you've configured assistant-based warm transfers:
326-
- **[Call forwarding](mdc:docs/call-forwarding):** Learn about other transfer modes and options
327-
- **[Assistant configuration](mdc:docs/assistants):** Configure assistant models and prompts
328-
- **[Custom tools](mdc:docs/tools/custom-tools):** Add custom tools to your assistants
326+
- **[Call forwarding](../call-forwarding):** Learn about other transfer modes and options
327+
- **[Assistant configuration](../assistants):** Configure assistant models and prompts
328+
- **[Custom tools](../tools/custom-tools):** Add custom tools to your assistants

fern/customization/custom-transcriber.mdx

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -408,9 +408,9 @@ You'll learn how to:
408408
"transcriber": {
409409
"provider": "custom-transcriber",
410410
"server": {
411-
"url": "wss://your-server.ngrok.io/api/custom-transcriber"
412-
},
413-
"secret": "your_optional_secret_value"
411+
"url": "wss://your-server.ngrok.io/api/custom-transcriber",
412+
"credentialId": "cred_transcriber_auth_123"
413+
}
414414
},
415415
"firstMessage": "Hello! I am using a custom transcriber with Deepgram."
416416
},
@@ -438,8 +438,8 @@ You'll learn how to:
438438

439439
- **Streaming support requirement:**
440440
The custom transcriber must support streaming. Vapi sends continuous audio data over the WebSocket, and your server must handle this stream in real time.
441-
- **Secret header:**
442-
The custom transcriber configuration accepts an optional field called **`secret`**. When set, Vapi will send this value with every request as an HTTP header named `x-vapi-secret`. This can also be configured via a headers field.
441+
- **Authentication:**
442+
For secure transcriber endpoints, use **Custom Credentials** with `credentialId`. Create [Custom Credentials](../server-url/server-authentication) in the dashboard to manage Bearer Token, OAuth 2.0, or HMAC authentication. For backward compatibility, the legacy `secret` field is still supported and sends the value as an `x-vapi-secret` HTTP header.
443443
- **Buffering:**
444444
The solution buffers PCM audio and performs simple validation (e.g. ensuring stereo PCM data length is a multiple of 4). If the audio data is malformed, it is trimmed to a valid length.
445445
- **Channel detection:**

fern/customization/custom-tts.mdx

Lines changed: 11 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -53,30 +53,34 @@ VAPI's custom TTS system operates through a webhook pattern:
5353

5454
## Authentication setup
5555

56-
VAPI needs secure communication with your TTS endpoint. Choose from these authentication options:
56+
VAPI needs secure communication with your TTS endpoint. Use **Custom Credentials** for authentication:
5757

58-
### Secret header authentication
58+
### Using Custom Credentials (Recommended)
5959

60-
The most common approach uses a secret token in the `X-VAPI-SECRET` header:
60+
Create authentication credentials in the dashboard and reference them by ID:
6161

6262
<CodeBlocks>
63-
```json title="Assistant Configuration"
63+
```json title="Assistant Configuration with Custom Credentials"
6464
{
6565
"voice": {
6666
"provider": "custom-voice",
6767
"server": {
6868
"url": "https://your-tts-api.com/synthesize",
69-
"secret": "your-secret-token-here",
69+
"credentialId": "cred_tts_auth_123",
7070
"timeoutSeconds": 30
7171
}
7272
}
7373
}
7474
```
7575
</CodeBlocks>
7676

77-
### Enhanced authentication with custom headers
77+
<Note>
78+
Create [Custom Credentials](../server-url/server-authentication) in the Vapi dashboard for better security and credential management.
79+
</Note>
80+
81+
### Legacy Authentication Methods
7882

79-
Add extra headers for API versioning or enhanced security:
83+
For backward compatibility, you can still use inline authentication:
8084

8185
<CodeBlocks>
8286
```json title="Assistant Configuration with Custom Headers"

0 commit comments

Comments
 (0)