# Reve Image API

> Provider: **Reve**
> Source: https://www.pixazo.ai/models/reve-image

Reve Image API by Reve.

## Reve Image Generation

### Image to Image (Image Editing)

## Base URL

```
https://gateway.pixazo.ai/reve-image/v1
```

## Authentication

All requests require an API key passed via header.

Header

Type

Required

Description

Ocp-Apim-Subscription-Key

string

Yes

Your API subscription key

## Image Edit - Reve Image generation API

## Request Code

HTTP Python JavaScript cURL

```
POST https://gateway.pixazo.ai/reve-image/v1/reve-edit/generate
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, headers=headers, json=data)
print(response.json())
```

```
const url = 'https://gateway.pixazo.ai/reve-image/v1/reve-edit/generate';

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: {
    'Content-Type': 'application/json',
    'Cache-Control': 'no-cache',
    'Ocp-Apim-Subscription-Key': 'YOUR_SUBSCRIPTION_KEY'
  },
  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"
  }'
```

## Output

```
{
  "request_id": "reve-image-generation_019dxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
  "status": "QUEUED",
  "polling_url": "https://gateway.pixazo.ai/v2/requests/status/reve-image-generation_019dxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
}
```

[Try Now](https://api.pixazo.ai/api-details#api=reve-image-generation&operation=image-edit)

## Webhook (Optional)

Add the `X-Webhook-URL` header to your generate request to receive a POST callback instead of polling.

```
X-Webhook-URL: https://your-server.com/webhook/callback
```

## Request Parameters - Image Edit

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": "https://example.com/photo.jpg",
  "prompt": "Add \"HELLO WORLD\" text in the middle of this image in a modern font, white text"
}
```

## Response

```
{
  "request_id": "reve-image-generation_019dxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
  "status": "QUEUED",
  "polling_url": "https://gateway.pixazo.ai/v2/requests/status/reve-image-generation_019dxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
}
```

HTTP Python JavaScript cURL

```
POST https://gateway.pixazo.ai/reve-image/v1/reve-edit/prediction
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, headers=headers, json=data)
print(response.json())
```

```
const url = 'https://gateway.pixazo.ai/reve-image/v1/reve-edit/prediction';

const data = {
  prediction_id: 'xyz789abc123def456ghi789jkl012mno'
};

fetch(url, {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    'Cache-Control': 'no-cache',
    'Ocp-Apim-Subscription-Key': 'YOUR_SUBSCRIPTION_KEY'
  },
  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"
  }'
```

## Output

```
{
  "success": true,
  "id": "xyz789abc123...",
  "status": "succeeded",
  "output": "https://.../reve-edit/xyz789abc123_output_0.png"
}
```

### Example Response (In Progress)

```
{
  "success": true,
  "id": "xyz789abc123def456ghi789jkl012mno",
  "model": "reve/edit",
  "status": "processing",
  "input": {
    "image": "https://example.com/photo.jpg",
    "prompt": "Add \"HELLO\" text in the middle",
    "version": "latest"
  },
  "created_at": "2025-10-23T14:30:00.000Z"
}
```

### Example Response (Completed)

```
{
  "success": true,
  "id": "xyz789abc123def456ghi789jkl012mno",
  "model": "reve/edit",
  "status": "succeeded",
  "input": {
    "image": "https://example.com/photo.jpg",
    "prompt": "Add \"HELLO\" text in the middle",
    "version": "latest"
  },
  "output": "https://.../reve-edit/xyz789abc123def456ghi789jkl012mno_output_0.png",
  "created_at": "2025-10-23T14:30:00.000Z"
}
```

## Response Handling

Common status codes.

Code

Meaning

202

Accepted — Request queued

400

Bad Request

401

Unauthorized

402

Insufficient Balance

403

Forbidden

429

Too Many Requests

500

Internal Server Error

## Error Responses

Queue system errors and model validation errors.

### Queue System Errors

```
// 402 — Insufficient balance
{
  "error": "Insufficient Balance",
  "message": "Your wallet does not have enough balance."
}
```

```
// 400 — Model not found
{
  "error": "Model not found",
  "message": "Model 'reve-image-generation' not found or is disabled"
}
```

### Error via Status/Webhook

```
{
  "request_id": "reve-image-generation_019dxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
  "status": "ERROR",
  "model_id": "reve-image-generation",
  "error": "Description of the error",
  "output": null
}
```

## Retrieving Results

Poll the universal status endpoint to check progress and retrieve results.

### Endpoint

```
GET https://gateway.pixazo.ai/v2/requests/status/{request_id}
Ocp-Apim-Subscription-Key: YOUR_API_KEY
```

## cURL Example

```
curl -H "Ocp-Apim-Subscription-Key: YOUR_API_KEY" \
  "https://gateway.pixazo.ai/v2/requests/status/reve-image-generation_019dxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
