Skip to main content
POST
/
images
/
grok-imagine-image
Generate image with Grok Imagine
curl --request POST \
  --url https://api.budgetpixel.com/v1/images/grok-imagine-image \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "prompt": "<string>",
  "aspect_ratio": "1:1",
  "num_images": 1,
  "reference_images": [
    "<string>"
  ],
  "size": "1K"
}
'
import requests

url = "https://api.budgetpixel.com/v1/images/grok-imagine-image"

payload = {
"prompt": "<string>",
"aspect_ratio": "1:1",
"num_images": 1,
"reference_images": ["<string>"],
"size": "1K"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
prompt: '<string>',
aspect_ratio: '1:1',
num_images: 1,
reference_images: ['<string>'],
size: '1K'
})
};

fetch('https://api.budgetpixel.com/v1/images/grok-imagine-image', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api.budgetpixel.com/v1/images/grok-imagine-image",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'prompt' => '<string>',
'aspect_ratio' => '1:1',
'num_images' => 1,
'reference_images' => [
'<string>'
],
'size' => '1K'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"strings"
"net/http"
"io"
)

func main() {

url := "https://api.budgetpixel.com/v1/images/grok-imagine-image"

payload := strings.NewReader("{\n \"prompt\": \"<string>\",\n \"aspect_ratio\": \"1:1\",\n \"num_images\": 1,\n \"reference_images\": [\n \"<string>\"\n ],\n \"size\": \"1K\"\n}")

req, _ := http.NewRequest("POST", url, payload)

req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://api.budgetpixel.com/v1/images/grok-imagine-image")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"prompt\": \"<string>\",\n \"aspect_ratio\": \"1:1\",\n \"num_images\": 1,\n \"reference_images\": [\n \"<string>\"\n ],\n \"size\": \"1K\"\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.budgetpixel.com/v1/images/grok-imagine-image")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"prompt\": \"<string>\",\n \"aspect_ratio\": \"1:1\",\n \"num_images\": 1,\n \"reference_images\": [\n \"<string>\"\n ],\n \"size\": \"1K\"\n}"

response = http.request(request)
puts response.read_body
{
  "id": "img_a1b2c3d4e5f6",
  "message": "<string>",
  "model": "<string>"
}
{
"error": {
"code": "model_not_available",
"message": "<string>",
"type": "invalid_request_error"
}
}
{
"error": {
"code": "model_not_available",
"message": "<string>",
"type": "invalid_request_error"
}
}
{
"error": {
"code": "model_not_available",
"message": "<string>",
"type": "invalid_request_error"
}
}
{
"error": {
"code": "model_not_available",
"message": "<string>",
"type": "invalid_request_error"
}
}

Authorizations

Authorization
string
header
required

API key as a bearer token: Authorization: Bearer bpx_live_xxx

Body

application/json
prompt
string
required

Text description of the image to generate.

aspect_ratio
enum<string>
default:1:1

Output aspect ratio.

Available options:
1:1,
16:9,
9:16,
4:3,
3:4,
3:2,
2:3,
2:1,
1:2,
auto,
match_input_image
num_images
integer
default:1

Number of images to generate.

Required range: 1 <= x <= 4
reference_images
string[]

Optional reference images (up to 3) for image editing. Each item is a public image URL, a data URI, raw base64, or an uploaded-file URL from POST /v1/uploads. Omit for text-to-image. Use aspect_ratio "match_input_image" (or "auto") to let the model follow the input.

Maximum array length: 3
size
enum<string>
default:1K

Output resolution tier. Both tiers bill the same 35 credits per image.

Available options:
1K,
2K

Response

Job accepted.

id
string

Opaque job id — use it to poll status.

Example:

"img_a1b2c3d4e5f6"

message
string
model
string
status
enum<string>

Lifecycle state. succeeded/failed/timeout are terminal.

Available options:
pending,
starting,
processing,
completing,
succeeded,
failed,
timeout