text-to-image
OpenAI's image editor for precise natural-language edits - add/remove objects, swap backgrounds, retouch, adjust colors, and edit text
Use one of our client libraries to get started quickly.
OpenAI's image editor for precise natural-language edits - add/remove objects, swap backgrounds, retouch, adjust colors, and edit text. Ready-to-use REST inference API, best performance, no coldstarts, affordable pricing.
Send a POST request to start generation. The API returns immediately with a prediction ID for polling.
curl -X POST "https://api.vibedream.ai/api/v1/models/gpt-image-edit/generate" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer $VIBEDREAM_API_KEY" \
-d '{
"images": [
"https://example.com/image1.jpg"
],
"prompt": "A beautiful sunset over mountains with golden light",
"size": "1024*1024",
"quality": "medium",
"input_fidelity": "high",
"output_format": "jpeg"
}'The API uses an API Key for authentication.
Get your API key from vibedream.ai/models/api-keys.
export VIBEDREAM_API_KEY="your-api-key"
Generation requests are queued and processed asynchronously. Poll the prediction endpoint until status is completed or failed.
curl -X POST "https://api.vibedream.ai/api/v1/models/gpt-image-edit/generate" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer $VIBEDREAM_API_KEY" \
-d '{
"images": [
"https://example.com/image1.jpg"
],
"prompt": "A beautiful sunset over mountains with golden light",
"size": "1024*1024",
"quality": "medium",
"input_fidelity": "high",
"output_format": "jpeg"
}'Response
Returns immediately with a prediction ID. Use id to poll for results.
{
"id": "550e8400-e29b-41d4-a716-446655440000",
"status": "processing",
"statusUrl": "https://api.vibedream.ai/api/v1/predictions/550e8400-e29b-41d4-a716-446655440000",
"estimatedTime": "5-20s",
"costCents": 3,
"createdAt": "2025-01-15T12:00:00.000Z"
}# Replace YOUR_PREDICTION_ID with the id from the submit response curl "https://api.vibedream.ai/api/v1/predictions/YOUR_PREDICTION_ID" \ -H "Authorization: Bearer $VIBEDREAM_API_KEY" # Poll every 1-2s until status is "completed" or "failed"
Completed response
outputs is string[] — an array of direct download URLs hosted on assets.vibedream.ai.
{
"id": "550e8400-e29b-41d4-a716-446655440000",
"modelId": "gpt-image-edit",
"modelName": "GPT Image 1.5 Edit",
"status": "completed",
"outputs": [
"https://assets.vibedream.ai/outputs/550e8400-e29b-41d4-a716-446655440000/1736942400000-0.png"
],
"error": null,
"createdAt": "2025-01-15T12:00:00.000Z",
"completedAt": "2025-01-15T12:00:30.000Z"
}Failed response
{
"id": "550e8400-e29b-41d4-a716-446655440000",
"modelId": "gpt-image-edit",
"modelName": "GPT Image 1.5 Edit",
"status": "failed",
"outputs": null,
"error": "Your request was flagged by content moderation. Please modify your prompt.",
"createdAt": "2025-01-15T12:00:00.000Z",
"completedAt": "2025-01-15T12:00:05.000Z"
}| Field | Type | Description |
|---|---|---|
| id | string | Unique prediction ID (UUID). |
| modelId | string | ID of the model used for generation. |
| modelName | string | Human-readable model name. |
| status | string | Current status. One of: processing, completed, failed. |
| outputs | string[] | null | Array of output URLs. Each URL is a direct download link to the generated file on assets.vibedream.ai. null when still processing or failed. |
| error | string | null | Error message if the generation failed. null on success. |
| createdAt | string | ISO 8601 timestamp when the request was submitted. |
| completedAt | string | null | ISO 8601 timestamp when generation finished. null while processing. |
| Parameter | Type | Required | Default | Range | Description |
|---|---|---|---|---|---|
| images | string | string[] | No | -- | -- | The image to editPass a single image URL (string) or multiple image URLs (string[]). Accepted formats: JPEG, PNG, GIF, WebP. |
| prompt | string | Yes | -- | -- | Describe the edit you want (e.g. 'remove the person in the background') |
| size | string | No | 1024*1024 | auto, 1024*1024, 1024*1536, 1536*1024 | Output image size |
| quality | string | No | medium | low, medium, high | Image quality level (higher quality costs more) |
| input_fidelity | string | No | high | low, high | How closely to preserve details from input (faces, logos) |
| output_format | string | No | jpeg | jpeg, png | The format of the output image |
{
"images": [
"https://example.com/image1.jpg"
],
"prompt": "A beautiful sunset over mountains with golden light",
"size": "1024*1024",
"quality": "medium",
"input_fidelity": "high",
"output_format": "jpeg"
}{
"id": "550e8400-e29b-41d4-a716-446655440000",
"modelId": "gpt-image-edit",
"modelName": "GPT Image 1.5 Edit",
"status": "completed",
"outputs": [
"https://assets.vibedream.ai/outputs/550e8400-e29b-41d4-a716-446655440000/1736942400000-0.png"
],
"error": null,
"createdAt": "2025-01-15T12:00:00.000Z",
"completedAt": "2025-01-15T12:00:30.000Z"
}