AI Avatars API Reference

AUTHENTICATION

Bearer Token Authentication

All requests to the LumozAI API require authentication using your secret API key. Pass your key in the standard Authorization HTTP header as a Bearer token.

cURL Authorization Header Quickstart

curl -X POST https://lumozai.com/api/v4/run \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json" \
  -d "model_id=ai-avatars" \
  -d "prompt=A futuristic cityscape illuminated by neon bioluminescence"

PHP cURL Request

<?php
$apiKey = 'YOUR_API_KEY';

$curl = curl_init();
curl_setopt_array($curl, [
    CURLOPT_URL => 'https://lumozai.com/api/v4/run',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_POST => true,
    CURLOPT_POSTFIELDS => [
        'model_id' => 'ai-avatars',
        'prompt' => 'A futuristic cityscape illuminated by neon bioluminescence'
    ],
    CURLOPT_HTTPHEADER => [
        'Accept: application/json',
        'Authorization: Bearer ' . $apiKey
    ]
]);

$response = curl_exec($curl);
curl_close($curl);

$result = json_decode($response, true);
print_r($result);

POST /api/v4/run

Execute AI Avatars Inference

Submit a synchronous or asynchronous generation job for AI Avatars (ai-avatars). Fast-running image models return the generated asset directly; longer inference pipelines return a request_id for asynchronous polling.

Request Parameters for AI Avatars

8 total fields

Parameter	Type	Required	Default	Description / Allowed Values
`model_id`	string	Required	`ai-avatars`	Unique model identifier. Must be set to `ai-avatars`.
`face_image` Your Image	string (URL)	Required	—
`user_gender` Gender	enum	Optional	—	male female non_binary
`face_image_b` Partner Image	string (URL)	Optional	—	Optional second face image for multi-person avatars
`user_b_gender` Partner Gender	enum	Optional	—	male female non_binary
`prompt` Prompt	string	Optional	`a guy riding a motorbike`	A prompt describing the scene to put the user(s) in
`workflow_type` Scene Type	enum	Optional	—	Realistic Stylistic
`webhook`	string (URL)	Optional	—	Optional callback URL to receive an HTTP POST when async generation completes.

Model-Specific Integration Code

Copy-paste production snippets configured with ai-avatars and tailored parameter inputs.

cURL POST /api/v4/run (ai-avatars)

curl -X POST https://lumozai.com/api/v4/run \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json" \
  -d "model_id=ai-avatars" \
  -d "face_image=https://lumozai.com/samples/sample_input.jpg" \
  -d "user_gender=male" \
  -d "face_image_b=https://lumozai.com/samples/sample_input.jpg" \
  -d "user_b_gender=male" \
  -d "prompt=a guy riding a motorbike" \
  -d "workflow_type=Realistic"

Python requests.post (ai-avatars)

import requests

url = "https://lumozai.com/api/v4/run"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
    "Accept": "application/json"
}
payload = {
    "model_id": "ai-avatars",
    "face_image": "https:\/\/lumozai.com\/samples\/sample_input.jpg",
    "user_gender": "male",
    "face_image_b": "https:\/\/lumozai.com\/samples\/sample_input.jpg",
    "user_b_gender": "male",
    "prompt": "a guy riding a motorbike",
    "workflow_type": "Realistic"
}

response = requests.post(url, headers=headers, json=payload)
print(response.json())

PHP cURL POST (ai-avatars)

<?php
$apiKey = 'YOUR_API_KEY';

$curl = curl_init();
curl_setopt_array($curl, [
    CURLOPT_URL => 'https://lumozai.com/api/v4/run',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_POST => true,
    CURLOPT_POSTFIELDS => [
        'model_id' => 'ai-avatars',
        'face_image' => 'https://lumozai.com/samples/sample_input.jpg',
        'user_gender' => 'male',
        'face_image_b' => 'https://lumozai.com/samples/sample_input.jpg',
        'user_b_gender' => 'male',
        'prompt' => 'a guy riding a motorbike',
        'workflow_type' => 'Realistic'
    ],
    CURLOPT_HTTPHEADER => [
        'Accept: application/json',
        'Authorization: Bearer ' . $apiKey
    ]
]);

$response = curl_exec($curl);
curl_close($curl);

$result = json_decode($response, true);
print_r($result);

JavaScript fetch async/await (ai-avatars)

const response = await fetch('https://lumozai.com/api/v4/run', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json',
    'Accept': 'application/json'
  },
  body: JSON.stringify({
    "model_id": "ai-avatars",
    "face_image": "https:\/\/lumozai.com\/samples\/sample_input.jpg",
    "user_gender": "male",
    "face_image_b": "https:\/\/lumozai.com\/samples\/sample_input.jpg",
    "user_b_gender": "male",
    "prompt": "a guy riding a motorbike",
    "workflow_type": "Realistic"
  })
});

const data = await response.json();
console.log(data);

Response Structure (200 OK)

JSON Output

{
  "success": true,
  "data": {
    "request_id": 982348712938172,
    "output": "https://lumozai.com/storage/outputs/result_ai-avatars_9823.png",
    "output_type": "image"
  }
}

POST /api/v4/check

Poll Asynchronous Task Status

Poll the current execution state of an asynchronous job using the returned request_id.

Request Parameters

Parameter	Type	Required	Description
`request_id`	integer	Required	The unique job ID returned when calling `/api/v4/run`.

JSON Completed Status (200 OK)

{
  "success": true,
  "data": {
    "request_id": 982348712938172,
    "status": "completed",
    "output": "https://lumozai.com/storage/outputs/video_8172.mp4",
    "output_type": "video"
  }
}

JSON In-Progress Status (200 OK)

{
  "success": true,
  "data": {
    "request_id": 982348712938172,
    "status": "processing",
    "progress": 68
  }
}

ERROR HANDLING

Standard Error Codes

The API uses conventional HTTP response codes to indicate success or failure. In general, 2xx indicates success, 4xx indicates client input issues, and 5xx indicates server errors.

Status	Error Code	Description
401	`authentication_failed`	Missing or invalid Authorization Bearer header.
403	`permission_denied`	Insufficient credits or account tier permissions.
404	`model_not_found`	The specified `model_id` does not exist or is deprecated.
422	`validation_error`	Missing required parameters or invalid parameter types.
429	`rate_limit_exceeded`	Request rate quota exceeded for your tier.
500	`internal_server_error`	Downstream GPU compute error or worker timeout.

JSON Validation Error Example

{
  "success": false,
  "error": {
    "code": "validation_error",
    "message": "The model_id field is required.",
    "details": {
      "model_id": ["The model_id field is required."]
    }
  }
}

RATE LIMITS

Quota & Throughput Limits

Rate limits are enforced per API key to guarantee fair access and consistent low latency across GPU workers. Every API response includes informative headers:

Header	Description
`X-RateLimit-Limit`	Maximum number of requests permitted per rolling hour.
`X-RateLimit-Remaining`	Number of remaining requests in the active window.
`X-RateLimit-Reset`	Unix epoch timestamp when the current window refreshes.

Handling 429 Status Codes: When rate-limited, wait for the number of seconds until X-RateLimit-Reset or implement an exponential backoff retry mechanism. Need custom enterprise rate limits? Contact our team.