Get Task Status

curl https://api.vibepeak.ai/v1/tasks/task_abc123xyz \
  -H "Authorization: Bearer vpk_live_xxxxx"

const response = await fetch('https://api.vibepeak.ai/v1/tasks/task_abc123xyz', {
  headers: {
    'Authorization': 'Bearer vpk_live_xxxxx'
  }
});

const task = await response.json();
console.log(`Status: ${task.status}`);

if (task.status === 'completed') {
  console.log(`Video URL: ${task.result.video_url}`);
  console.log(`Cover Image: ${task.result.cover_image_url}`);
}

import requests

response = requests.get(
    'https://api.vibepeak.ai/v1/tasks/task_abc123xyz',
    headers={
        'Authorization': 'Bearer vpk_live_xxxxx'
    }
)

task = response.json()
print(f"Status: {task['status']}")

if task['status'] == 'completed':
    print(f"Video URL: {task['result']['video_url']}")
    print(f"Cover Image: {task['result']['cover_image_url']}")

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

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

{
  "task_id": "task_abc123xyz",
  "status": "completed",
  "created_at": "2026-01-04T12:00:00Z",
  "started_at": "2026-01-04T12:05:00Z",
  "completed_at": "2026-01-04T12:15:00Z",
  "livemode": true,
  "result": {
    "video_url": "https://storage.vibepeak.ai/videos/task_abc123xyz.mp4",
    "cover_image_url": "https://storage.googleapis.com/vibepeak-audio/covers/task_abc123xyz.jpg",
    "duration_seconds": 45,
    "resolution": "1080p",
    "expires_at": "2026-01-11T12:15:00Z"
  }
}

{
  "task_id": "task_abc123xyz",
  "status": "completed",
  "created_at": "2026-01-04T12:00:00Z",
  "started_at": "2026-01-04T12:00:05Z",
  "completed_at": "2026-01-04T12:00:05Z",
  "livemode": false,
  "result": {
    "video_url": "https://storage.vibepeak.ai/samples/sample-landscape.mp4",
    "cover_image_url": "https://storage.vibepeak.ai/samples/sample-cover.jpg",
    "duration_seconds": 12,
    "total_scenes": 3
  }
}

{
  "task_id": "task_abc123xyz",
  "status": "failed",
  "created_at": "2026-01-04T12:00:00Z",
  "started_at": "2026-01-04T12:05:00Z",
  "completed_at": "2026-01-04T12:06:00Z",
  "error": {
    "code": "IMAGE_PROCESSING_FAILED",
    "message": "Failed to process image at index 2: Invalid image format"
  }
}

{
  "error": {
    "code": "TASK_NOT_FOUND",
    "message": "Task not found.",
    "request_id": "req_xyz123"
  }
}

GET

tasks

{taskId}

curl https://api.vibepeak.ai/v1/tasks/task_abc123xyz \
  -H "Authorization: Bearer vpk_live_xxxxx"

const response = await fetch('https://api.vibepeak.ai/v1/tasks/task_abc123xyz', {
  headers: {
    'Authorization': 'Bearer vpk_live_xxxxx'
  }
});

const task = await response.json();
console.log(`Status: ${task.status}`);

if (task.status === 'completed') {
  console.log(`Video URL: ${task.result.video_url}`);
  console.log(`Cover Image: ${task.result.cover_image_url}`);
}

import requests

response = requests.get(
    'https://api.vibepeak.ai/v1/tasks/task_abc123xyz',
    headers={
        'Authorization': 'Bearer vpk_live_xxxxx'
    }
)

task = response.json()
print(f"Status: {task['status']}")

if task['status'] == 'completed':
    print(f"Video URL: {task['result']['video_url']}")
    print(f"Cover Image: {task['result']['cover_image_url']}")

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

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