```

## Response (Completed)

```
{
  "request_id": "reve-image-generation_019dxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
  "status": "COMPLETED",
  "model_id": "reve-image-generation",
  "error": null,
  "output": {
    "media_url": [
      "https://pub-582b7213209642b9b995c96c95a30381.r2.dev/v1/reve-image-generation_019dxxxx-xxxx/output.ext"
    ],
    "media_type": "application/octet-stream"
  },
  "created_at": "2026-03-31T10:00:00.000Z",
  "updated_at": "2026-03-31T10:00:15.000Z",
  "completed_at": "2026-03-31T10:00:15.000Z"
}
```

## Response Fields

Field

Type

Description

request\_id

string

Unique request identifier

status

string

QUEUED, PROCESSING, COMPLETED, FAILED, or ERROR

model\_id

string

Model that processed the request

error

string|null

Error message if failed

output.media\_url

array

URLs to generated media (R2 CDN)

output.media\_type

string

MIME type of the output

created\_at

string

When request was created

completed\_at

string|null

When request completed

polling\_url

string

Status URL (initial response only)

## Status Values

Status

Description

QUEUED

Request accepted, waiting to be processed

PROCESSING

Being processed by the model

COMPLETED

Done — output contains the result

FAILED

Failed — check error field

ERROR

System error — not charged

## Status Flow

```
QUEUED → PROCESSING → COMPLETED
                    → FAILED
                    → ERROR
```

## Typical Workflow

1.  **Send a generate request** to the API endpoint
2.  **Save the `request_id`** from the response
3.  **Poll** every 5-10 seconds: `GET /v2/requests/status/{request_id}`
4.  **When `status` is `"COMPLETED"`**, download from `output.media_url`

**Tip:** Use `X-Webhook-URL` header to get a callback instead of polling.

### Image to Image (Image Editing — Remix)

## Base URL

```
https://gateway.pixazo.ai/reve-image/v1
```

## Authentication

All requests require an API key passed via header.

Header

Type

Required

Description

Ocp-Apim-Subscription-Key

string

Yes

Your API subscription key

## Image Remix - Reve Image generation API

## Request Code

HTTP Python JavaScript cURL

```
POST https://gateway.pixazo.ai/reve-image/v1/reve-remix/generate
Content-Type: application/json
Cache-Control: no-cache
Ocp-Apim-Subscription-Key: YOUR_SUBSCRIPTION_KEY

{
  "prompt": "A beautiful sunset over mountains with vibrant colors",
  "reference_images": [
    "https://example.com/city-photo.jpg"
  ],
  "aspect_ratio": "16:9"
}
```

```
import requests
import json

url = "https://gateway.pixazo.ai/reve-image/v1/reve-remix/generate"
headers = {
    "Content-Type": "application/json",
    "Cache-Control": "no-cache",
    "Ocp-Apim-Subscription-Key": "YOUR_SUBSCRIPTION_KEY"
}
data = {
    "prompt": "A beautiful sunset over mountains with vibrant colors",
    "reference_images": [
        "https://example.com/city-photo.jpg"
    ],
    "aspect_ratio": "16:9"
}

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

```
const url = 'https://gateway.pixazo.ai/reve-image/v1/reve-remix/generate';
const headers = {
  'Content-Type': 'application/json',
  'Cache-Control': 'no-cache',
  'Ocp-Apim-Subscription-Key': 'YOUR_SUBSCRIPTION_KEY'
};
const body = {
  prompt: 'A beautiful sunset over mountains with vibrant colors',
  reference_images: [
    'https://example.com/city-photo.jpg'
  ],
  aspect_ratio: '16:9'
};

fetch(url, {
  method: 'POST',
  headers: headers,
  body: JSON.stringify(body)
})
.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-remix/generate" \
  -H "Content-Type: application/json" \
  -H "Cache-Control: no-cache" \
  -H "Ocp-Apim-Subscription-Key: YOUR_SUBSCRIPTION_KEY" \
  --data-raw '{
    "prompt": "A beautiful sunset over mountains with vibrant colors",
    "reference_images": [
        "https://example.com/city-photo.jpg"
    ],
    "aspect_ratio": "16:9"
  }'
```

## Output

```
{
  "request_id": "reve-image-generation_019dxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
  "status": "QUEUED",
  "polling_url": "https://gateway.pixazo.ai/v2/requests/status/reve-image-generation_019dxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
}
```

