Skip to main content

​
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

MethodEndpointDescription
POST/v1/real-estate/narrated-slideshowCreate a real estate slideshow video

​
Tasks

MethodEndpointDescription
GET/v1/tasks/{taskId}Get task status and results

​
System

MethodEndpointDescription
GET/healthCheck 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": [...]}'

​
Need Help?