text-to-image
WaveSpeed AI Image Upscaler
AI Image Upscaler that enhances image resolution to 4K or 8K while improving detail and clarity for photos and graphics. Ready-to-use REST inference API, best performance, no coldstarts, affordable pricing.
Use one of our client libraries to get started quickly.
WaveSpeed AI Image Upscaler
AI Image Upscaler that enhances image resolution to 4K or 8K while improving detail and clarity for photos and graphics. Ready-to-use REST inference API, best performance, no coldstarts, affordable pricing.. Ready-to-use REST inference API, best performance, no coldstarts, affordable pricing.
1. Calling the API
Submit a request
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/image-upscaler/generate" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer $VIBEDREAM_API_KEY" \
-d '{
"image": "https://example.com/your-image.jpg",
"target_resolution": "2k",
"output_format": "jpeg",
"enable_base64_output": false,
"enable_sync_mode": false
}'2. Authentication
The API uses an API Key for authentication.
Get your API Key
Get your API key from vibedream.ai/models/api-keys.
Environment variable
export VIBEDREAM_API_KEY="your-api-key"
3. Queue & Results
Generation requests are queued and processed asynchronously. Poll the prediction endpoint until status is completed or failed.
Submit request
curl -X POST "https://api.vibedream.ai/api/v1/models/image-upscaler/generate" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer $VIBEDREAM_API_KEY" \
-d '{
"image": "https://example.com/your-image.jpg",
"target_resolution": "2k",
"output_format": "jpeg",
"enable_base64_output": false,
"enable_sync_mode": false
}'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": "Fast & Efficient",
"costCents": 2,
"createdAt": "2025-01-15T12:00:00.000Z"
}Get the result
Polling
# 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": "image-upscaler",
"modelName": "WaveSpeed AI Image Upscaler",
"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": "image-upscaler",
"modelName": "WaveSpeed AI Image Upscaler",
"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. |
4. Schema
Input
| Parameter | Type | Required | Default | Range | Description |
|---|---|---|---|---|---|
| image | string | Yes | -- | -- | The image you want to upscale.Pass a public image URL. Accepted: JPEG, PNG, GIF, WebP. |
| target_resolution | string | Yes | -- | 2k, 4k, 8k | Choose the resolution you want to upscale to. |
| output_format | string | Yes | -- | jpeg, png, webp | Select the format of the output image. |
| enable_base64_output | boolean | No | -- | -- | If enabled, the output will be encoded into a BASE64 string instead of a URL. |
| enable_sync_mode | boolean | No | -- | -- | If set to true, the function will wait for the result to be generated before returning the response. |
Example request
{
"image": "https://example.com/your-image.jpg",
"target_resolution": "2k",
"output_format": "jpeg",
"enable_base64_output": false,
"enable_sync_mode": false
}Output
{
"id": "550e8400-e29b-41d4-a716-446655440000",
"modelId": "image-upscaler",
"modelName": "WaveSpeed AI Image Upscaler",
"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"
}