Validate Background Sound URL

POST

https://api.vapi.ai/assistant/background-sound/validate

Authentication

AuthorizationBearer

Authenticate server-side requests with a private Vapi API key. Create or copy a key from the Vapi Dashboard and send it in the Authorization header as Bearer <token>. Keep private API keys out of client-side code and public repositories.

Authenticate server-side requests with a private Vapi API key. Create or copy a key from the [Vapi Dashboard](https://dashboard.vapi.ai) and send it in the `Authorization` header as `Bearer <token>`. Keep private API keys out of client-side code and public repositories.

Request

This endpoint expects an object.

urlstringRequired<=1000 characters

This is the background sound URL to validate. The server performs a ranged request and checks that the URL serves a live media file.

Response

validboolean

Whether the URL currently serves a live media file. When false, calls configured with this URL silently play no background sound.

reasonenumOptional

Why validation failed. Only present when valid is false.

statusdoubleOptional

The HTTP status the URL returned, when a response was received.

contentTypestringOptional

The content-type the URL returned, when a response was received.

$	curl -X POST https://api.vapi.ai/assistant/background-sound/validate \
>	-H "Authorization: Bearer <token>" \
>	-H "Content-Type: application/json" \
>	-d '{
>	"url": "https://example.com/my-sound.mp3"
>	}'

1	{
2	"valid": true,
3	"reason": "invalid-url",
4	"status": 1.1,
5	"contentType": "string"
6	}