Step1X Edit API Reference
Unified REST endpoint for high-speed model inference, asynchronous background pipelines, and real-time execution status.
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 -X POST https://lumozai.com/api/v4/run \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Accept: application/json" \
-d "model_id=step1x-edit" \
-d "prompt=A futuristic cityscape illuminated by neon bioluminescence"
<?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' => 'step1x-edit',
'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);
Execute Step1X Edit Inference
Submit a synchronous or asynchronous generation job for Step1X Edit (step1x-edit). Fast-running image models return the generated asset directly; longer inference pipelines return a request_id for asynchronous polling.
Request Parameters for Step1X Edit
5 total fields| Parameter | Type | Required | Default | Description / Allowed Values |
|---|---|---|---|---|
model_id
|
string | Required | step1x-edit |
Unique model identifier. Must be set to
step1x-edit. |
image_url
Image
|
string (URL) | Required | — | |
prompt
|
string | Required | — | |
negative_prompt
Negative Prompt
|
string | Optional | — | |
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 step1x-edit and tailored parameter inputs.
curl -X POST https://lumozai.com/api/v4/run \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Accept: application/json" \
-d "model_id=step1x-edit" \
-d "image_url=https://lumozai.com/samples/sample_input.jpg" \
-d "prompt=A futuristic cybernetic metropolis illuminated by neon bioluminescence, 8k cinematic masterpiece" \
-d "negative_prompt=sample_value"
import requests
url = "https://lumozai.com/api/v4/run"
headers = {
"Authorization": "Bearer YOUR_API_KEY",
"Accept": "application/json"
}
payload = {
"model_id": "step1x-edit",
"image_url": "https:\/\/lumozai.com\/samples\/sample_input.jpg",
"prompt": "A futuristic cybernetic metropolis illuminated by neon bioluminescence, 8k cinematic masterpiece",
"negative_prompt": "sample_value"
}
response = requests.post(url, headers=headers, json=payload)
print(response.json())
<?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' => 'step1x-edit',
'image_url' => 'https://lumozai.com/samples/sample_input.jpg',
'prompt' => 'A futuristic cybernetic metropolis illuminated by neon bioluminescence, 8k cinematic masterpiece',
'negative_prompt' => 'sample_value'
],
CURLOPT_HTTPHEADER => [
'Accept: application/json',
'Authorization: Bearer ' . $apiKey
]
]);
$response = curl_exec($curl);
curl_close($curl);
$result = json_decode($response, true);
print_r($result);
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": "step1x-edit",
"image_url": "https:\/\/lumozai.com\/samples\/sample_input.jpg",
"prompt": "A futuristic cybernetic metropolis illuminated by neon bioluminescence, 8k cinematic masterpiece",
"negative_prompt": "sample_value"
})
});
const data = await response.json();
console.log(data);
Response Structure (200 OK)
{
"success": true,
"data": {
"request_id": 982348712938172,
"output": "https://lumozai.com/storage/outputs/result_step1x-edit_9823.png",
"output_type": "image"
}
}
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. |
{
"success": true,
"data": {
"request_id": 982348712938172,
"status": "completed",
"output": "https://lumozai.com/storage/outputs/video_8172.mp4",
"output_type": "video"
}
}
{
"success": true,
"data": {
"request_id": 982348712938172,
"status": "processing",
"progress": 68
}
}
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. |
{
"success": false,
"error": {
"code": "validation_error",
"message": "The model_id field is required.",
"details": {
"model_id": ["The model_id field is required."]
}
}
}
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. |
X-RateLimit-Reset or implement an exponential backoff retry mechanism. Need custom enterprise rate limits? Contact our team.