Reve Edit Image API Documentation
Image Edit - Request Code
POST https://gateway.pixazo.ai/reve-image/v1/reve-edit/generate HTTP/1.1
Content-Type: application/json
Cache-Control: no-cache
Ocp-Apim-Subscription-Key: YOUR_SUBSCRIPTION_KEY
{
"image": "https://example.com/photo.jpg",
"prompt": "Add \"HELLO WORLD\" text in the middle of this image in a modern font, white text"
} import requests
url = "https://gateway.pixazo.ai/reve-image/v1/reve-edit/generate"
headers = {
"Content-Type": "application/json",
"Cache-Control": "no-cache",
"Ocp-Apim-Subscription-Key": "YOUR_SUBSCRIPTION_KEY"
}
data = {
"image": "https://example.com/photo.jpg",
"prompt": "Add \"HELLO WORLD\" text in the middle of this image in a modern font, white text"
}
response = requests.post(url, json=data, headers=headers)
print(response.json()) const url = 'https://gateway.pixazo.ai/reve-image/v1/reve-edit/generate';
const headers = {
'Content-Type': 'application/json',
'Cache-Control': 'no-cache',
'Ocp-Apim-Subscription-Key': 'YOUR_SUBSCRIPTION_KEY'
};
const data = {
image: 'https://example.com/photo.jpg',
prompt: 'Add \"HELLO WORLD\" text in the middle of this image in a modern font, white text'
};
fetch(url, {
method: 'POST',
headers: headers,
body: JSON.stringify(data)
})
.then(response => response.json())
.then(data => console.log(data))
.catch(error => console.error('Error:', error)); curl -v -X POST "https://gateway.pixazo.ai/reve-image/v1/reve-edit/generate" \
-H "Content-Type: application/json" \
-H "Cache-Control: no-cache" \
-H "Ocp-Apim-Subscription-Key: YOUR_SUBSCRIPTION_KEY" \
--data-raw '{
"image": "https://example.com/photo.jpg",
"prompt": "Add \"HELLO WORLD\" text in the middle of this image in a modern font, white text"
}' import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.time.Duration;
public class ApiClient {
public static void main(String[] args) throws Exception {
String url = "https://gateway.pixazo.ai/reve-image/v1/reve-edit/generate";
String json = "{" + "\n" +
" \"image\": \"https://example.com/photo.jpg\"," + "\n" +
" \"prompt\": \"Add \\\"HELLO WORLD\\\" text in the middle of this image in a modern font, white text\"" + "\n" +
"}";
HttpClient client = HttpClient.newBuilder()
.connectTimeout(Duration.ofSeconds(10))
.build();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create(url))
.header("Content-Type", "application/json")
.header("Cache-Control", "no-cache")
.header("Ocp-Apim-Subscription-Key", "YOUR_SUBSCRIPTION_KEY")
.POST(HttpRequest.BodyPublishers.ofString(json))
.build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
}
} <?php
$url = 'https://gateway.pixazo.ai/reve-image/v1/reve-edit/generate';
$data = [
'image' => 'https://example.com/photo.jpg',
'prompt' => 'Add "HELLO WORLD" text in the middle of this image in a modern font, white text'
];
$jsonData = json_encode($data);
$ch = curl_init($url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, $jsonData);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
'Content-Type: application/json',
'Cache-Control: no-cache',
'Ocp-Apim-Subscription-Key: YOUR_SUBSCRIPTION_KEY'
]);
$response = curl_exec($ch);
$httpCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);
echo $response;
?> Output
Successful API response:
{ "success": true, "id": "xyz789abc123def456ghi789jkl012mno", "model": "reve/edit", "status": "starting" } Request Body - Image Edit
Parameters for /reve-edit/generate:
| Parameter | Required | Type | Description |
|---|---|---|---|
| image | Yes | string | Input image URL to edit. Must be publicly accessible (HTTPS recommended). |
| prompt | Yes | string | Text instruction describing the edit you want to apply. Be specific and clear. |
| version | No | string | Model version. Valid values: latest, reve-edit@20250915. |
| webhook | No | string | Callback URL for completion notification. POST request sent with results when complete. |
| webhook_events_filter | No | array | Events that trigger webhook. Valid values: ["*"] (all), ["completed"] (success/failure only). |
Example Request - Image Edit
JSON
{ "image": "https://example.com/photo.jpg", "prompt": "Add \"HELLO WORLD\" text in the middle of this image in a modern font, white text" } Response - Image Edit
JSON
{ "success": true, "id": "xyz789abc123def456ghi789jkl012mno", "model": "reve/edit", "status": "starting", "input": { "image": "https://example.com/photo.jpg", "prompt": "Add \"HELLO\" text in the middle", "version": "latest" }, "created_at": "2025-10-23T14:30:00.000Z" } Request Headers
| Header | Description |
|---|---|
| Content-Type | application/json |
| Cache-Control | no-cache |
| Ocp-Apim-Subscription-Key | Your subscription key for authentication |
Response Handling
The Reve Image generation returns specific HTTP status codes and response bodies to indicate the success or failure of a request. Developers should implement error handling in their applications to manage these responses effectively.
Common Status Codes and Responses
| Status Code | Description | Response Body |
|---|---|---|
| 200 | Success - The request was successfully processed. | { "success": true, ... } |
| 400 | Bad Request - The request contains invalid parameters or missing fields. | { "error": "Invalid request parameters" } |
| 401 | Unauthorized - The provided subscription key is missing or invalid. | { "error": "Invalid or missing authentication" } |
| 403 | Forbidden - The subscription does not have access to this API or action. | { "error": "Access denied for this operation" } |
| 404 | Not Found - The requested resource or endpoint could not be found. | { "error": "Endpoint not found" } |
| 429 | Too Many Requests - The request rate limit has been exceeded. | { "error": "Rate limit exceeded, please retry later" } |
| 500 | Internal Server Error - An unexpected error occurred on the server. | { "error": "An unexpected error occurred, please try again later" } |
Example Error Response
{
"error": "Invalid parameters"
} Retrieving Results - Request Code
After submitting your request, use this endpoint to check status and retrieve results.
Endpoint
POST https://gateway.pixazo.ai/reve-image/v1/reve-edit/prediction
Request Body
{ "prediction_id": "xyz789abc123def456ghi789jkl012mno" } POST https://gateway.pixazo.ai/reve-image/v1/reve-edit/prediction HTTP/1.1
Content-Type: application/json
Cache-Control: no-cache
Ocp-Apim-Subscription-Key: YOUR_SUBSCRIPTION_KEY
{
"prediction_id": "xyz789abc123def456ghi789jkl012mno"
} import requests
url = "https://gateway.pixazo.ai/reve-image/v1/reve-edit/prediction"
headers = {
"Content-Type": "application/json",
"Cache-Control": "no-cache",
"Ocp-Apim-Subscription-Key": "YOUR_SUBSCRIPTION_KEY"
}
data = {
"prediction_id": "xyz789abc123def456ghi789jkl012mno"
}
response = requests.post(url, json=data, headers=headers)
print(response.json()) const url = 'https://gateway.pixazo.ai/reve-image/v1/reve-edit/prediction';
const headers = {
'Content-Type': 'application/json',
'Cache-Control': 'no-cache',
'Ocp-Apim-Subscription-Key': 'YOUR_SUBSCRIPTION_KEY'
};
const data = {
prediction_id: 'xyz789abc123def456ghi789jkl012mno'
};
fetch(url, {
method: 'POST',
headers: headers,
body: JSON.stringify(data)
})
.then(response => response.json())
.then(data => console.log(data))
.catch(error => console.error('Error:', error)); curl -v -X POST "https://gateway.pixazo.ai/reve-image/v1/reve-edit/prediction" \
-H "Content-Type: application/json" \
-H "Cache-Control: no-cache" \
-H "Ocp-Apim-Subscription-Key: YOUR_SUBSCRIPTION_KEY" \
--data-raw '{
"prediction_id": "xyz789abc123def456ghi789jkl012mno"
}' import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.time.Duration;
public class ApiClient {
public static void main(String[] args) throws Exception {
String url = "https://gateway.pixazo.ai/reve-image/v1/reve-edit/prediction";
String json = "{" + "\n" +
" \"prediction_id\": \"xyz789abc123def456ghi789jkl012mno\"" + "\n" +
"}";
HttpClient client = HttpClient.newBuilder()
.connectTimeout(Duration.ofSeconds(10))
.build();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create(url))
.header("Content-Type", "application/json")
.header("Cache-Control", "no-cache")
.header("Ocp-Apim-Subscription-Key", "YOUR_SUBSCRIPTION_KEY")
.POST(HttpRequest.BodyPublishers.ofString(json))
.build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
}
} <?php
$url = 'https://gateway.pixazo.ai/reve-image/v1/reve-edit/prediction';
$data = [
'prediction_id' => 'xyz789abc123def456ghi789jkl012mno'
];
$jsonData = json_encode($data);
$ch = curl_init($url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, $jsonData);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
'Content-Type: application/json',
'Cache-Control: no-cache',
'Ocp-Apim-Subscription-Key: YOUR_SUBSCRIPTION_KEY'
]);
$response = curl_exec($ch);
$httpCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);
echo $response;
?> Reve Edit Image API Pricing
| Resolution | Price (USD) |
|---|---|
| All Resolution | $0.06 |
Ready to generate Reve Edit Image API assets?
Start with an API key, then automate your pipeline.