Skip to main content
POST
/
api
/
public
/
v1
/
export
/
start
curl -X POST "https://app.hoox.video/api/public/v1/export/start" \
  -H "Authorization: Bearer your_api_key" \
  -H "Content-Type: application/json" \
  -d '{
    "video_id": "vid_xyz789",
    "format": "vertical",
    "webhook_url": "https://your-app.com/webhooks/export"
  }'
{
  "job_id": "export_abcd1234",
  "status": "pending",
  "estimated_credits": 0
}

Overview

This endpoint exports a completed video to a downloadable MP4 file. Use this after your video generation is complete to get the final downloadable video file.

Authentication

This endpoint requires API key authentication. Export costs may apply depending on how the video was created.

Request Body

video_id
string
required
The video ID returned from completed video generation.
format
string
Export format override: vertical (9:16), ads (4:5) or square (1:1). If not specified, uses the original video format.
webhook_url
string
URL to receive webhook notifications when export completes.

Response

job_id
string
Unique identifier for the export job.
status
string
Current job status: pending.
estimated_credits
number
Estimated credit cost for this export (0 for API-generated videos).
curl -X POST "https://app.hoox.video/api/public/v1/export/start" \
  -H "Authorization: Bearer your_api_key" \
  -H "Content-Type: application/json" \
  -d '{
    "video_id": "vid_xyz789",
    "format": "vertical",
    "webhook_url": "https://your-app.com/webhooks/export"
  }'
{
  "job_id": "export_abcd1234",
  "status": "pending",
  "estimated_credits": 0
}

Export Formats

Vertical (9:16)

1080x1920 Perfect for TikTok, Instagram Stories, YouTube Shorts

Ads (4:5)

1080x1350 Best for Instagram ads, Facebook ads, LinkedIn ads

Square (1:1)

1080x1080 Ideal for Instagram posts, Facebook, LinkedIn

Credit Costs

Export costs depend on how the video was created:
  • API-generated videos: 0 credits (export included in generation cost, only for first export)
  • Dashboard-created videos: Standard export cost applies (5 credits every 30 seconds)
Videos created through the API have export costs included in the initial generation cost, making first export free.

Prerequisites

Before exporting a video:
  1. Video must be completed: Check generation status is completed
  2. Valid video_id: Use the video_id from generation result
  3. Video ownership: Video must belong to your space

Next Steps

After starting an export:
  1. Monitor Progress: Use /export/status/{jobId} to check export progress
  2. Download Video: Get the download URL when export completes
  3. Webhook Integration: Set up webhooks for automatic notifications

Error Codes

  • MISSING_VIDEO_ID: video_id parameter is required
  • VIDEO_NOT_FOUND: Video with specified ID doesn’t exist
  • UNAUTHORIZED_VIDEO: Video doesn’t belong to your space
  • VIDEO_NOT_READY: Video generation must be completed first
  • INVALID_FORMAT: Invalid export format specified
  • INSUFFICIENT_CREDITS: Not enough credits for export (dashboard videos only)
I