Skip to main content
POST
Generate image with Grok Imagine

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