{
  "task_id": "task_abc123xyz",
  "status": "completed",
  "created_at": "2026-01-04T12:00:00Z",
  "started_at": "2026-01-04T12:05:00Z",
  "completed_at": "2026-01-04T12:15:00Z",
  "livemode": true,
  "result": {
    "video_url": "https://storage.vibepeak.ai/videos/task_abc123xyz.mp4",
    "cover_image_url": "https://storage.googleapis.com/vibepeak-audio/covers/task_abc123xyz.jpg",
    "duration_seconds": 45,
    "resolution": "1080p",
    "expires_at": "2026-01-11T12:15:00Z"
  }
}

{
  "task_id": "task_abc123xyz",
  "status": "completed",
  "created_at": "2026-01-04T12:00:00Z",
  "started_at": "2026-01-04T12:00:05Z",
  "completed_at": "2026-01-04T12:00:05Z",
  "livemode": false,
  "result": {
    "video_url": "https://storage.vibepeak.ai/samples/sample-landscape.mp4",
    "cover_image_url": "https://storage.vibepeak.ai/samples/sample-cover.jpg",
    "duration_seconds": 12,
    "total_scenes": 3
  }
}

{
  "task_id": "task_abc123xyz",
  "status": "failed",
  "created_at": "2026-01-04T12:00:00Z",
  "started_at": "2026-01-04T12:05:00Z",
  "completed_at": "2026-01-04T12:06:00Z",
  "error": {
    "code": "IMAGE_PROCESSING_FAILED",
    "message": "Failed to process image at index 2: Invalid image format"
  }
}

{
  "error": {
    "code": "TASK_NOT_FOUND",
    "message": "Task not found.",
    "request_id": "req_xyz123"
  }
}

Retrieves the current status of a video generation task. Poll this endpoint to check when your video is ready.

Path Parameters

taskId

string

required

The unique identifier of the task, returned when creating a slideshow.Example: task_abc123xyz

Response

The response varies based on the task status:

Common Fields

task_id

string

required

Unique identifier for the task.

status

string

required

Current task status: queued, processing, completed, or failed.

created_at

string

required

Task creation timestamp (ISO 8601 format).

livemode

boolean

required

true for tasks created with a live (vpk_live_) key; false for test-mode (vpk_test_) sandbox tasks.

Test and live tasks are isolated: a vpk_test_ key can only read test tasks and a vpk_live_ key can only read live tasks. Reading a task created with the other key type returns the same 404 TASK_NOT_FOUND as a missing task. See Test Mode.

Queued Status

queue_position

integer

Position in the processing queue.

estimated_completion

string

Estimated completion time (ISO 8601 format).

Processing Status

started_at

string

When processing began (ISO 8601 format).

Completed Status

completed_at

string

When processing finished (ISO 8601 format).

result

object

The video generation result.

Show Result properties

result.video_url

string

URL to download the generated video.

result.cover_image_url

string

URL to the cover image (first frame of the video). Use this as a thumbnail or preview for the video.

result.duration_seconds

integer

Video duration in seconds.

result.resolution

string

Video resolution (e.g., “1080p”).

result.expires_at

string

When the video URL expires (ISO 8601 format). URLs expire after 7 days.

Failed Status

error

object

Error details when the task failed.

Show Error properties

error.code

string

Machine-readable error code.

error.message

string

Human-readable error description.

curl https://api.vibepeak.ai/v1/tasks/task_abc123xyz \
  -H "Authorization: Bearer vpk_live_xxxxx"

const response = await fetch('https://api.vibepeak.ai/v1/tasks/task_abc123xyz', {
  headers: {
    'Authorization': 'Bearer vpk_live_xxxxx'
  }
});

const task = await response.json();
console.log(`Status: ${task.status}`);

if (task.status === 'completed') {
  console.log(`Video URL: ${task.result.video_url}`);
  console.log(`Cover Image: ${task.result.cover_image_url}`);
}

import requests

response = requests.get(
    'https://api.vibepeak.ai/v1/tasks/task_abc123xyz',
    headers={
        'Authorization': 'Bearer vpk_live_xxxxx'
    }
)

