VibePeak Public API

The VibePeak API provides programmatic access to our AI-powered real estate video generation platform. Create professional property slideshow videos with AI-enhanced imagery and text-to-speech narration.

Base URL

All API requests should be made to:

https://api.vibepeak.ai

API Version

The current API version is v1. All endpoints are prefixed with /v1/.

Request Format

The API accepts JSON-encoded request bodies and returns JSON-encoded responses. All requests must include the Content-Type: application/json header.

curl -X POST https://api.vibepeak.ai/v1/real-estate/narrated-slideshow \
  -H "Authorization: Bearer vpk_live_xxxxx" \
  -H "Content-Type: application/json" \
  -d '{"images": ["https://example.com/image1.jpg", ...]}'

Response Format

All responses follow a consistent format:

Success Responses

{
  "task_id": "task_abc123xyz",
  "status": "queued",
  "created_at": "2026-01-04T12:00:00Z"
}

Error Responses

{
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Human-readable error description",
    "request_id": "req_xyz123",
    "details": {}
  }
}

Core Concepts

Async Processing

Video generation is asynchronous. Submit a request and poll for results.

Webhooks

Receive notifications when your videos are ready.

Rate Limits

Understand concurrent task limits per subscription plan.

Error Handling

Handle errors gracefully with machine-readable error codes.

Available Endpoints

Videos

Method	Endpoint	Description
POST	`/v1/real-estate/narrated-slideshow`	Create a real estate slideshow video
POST	`/v1/real-estate/living-property`	Create a living property video with virtual staging

Families

Method	Endpoint	Description
GET	`/v1/families`	List preset and custom families
POST	`/v1/families`	Create a custom family with AI-generated avatars
GET	`/v1/families/{idOrSlug}`	Get a family’s details and generation status
DELETE	`/v1/families/{familyId}`	Delete a family you own
POST	`/v1/families/{familyId}/members`	Add a new member to a family
PATCH	`/v1/families/{familyId}/members/{index}`	Update a member’s descriptors and regenerate their portrait
POST	`/v1/families/{familyId}/members/{index}/regenerate`	Regenerate a member’s portrait
DELETE	`/v1/families/{familyId}/members/{index}`	Remove a member from a family

Tasks

Method	Endpoint	Description
GET	`/v1/tasks/{taskId}`	Get task status and results

System

Method	Endpoint	Description
GET	`/health`	Check API health (no auth required)

SDKs and Libraries

Official SDKs are coming soon. In the meantime, you can use any HTTP client to interact with the API:

curl -X POST https://api.vibepeak.ai/v1/real-estate/narrated-slideshow \
  -H "Authorization: Bearer $VIBEPEAK_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"images": [...]}'

const response = await fetch('https://api.vibepeak.ai/v1/real-estate/narrated-slideshow', {
  method: 'POST',
  headers: {
    'Authorization': `Bearer ${process.env.VIBEPEAK_API_KEY}`,
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({ images: [...] })
});

import requests

response = requests.post(
    'https://api.vibepeak.ai/v1/real-estate/narrated-slideshow',
    headers={
        'Authorization': f'Bearer {api_key}',
        'Content-Type': 'application/json'
    },
    json={'images': [...]}
)

Need Help?

Email: [email protected]
Documentation: You’re here!
Status Page: vibepeak.statuspage.io

Overview

Avatars

Voices

Videos

Families

Images

API Introduction

VibePeak Public API

Base URL

API Version

Request Format

Response Format

Success Responses

Error Responses

Core Concepts

Async Processing

Webhooks

Rate Limits

Error Handling

Available Endpoints

Videos

Families

Tasks

System

SDKs and Libraries

Need Help?

​VibePeak Public API

​Base URL

​API Version

​Request Format

​Response Format

​Success Responses

​Error Responses

​Core Concepts

Async Processing

Webhooks

Rate Limits

Error Handling

​Available Endpoints

​Videos

​Families

​Tasks

​System

​SDKs and Libraries

​Need Help?

VibePeak Public API

Base URL

API Version

Request Format

Response Format

Success Responses

Error Responses

Core Concepts

Available Endpoints

Videos

Families

Tasks

System

SDKs and Libraries

Need Help?