# VibePeak API Documentation

> VibePeak API enables programmatic creation of AI-powered real estate videos with virtual staging and text-to-speech narration.

## Documentation

- [Getting Started](https://docs.vibepeak.ai/): Overview of the VibePeak API
- [Quickstart](https://docs.vibepeak.ai/quickstart): Create your first video in 5 minutes
- [Authentication](https://docs.vibepeak.ai/authentication): API key authentication guide

## API Reference

- [Create Living Property Video](https://docs.vibepeak.ai/api-reference/videos/create-living-property): POST /v1/real-estate/living-property - Create AI-powered videos with virtual staging, optionally as a Story Mode day-in-the-life told through a family cast
- [Create Narrated Slideshow](https://docs.vibepeak.ai/api-reference/videos/create-narrated-slideshow): POST /v1/real-estate/narrated-slideshow - Create slideshow videos with narration
- [Create Land Transformation](https://docs.vibepeak.ai/api-reference/videos/create-land): POST /v1/land - Create cinematic land transformation videos from a single photo
- [Create Property Showcase](https://docs.vibepeak.ai/api-reference/images/create-property-showcase): POST /v1/real-estate/property-showcase - Generate a branded property showcase image from a template, including four brand layouts that take a brand_profile_id and a 9:16 or 16:9 aspect_ratio, and the custom template that reproduces a reference design of your own
- [Edit Property Showcase](https://docs.vibepeak.ai/api-reference/images/edit-property-showcase): POST /v1/real-estate/property-showcase/edit - Edit an existing property showcase image with a prompt and style overrides
- [Showcase Templates](https://docs.vibepeak.ai/api-reference/images/property-showcase-templates): Visual reference for every property showcase template and brand layout - preview, aspect ratio, accepted fields, supporting images and the eleven brand profiles
- [Custom Templates](https://docs.vibepeak.ai/api-reference/images/custom-templates): POST, GET, GET by id, PATCH and DELETE /v1/real-estate/property-showcase/custom-templates - Register a reference design of your own as a showcase template, then list, read, correct and archive it; requires a Pro, Max or Enterprise plan and allows at most 10 active templates per account
- [Get Task Status](https://docs.vibepeak.ai/api-reference/videos/get-task): GET /v1/tasks/:taskId - Check video generation progress
- [Intro & Outro Templates](https://docs.vibepeak.ai/api-reference/videos/intro-outro-templates): Visual reference for every intro and outro overlay - preview, id, accepted fields, default animation and the colours each design ships with
- [List Intro & Outro Templates](https://docs.vibepeak.ai/api-reference/videos/list-intro-outro-templates): GET /v1/intro-outro/templates - Read the overlay catalogue and animation presets as JSON
- [Preset Families](https://docs.vibepeak.ai/api-reference/families/preset-families): Visual gallery of every ready-made family with its slug
- [List Families](https://docs.vibepeak.ai/api-reference/families/list-families): GET /v1/families - Browse preset and custom families
- [Create Family](https://docs.vibepeak.ai/api-reference/families/create-family): POST /v1/families - Create a custom family with AI-generated avatars
- [Get Family](https://docs.vibepeak.ai/api-reference/families/get-family): GET /v1/families/:idOrSlug - Check a family's generation status
- [Delete Family](https://docs.vibepeak.ai/api-reference/families/delete-family): DELETE /v1/families/:familyId - Delete a family you own
- [Add Family Member](https://docs.vibepeak.ai/api-reference/families/add-family-member): POST /v1/families/:familyId/members - Add a new member to a family
- [Update Family Member](https://docs.vibepeak.ai/api-reference/families/update-family-member): PATCH /v1/families/:familyId/members/:index - Update a member's descriptors and regenerate their portrait
- [Regenerate Family Member Portrait](https://docs.vibepeak.ai/api-reference/families/regenerate-family-member): POST /v1/families/:familyId/members/:index/regenerate - Regenerate a member's portrait
- [Remove Family Member](https://docs.vibepeak.ai/api-reference/families/remove-family-member): DELETE /v1/families/:familyId/members/:index - Remove a member from a family

## Core Concepts

- [Async Processing](https://docs.vibepeak.ai/concepts/async-processing): How video generation works asynchronously
- [Test Mode](https://docs.vibepeak.ai/concepts/test-mode): Free sandbox with vpk_test_ keys, test_scenario, and the livemode field
- [Webhooks](https://docs.vibepeak.ai/concepts/webhooks): Get notified when videos are ready
- [Rate Limits](https://docs.vibepeak.ai/concepts/rate-limits): Concurrent task limits by plan
- [Error Handling](https://docs.vibepeak.ai/concepts/error-handling): Error codes and handling strategies
- [Families](https://docs.vibepeak.ai/concepts/families): Reusable, consistent casts of people for real estate videos

## Key Features

- Virtual staging: Add people, furniture, or redecorate rooms
- AI narration: Custom scripts with professional text-to-speech
- Webhook notifications: Real-time completion alerts
- Families: Reusable AI-generated casts for a consistent look across every scene
- Story Mode: One continuous day-in-the-life story with AI-chosen scene order and lighting from morning to night

## Plans

- Plus: 1 concurrent task
- Pro: 3 concurrent tasks
- Max: 5 concurrent tasks
- Enterprise: custom concurrent tasks

## Support

- Email: api-support@vibepeak.ai
- Status: https://vibepeak.statuspage.io/