task = response.json()
print(f"Status: {task['status']}")

if task['status'] == 'completed':
    print(f"Video URL: {task['result']['video_url']}")
    print(f"Cover Image: {task['result']['cover_image_url']}")

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

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

{
  "task_id": "task_abc123xyz",
  "status": "completed",
  "created_at": "2026-01-04T12:00:00Z",
  "started_at": "2026-01-04T12:05:00Z",
  "completed_at": "2026-01-04T12:15:00Z",
  "livemode": true,
  "result": {
    "video_url": "https://storage.vibepeak.ai/videos/task_abc123xyz.mp4",
    "cover_image_url": "https://storage.googleapis.com/vibepeak-audio/covers/task_abc123xyz.jpg",
    "duration_seconds": 45,
    "resolution": "1080p",
    "expires_at": "2026-01-11T12:15:00Z"
  }
}

{
  "task_id": "task_abc123xyz",
  "status": "completed",
  "created_at": "2026-01-04T12:00:00Z",
  "started_at": "2026-01-04T12:00:05Z",
  "completed_at": "2026-01-04T12:00:05Z",
  "livemode": false,
  "result": {
    "video_url": "https://storage.vibepeak.ai/samples/sample-landscape.mp4",
    "cover_image_url": "https://storage.vibepeak.ai/samples/sample-cover.jpg",
    "duration_seconds": 12,
    "total_scenes": 3
  }
}

{
  "task_id": "task_abc123xyz",
  "status": "failed",
  "created_at": "2026-01-04T12:00:00Z",
  "started_at": "2026-01-04T12:05:00Z",
  "completed_at": "2026-01-04T12:06:00Z",
  "error": {
    "code": "IMAGE_PROCESSING_FAILED",
    "message": "Failed to process image at index 2: Invalid image format"
  }
}

{
  "error": {
    "code": "TASK_NOT_FOUND",
    "message": "Task not found.",
    "request_id": "req_xyz123"
  }
}

Polling Best Practices

Don’t poll too frequently. We recommend polling every 5-15 seconds.

Here’s a recommended polling implementation:

async function waitForCompletion(taskId, apiKey) {
  const maxAttempts = 60;
  const pollInterval = 5000; // 5 seconds

  for (let attempt = 0; attempt < maxAttempts; attempt++) {
    const response = await fetch(
      `https://api.vibepeak.ai/v1/tasks/${taskId}`,
      { headers: { 'Authorization': `Bearer ${apiKey}` } }
    );

    const task = await response.json();

    switch (task.status) {
      case 'completed':
        return task.result;
      case 'failed':
        throw new Error(`Task failed: ${task.error.message}`);
      case 'queued':
      case 'processing':
        await new Promise(r => setTimeout(r, pollInterval));
        break;
    }
  }

  throw new Error('Task timed out');
}

// Usage
const result = await waitForCompletion('task_abc123xyz', apiKey);
console.log(`Video ready: ${result.video_url}`);

Error Codes

Code	Status	Description
`TASK_NOT_FOUND`	404	Task doesn’t exist or belongs to another user
`INVALID_API_KEY`	401	Invalid or missing API key

See Error Handling for more details.

Video URL Expiration

Video URLs expire after 7 days. Download or store the video before the expires_at timestamp.

If you need the video after expiration:

Re-request the task status (if the video is still available in storage)
Create a new slideshow with the same images

Create Narrated Slideshow

Overview

Avatars

Voices

Videos

Path Parameters

Response

Common Fields

Queued Status

Processing Status

Completed Status

Failed Status

Polling Best Practices

Error Codes

Video URL Expiration

​Path Parameters

​Response

​Common Fields

​Queued Status

​Processing Status

​Completed Status

​Failed Status

​Polling Best Practices

​Error Codes

​Video URL Expiration

Path Parameters

Response

Common Fields

Queued Status

Processing Status

Completed Status

Failed Status

Polling Best Practices

Error Codes

Video URL Expiration