ian
04/10/2025, 1:26 AMVapi Support Bot
04/10/2025, 1:28 AMcredentialId
when creating a phone number in Vapi. While I can't see exactly where to find the ID in the dashboard interface from your screenshots, I can definitely explain what it is and how to obtain it.
The credentialId
is not the same as your API key. According to the [documentation](https://docs.vapi.ai/api-reference/phone-numbers/create#response.body.telnyx.credentialId), the credentialId
is actually the ID that is returned when you create a BYO SIP Trunk Credential.
To obtain a credentialId
, you need to create a BYO SIP Trunk Credential using the Vapi API. Here's how:
1. Make a POST request to the credential endpoint:
curl
curl -X POST https://api.vapi.ai/credential \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"provider": "byo-sip-trunk",
"name": "My SIP Trunk",
"gateways": [
{
"ip": "your.sip.provider.ip",
"port": 5060,
"inboundEnabled": true,
"outboundEnabled": true
}
],
"outboundAuthenticationPlan": {
"authUsername": "your_outbound_username",
"authPassword": "your_outbound_password",
"sipRegisterPlan": {
"realm": "your.sip.provider.domain",
"username": "your_register_username",
"domain": "your.sip.provider.domain",
"publicIpInContactEnabled": false
}
}
}'
The response will contain the id
which is your `credentialId`:
json
{
"id": "credential_id",
"provider": "byo-sip-trunk",
"name": "My SIP Trunk",
...
}
Once you have this credentialId
, you can use it when creating a phone number:
curl
curl -X POST https://api.vapi.ai/phone-number \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"provider": "byo-phone-number",
"number": "your_phone_number",
"credentialId": "credential_id_from_step_1"
}'
Is there anything else you'd like to know about creating credentials or phone numbers in Vapi?
Sources:Vapi Support Bot
04/10/2025, 1:28 AMVapi Support Bot
04/10/2025, 1:28 AMcredentialId
when creating a phone number in Vapi. While I can't see exactly where to find it in the dashboard interface, I can definitely explain what it is and how it's typically obtained.
The credentialId
is an identifier for authentication credentials used when creating a phone number in Vapi. According to the [documentation](https://docs.vapi.ai/api-reference/phone-numbers/create#response.body.telnyx.credentialId), it's used to configure the number for sending inbound calls to Vapi, making outbound calls, and performing live call updates like transfers and hangups.
Here's what I found about how the credentialId
relates to the API key:
1. The API key is used for authentication when creating credentials in Vapi. When you make API calls to create credentials, you include your API key in the Authorization
header.
2. The credentialId
is generated when you create a credential via the API. According to the information I found, when you create a credential using the /credential
endpoint, the response includes an id
field, which is the credentialId
you need:
json
{
"id": "credential_id",
"provider": "byo-sip-trunk",
"name": "My SIP Trunk",
...
}
3. For Telnyx specifically, you would create a SIP Trunk Credential using a curl command like:
curl -X POST https://api.vapi.ai/credential \
-H "Content-Type: application/json" \
-H "Authorization: Bearer your-vapi-private-api-key" \
-d '{
"provider": "byo-sip-trunk",
"name": "Telnyx Trunk",
"gateways": [
{
"ip": "sip.telnyx.com"
}
]
}'
The response from this API call will contain the credentialId
that you'll need when creating a phone number.
Is there anything else you'd like to know about using credentials in Vapi?
Sources:
- [Documentation on credentialId](https://docs.vapi.ai/api-reference/phone-numbers/create#response.body.telnyx.credentialId)Vapi Support Bot
04/10/2025, 1:28 AMian
04/10/2025, 1:29 AMian
04/10/2025, 1:39 AMVapi Support Bot
04/10/2025, 1:41 AMcredentialId
must indeed be a UUID, as you correctly pointed out.
I've escalated your question to our technical team for clarification on the exact relationship between the API key and the credentialId
, and to address the apparent discrepancy between the documentation (which says the credentialId
can be found in the dashboard) and your experience.
There seems to be some confusion here that I couldn't fully resolve with the information available. The documentation does state that the credentialId
must be a UUID, which is different from the API key format.
While we wait for the team's response, I can confirm that according to our documentation, the credentialId
is obtained when creating a credential via the API, and it is indeed expected to be in UUID format.
Thank you for your patience, and I'll make sure you get a clear answer on this issue.Vapi Support Bot
04/10/2025, 1:41 AMcredentialId
is not the same as your API key, and yes, the API request correctly states that "credentialId must be a UUID."
Let me clarify:
- The API key is what you use to authenticate your requests to the Vapi API
- The credentialId
is a separate UUID that's generated when you create a credential using the /credential
endpoint
According to the [information I found](https://discord.com/channels/1211482211119796234/1211483291191083018/threads/1326262542858850445), the credentialId
must be a UUID. In Vapi, UUIDs are used as unique identifiers for various entities including assistants, organizations, and credentials.
When you create a credential via the API (using your API key for authentication), the response includes an id
field which is the credentialId
you need. This credentialId
is then used when creating a phone number to associate that phone number with the specific credential you created.
The workflow is:
1. Use your API key to authenticate and create a credential
2. Get the credentialId
(UUID) from the response
3. Use that credentialId
when creating a phone number
Is there anything else you'd like me to clarify about how credentials and UUIDs work in Vapi?
Sources:
- [Discord thread about credentialId being a UUID](https://discord.com/channels/1211482211119796234/1211483291191083018/threads/1326262542858850445)
- [Information about UUIDs in Vapi](https://discord.com/channels/1211482211119796234/1211483291191083018/threads/1328923059905630238)
- [Discord thread about creating credentials](https://discord.com/channels/1211482211119796234/1211483291191083018/threads/1341469652366266408)ian
04/10/2025, 1:43 AMVapi Support Bot
04/10/2025, 1:45 AMcredentialId
should be found in the dashboard.vapi.ai/keys page, but you're only seeing the API key there.
Could you tell me what exactly you see when you go to the providers keys page for Telnyx? Are there any identifiers, UUIDs, or other information displayed besides the API key itself? Perhaps there's a specific section for Telnyx credentials or a way to view more details about the credential you've added?
Also, have you tried using the API key itself as the credentialId
despite the error message, or have you contacted Vapi support directly about this discrepancy between the documentation and the actual dashboard?
Sources:
- [API Reference for Phone Numbers Create](https://docs.vapi.ai/api-reference/phone-numbers/create#response.body.telnyx.credentialId)
- [Provider Keys Documentation](https://docs.vapi.ai/customization/provider-keys)Vapi Support Bot
04/10/2025, 1:45 AMcredentialId
from the providers keys page in the dashboard. The documentation does state that "This is the credential you added in dashboard.vapi.ai/keys," but I couldn't find specific information about how to locate or generate the credentialId
from that page.
There seems to be a gap between the documentation and the actual implementation, and we need to get this resolved for you. Our team will investigate whether this is a documentation error or if there's a specific way to access the credentialId
from the dashboard that isn't immediately obvious.
I'll make sure you get a clear answer on this issue. Thank you for bringing this to our attention and for your patience while we sort this out.ian
04/10/2025, 1:46 AMVapi Support Bot
04/10/2025, 1:47 AMcredentialId
should be found at dashboard.vapi.ai/keys, but you're only seeing the API key there.
I've escalated this issue to our technical team for an urgent clarification. They'll need to address:
1. How to properly obtain the credentialId
from the dashboard as mentioned in the documentation
2. Why there's a disconnect between what the docs say and what you're experiencing
3. Whether the UUID requirement is correct and how it relates to what's shown in the dashboard
This appears to be either a documentation error or a UI issue that needs to be fixed. I appreciate you bringing this to our attention and being so clear about the problem - the error message "credentialId must be a UUID" confirms there's definitely something that needs to be addressed on our end.
I'll make sure you get a definitive answer on this. Thank you for your patience while our team investigates this issue.Vapi Support Bot
04/10/2025, 1:48 AMian
04/10/2025, 2:05 AMVapi Support Bot
04/10/2025, 2:06 AM/credential
endpoint in the docs
This appears to be either a documentation error or a UI issue that needs immediate attention. Our team will need to provide a definitive answer on how to properly obtain the credentialId
or fix the documentation if it's incorrect.
I'll follow up as soon as I receive a response from our technical team. Thank you for your patience and for bringing this critical issue to our attention.ian
04/10/2025, 11:08 PMian
04/11/2025, 10:51 AMKyle Brunker
04/11/2025, 3:14 PM