Skip to content
HiPix Docs

Quickstart

Overview

Section titled “Overview”

HiPix is an AI API gateway that lets you generate videos and images through a simple REST API. This guide walks you through your first successful video generation.

1. Create an Account

Section titled “1. Create an Account”
  1. Visit hipix.app
  2. Click Get Started to sign up
  3. Check your email for a verification link (if enabled)

2. Get Your API Key

Section titled “2. Get Your API Key”
  1. Log in to your dashboard
  2. Go to Keys (API Tokens)
  3. Click Add Token
  4. Give it a name (e.g., “my-app”)
  5. Set a quota limit or choose unlimited
  6. Copy the sk-... key — you won’t see it again

3. Make Your First Request

Section titled “3. Make Your First Request”

Using cURL

Section titled “Using cURL”
Terminal window
curl -X POST https://api.hipix.app/v1/videos \
  -H "Authorization: Bearer sk-your-api-key" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "aliyun/wan3-0/reference-to-video-global",
    "prompt": "A golden retriever running on a sunny beach, waves crashing, cinematic lighting",
    "seconds": 5,
    "metadata": {
      "resolution": "480P",
      "ratio": "16:9"
    }
  }'

You’ll receive a response like:

{
  "id": "vt-abc123",
  "status": "queued",
  "created_at": 1760000000
}

Poll for the Result

Section titled “Poll for the Result”

Video generation is asynchronous — it takes 1-5 minutes. Poll the task status:

Terminal window
curl https://api.hipix.app/v1/videos/vt-abc123 \
  -H "Authorization: Bearer sk-your-api-key"

When the video is ready, status changes to "completed" and the response includes the video URL.

Using Python

Section titled “Using Python”
import os
import time
import requests


BASE_URL = "https://api.hipix.app"
HEADERS = {
    "Authorization": f"Bearer {os.environ['HIPIX_API_KEY']}",
    "Content-Type": "application/json",
}


def generate_video(prompt, model="aliyun/wan3-0/reference-to-video-global",
                   seconds=5, resolution="480P", ratio="16:9"):
    """Submit a video task and wait for completion."""
    task = requests.post(
        f"{BASE_URL}/v1/videos",
        headers=HEADERS,
        json={
            "model": model,
            "prompt": prompt,
            "seconds": seconds,
            "metadata": {"resolution": resolution, "ratio": ratio},
        },
    ).json()


    while True:
        result = requests.get(
            f"{BASE_URL}/v1/videos/{task['id']}",
            headers=HEADERS,
        ).json()
        if result["status"] == "completed":
            return result
        if result["status"] == "failed":
            raise RuntimeError(f"Video generation failed: {result}")
        time.sleep(5)


# Usage
video = generate_video("A cat playing piano in a jazz bar")
print(f"Video URL: {video['url']}")

4. Check Your Balance

Section titled “4. Check Your Balance”

Each request deducts from your account balance based on the model, resolution, and duration. You can view your balance and transaction history in the dashboard under Wallet.

Base URL

Section titled “Base URL”

All API requests use the following base URL:

https://api.hipix.app

Next Steps

Section titled “Next Steps”