curl -X DELETE https://api.vibepeak.ai/v1/families/3fa85f64-5717-4562-b3fc-2c963f66afa6 \
-H "Authorization: Bearer vpk_live_xxxxx"
const response = await fetch('https://api.vibepeak.ai/v1/families/3fa85f64-5717-4562-b3fc-2c963f66afa6', {
method: 'DELETE',
headers: {
'Authorization': 'Bearer vpk_live_xxxxx'
}
});
console.log(response.status); // 204
import requests
response = requests.delete(
'https://api.vibepeak.ai/v1/families/3fa85f64-5717-4562-b3fc-2c963f66afa6',
headers={
'Authorization': 'Bearer vpk_live_xxxxx'
}
)
print(response.status_code) # 204
(empty body)
{
"error": {
"code": "PLAN_NOT_ALLOWED",
"message": "Families are available on the Pro, Max and Enterprise plans. Upgrade your plan to use this feature.",
"request_id": "req_xyz123"
}
}
{
"error": {
"code": "FAMILY_NOT_FOUND",
"message": "Family not found or not accessible with this API key.",
"request_id": "req_xyz123"
}
}
Families
Delete Family
Delete a family you own
DELETE
/
v1
/
families
/
{familyId}
curl -X DELETE https://api.vibepeak.ai/v1/families/3fa85f64-5717-4562-b3fc-2c963f66afa6 \
-H "Authorization: Bearer vpk_live_xxxxx"
const response = await fetch('https://api.vibepeak.ai/v1/families/3fa85f64-5717-4562-b3fc-2c963f66afa6', {
method: 'DELETE',
headers: {
'Authorization': 'Bearer vpk_live_xxxxx'
}
});
console.log(response.status); // 204
import requests
response = requests.delete(
'https://api.vibepeak.ai/v1/families/3fa85f64-5717-4562-b3fc-2c963f66afa6',
headers={
'Authorization': 'Bearer vpk_live_xxxxx'
}
)
print(response.status_code) # 204
(empty body)
{
"error": {
"code": "PLAN_NOT_ALLOWED",
"message": "Families are available on the Pro, Max and Enterprise plans. Upgrade your plan to use this feature.",
"request_id": "req_xyz123"
}
}
{
"error": {
"code": "FAMILY_NOT_FOUND",
"message": "Family not found or not accessible with this API key.",
"request_id": "req_xyz123"
}
}
Deletes a family you own. Only the family’s owner can delete it: preset families and families shared by your organization but owned by someone else cannot be deleted.
Once deleted, the family stops appearing in List Families and can no longer be used as
See Error Handling for more details.
selected_family_id in new videos. Videos already generated with this family are not affected; their result stays available as-is.
Deleting a family requires a Pro, Max, or Enterprise plan, like all other family write operations.
This endpoint is idempotent: deleting a family that no longer exists returns the same
204 No Content as a successful delete.Path Parameters
string
required
The unique identifier of the family to delete.Example:
3fa85f64-5717-4562-b3fc-2c963f66afa6Response
Returns204 No Content on success, with no response body.
curl -X DELETE https://api.vibepeak.ai/v1/families/3fa85f64-5717-4562-b3fc-2c963f66afa6 \
-H "Authorization: Bearer vpk_live_xxxxx"
const response = await fetch('https://api.vibepeak.ai/v1/families/3fa85f64-5717-4562-b3fc-2c963f66afa6', {
method: 'DELETE',
headers: {
'Authorization': 'Bearer vpk_live_xxxxx'
}
});
console.log(response.status); // 204
import requests
response = requests.delete(
'https://api.vibepeak.ai/v1/families/3fa85f64-5717-4562-b3fc-2c963f66afa6',
headers={
'Authorization': 'Bearer vpk_live_xxxxx'
}
)
print(response.status_code) # 204
(empty body)
{
"error": {
"code": "PLAN_NOT_ALLOWED",
"message": "Families are available on the Pro, Max and Enterprise plans. Upgrade your plan to use this feature.",
"request_id": "req_xyz123"
}
}
{
"error": {
"code": "FAMILY_NOT_FOUND",
"message": "Family not found or not accessible with this API key.",
"request_id": "req_xyz123"
}
}
Error Codes
| Code | Status | Description |
|---|---|---|
FAMILY_NOT_FOUND | 404 | Family doesn’t exist, isn’t yours, or is a preset |
MISSING_API_KEY | 401 | No Authorization header was sent |
INVALID_API_KEY | 401 | The API key is invalid or has been revoked |
PLAN_NOT_ALLOWED | 403 | Your plan doesn’t allow deleting a family (requires Pro, Max, or Enterprise) |