LUMIQ API

Authentication

All API requests require an API key passed in the X-API-Key header.

curl https://lumiq.my/api/v1/account \
  -H "X-API-Key: lmq_YOUR_API_KEY"

Quick Start

Generate your first AI avatar video in 3 steps:

Step 1 — Get your API key

Visit lumiq.my/api-dashboard and click + Create New Key.

Step 2 — Submit a generation request

curl -X POST https://lumiq.my/api/v1/avatar \
  -H "X-API-Key: lmq_YOUR_KEY" \
  -F "video=@source.mp4" \
  -F "photo=@person.jpg" \
  -F "duration=10" \
  -F "ratio=9:16" \
  -F "webhook_url=https://your-server.com/webhook"

import requests

response = requests.post(
    "https://lumiq.my/api/v1/avatar",
    headers={"X-API-Key": "lmq_YOUR_KEY"},
    files={
        "video": open("source.mp4", "rb"),
        "photo": open("person.jpg", "rb"),
    },
    data={
        "duration": "10",
        "ratio": "9:16",
        "webhook_url": "https://your-server.com/webhook"
    }
)
print(response.json())

const FormData = require('form-data');
const fs = require('fs');
const axios = require('axios');

const form = new FormData();
form.append('video', fs.createReadStream('source.mp4'));
form.append('photo', fs.createReadStream('person.jpg'));
form.append('duration', '10');
form.append('ratio', '9:16');
form.append('webhook_url', 'https://your-server.com/webhook');

const res = await axios.post(
    'https://lumiq.my/api/v1/avatar',
    form,
    { headers: { 'X-API-Key': 'lmq_YOUR_KEY', ...form.getHeaders() }}
);
console.log(res.data);

Step 3 — Poll for result or receive webhook

# Poll status
curl https://lumiq.my/api/v1/status/TASK_ID \
  -H "X-API-Key: lmq_YOUR_KEY"

# Response when ready:
{
  "task_id": "a1b2c3d4",
  "status": "completed",
  "video_url": "https://lumiq.my/api/v1/download/a1b2c3d4"
}

POST /avatar

Generate an AI avatar video by swapping a person's face and voice into a source video.

Request Parameters

Credit Cost

Response

{
  "success": true,
  "task_id": "a1b2c3d4",
  "status": "processing",
  "credits_used": 90,
  "credits_remaining": 510,
  "estimated_time": "3-8 minutes",
  "check_status": "https://lumiq.my/api/v1/status/a1b2c3d4"
}

POST /football

Generate a FIFA World Cup 2026 fan video. Places a person in the crowd of a real match scene with AI-generated motion.

Request Parameters

Supported Teams (48 total)

United States, Mexico, Canada, France, England, Germany, Spain, Portugal, Italy, Netherlands, Belgium, Croatia, Switzerland, Denmark, Austria, Ukraine, Poland, Sweden, Turkey, Argentina, Brazil, Uruguay, Colombia, Ecuador, Paraguay, Chile, Japan, South Korea, Iran, Australia, Saudi Arabia, Qatar, Uzbekistan, Iraq, UAE, Morocco, Senegal, Tunisia, Algeria, Egypt, Nigeria, Cameroon, Ivory Coast, Mali, Panama, Costa Rica, Jamaica, New Zealand

Response

{
  "success": true,
  "task_id": "b2c3d4e5",
  "status": "processing",
  "credits_used": 90,
  "credits_remaining": 420,
  "estimated_time": "3-5 minutes",
  "check_status": "https://lumiq.my/api/v1/status/b2c3d4e5"
}

GET /status/{task_id}

Poll the status of a generation task.

Response — Processing

{
  "task_id": "a1b2c3d4",
  "status": "processing",
  "created_at": "2026-06-14 10:30:00"
}

Response — Completed

{
  "task_id": "a1b2c3d4",
  "status": "completed",
  "created_at": "2026-06-14 10:30:00",
  "video_url": "https://lumiq.my/api/v1/download/a1b2c3d4"
}

Response — Failed

{
  "task_id": "a1b2c3d4",
  "status": "failed",
  "created_at": "2026-06-14 10:30:00"
}

GET /download/{task_id}

Download the completed video file (MP4).

curl -O https://lumiq.my/api/v1/download/a1b2c3d4 \
  -H "X-API-Key: lmq_YOUR_KEY"

GET /account

Check your account balance and usage statistics.

{
  "credits_balance": 1200,
  "email": "user@example.com",
  "total_api_calls": 47,
  "total_credits_spent": 4230
}

Webhook Callbacks

Pass a webhook_url in your request to receive a POST notification when generation completes — no polling needed.

Webhook Payload

POST https://your-server.com/webhook

{
  "task_id": "a1b2c3d4",
  "status": "completed",
  "video_url": "https://lumiq.my/api/v1/download/a1b2c3d4",
  "timestamp": "2026-06-14T10:38:22.123456"
}

Failure Payload

{
  "task_id": "a1b2c3d4",
  "status": "failed",
  "error": "Generation failed",
  "timestamp": "2026-06-14T10:38:22.123456"
}

Example Webhook Handler (Python)

from flask import Flask, request, jsonify
app = Flask(__name__)

@app.route('/webhook', methods=['POST'])
def handle_webhook():
    data = request.json
    task_id = data['task_id']
    status = data['status']

    if status == 'completed':
        video_url = data['video_url']
        print(f"Video ready: {video_url}")
    elif status == 'failed':
        print(f"Task {task_id} failed: {data.get('error')}")

    return jsonify({'received': True}), 200

Error Handling

Pricing

Credits are purchased once and never expire. No subscription required.

API Cost per Video