Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.vibepeak.ai/llms.txt

Use this file to discover all available pages before exploring further.

​
Prerequisites

Before you begin, make sure you have:
1

A VibePeak account

Sign up at app.vibepeak.ai if you haven’t already.
2

A Plus, Pro, or Max plan

API access is not available on the Free or Starter plans. Upgrade your plan to get started.
3

An API key

Generate an API key from your API settings.

​
Step 1: Get your API Key

Navigate to your API settings and create a new API key.
Your API key will only be shown once. Store it securely and never commit it to version control.
Your API key will look like this: 
vpk_live_aBcDeFgHiJkLmNoPqRsTuVwXyZ123456
Want to build and test your integration for free? Create a sandbox key (vpk_test_…) from the same dashboard instead of (or in addition to) a live key. Sandbox keys exercise the identical request, validation, async lifecycle, and signed-webhook surface as live keys, but spend zero credits and return a watermarked sample video. See Test Mode for the full sandbox workflow.

​
Step 2: Create your first video

Use the following command to create a slideshow video. Replace vpk_live_xxxxx with your actual API key — or vpk_test_xxxxx to run the same request for free against the sandbox. 
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://images.unsplash.com/photo-1600596542815-ffad4c1539a9?w=1200",
      "https://images.unsplash.com/photo-1600607687939-ce8a6c25118c?w=1200",
      "https://images.unsplash.com/photo-1600566753086-00f18fb6b3ea?w=1200",
      "https://images.unsplash.com/photo-1600585154340-be6161a56a0c?w=1200",
      "https://images.unsplash.com/photo-1600573472592-401b489a3cdc?w=1200",
      "https://images.unsplash.com/photo-1600047509807-ba8f99d2cdde?w=1200"
    ]
  }'
You’ll receive a response like: 
{
  "task_id": "task_abc123xyz",
  "status": "queued",
  "queue_position": 1,
  "estimated_completion": "2026-01-04T12:30:00Z",
  "created_at": "2026-01-04T12:00:00Z"
}

​
Step 3: Check task status

Video generation takes a few minutes. You can poll the task status: 
curl https://api.vibepeak.ai/v1/tasks/task_abc123xyz \
  -H "Authorization: Bearer vpk_live_xxxxx"
When the task is complete, you’ll receive: 
{
  "task_id": "task_abc123xyz",
  "status": "completed",
  "result": {
    "video_url": "https://storage.vibepeak.ai/videos/task_abc123xyz.mp4",
    "duration_seconds": 45,
    "resolution": "1080p",
    "expires_at": "2026-01-11T12:15:00Z"
  }
}

​
Step 4: Download your video

The video_url in the result is a direct download link. The URL is valid for 7 days.
For production use, we recommend setting up webhooks instead of polling. You’ll be notified as soon as your video is ready.

​
Next steps

Configure webhooks

Get notified when videos are ready

Customize videos

Explore all video options

Handle errors

Build robust integrations

Rate limits

Understand usage limits