[Try Now](https://api.pixazo.ai/api-details#api=reve-image-generation&operation=image-remix)

## Webhook (Optional)

Add the `X-Webhook-URL` header to your generate request to receive a POST callback instead of polling.

```
X-Webhook-URL: https://your-server.com/webhook/callback
```

## Request Parameters - Image Remix

Parameter

Required

Type

Description

prompt

Yes

string

Text description for the remixing task. Be specific and descriptive for best results.

reference\_images

No

array

Array of 1-4 image URLs to use as references. Must be publicly accessible (HTTPS recommended).

aspect\_ratio

No

string

Output aspect ratio. Valid values: \`16:9\`, \`9:16\`, \`3:2\`, \`2:3\`, \`4:3\`, \`3:4\`, \`1:1\`.

version

No

string

Model version. Valid values: \`latest\`, \`reve-remix@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

```
{
  "prompt": "A beautiful sunset over mountains with vibrant colors",
  "reference_images": [
    "https://example.com/city-photo.jpg"
  ],
  "aspect_ratio": "16:9"
}
```

## Response

```
{
  "request_id": "reve-image-generation_019dxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
  "status": "QUEUED",
  "polling_url": "https://gateway.pixazo.ai/v2/requests/status/reve-image-generation_019dxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
}
```

## Request Headers

Header

Value

Content-Type

application/json

Cache-Control

no-cache

Ocp-Apim-Subscription-Key

YOUR\_SUBSCRIPTION\_KEY

## Response Handling

Common status codes.

Code

Meaning

202

Accepted — Request queued

400

Bad Request

401

Unauthorized

402

Insufficient Balance

403

Forbidden

429

Too Many Requests

500

Internal Server Error

## Error Responses

Queue system errors and model validation errors.

### Queue System Errors

```
// 402 — Insufficient balance
{
  "error": "Insufficient Balance",
  "message": "Your wallet does not have enough balance."
}
```

```
// 400 — Model not found
{
  "error": "Model not found",
  "message": "Model 'reve-image-generation' not found or is disabled"
}
```

### Error via Status/Webhook

```
{
  "request_id": "reve-image-generation_019dxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
  "status": "ERROR",
  "model_id": "reve-image-generation",
  "error": "Description of the error",
  "output": null
}
```

## Retrieving Results

Poll the universal status endpoint to check progress and retrieve results.

### Endpoint

```
GET https://gateway.pixazo.ai/v2/requests/status/{request_id}
Ocp-Apim-Subscription-Key: YOUR_API_KEY
```

## cURL Example

```
curl -H "Ocp-Apim-Subscription-Key: YOUR_API_KEY" \
  "https://gateway.pixazo.ai/v2/requests/status/reve-image-generation_019dxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
```

## Response (Completed)

```
{
  "request_id": "reve-image-generation_019dxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
  "status": "COMPLETED",
  "model_id": "reve-image-generation",
  "error": null,
  "output": {
    "media_url": [
      "https://pub-582b7213209642b9b995c96c95a30381.r2.dev/v1/reve-image-generation_019dxxxx-xxxx/output.ext"
    ],
    "media_type": "application/octet-stream"
  },
  "created_at": "2026-03-31T10:00:00.000Z",
  "updated_at": "2026-03-31T10:00:15.000Z",
  "completed_at": "2026-03-31T10:00:15.000Z"
}
```

## Response Fields

Field

Type

Description

request\_id

string

Unique request identifier

status

string

QUEUED, PROCESSING, COMPLETED, FAILED, or ERROR

model\_id

string

Model that processed the request

error

string|null

Error message if failed

output.media\_url

array

URLs to generated media (R2 CDN)

output.media\_type

string

MIME type of the output

created\_at

string

When request was created

completed\_at

string|null

When request completed

polling\_url

string

Status URL (initial response only)

## Status Values

Status

Description

QUEUED

Request accepted, waiting to be processed

PROCESSING

Being processed by the model

COMPLETED

Done — output contains the result

FAILED

Failed — check error field

ERROR

System error — not charged

## Status Flow

```
QUEUED → PROCESSING → COMPLETED
                    → FAILED
                    → ERROR
```

## Typical Workflow

1.  **Send a generate request** to the API endpoint
2.  **Save the `request_id`** from the response
3.  **Poll** every 5-10 seconds: `GET /v2/requests/status/{request_id}`
4.  **When `status` is `"COMPLETED"`**, download from `output.media_url`

**Tip:** Use `X-Webhook-URL` header to get a callback instead of polling.