Grok Imagine API reference
Check Grok Imagine availability, inputs, parameters, file requirements, credit pricing, and request examples for Rivya Public API v1. Model ID: grok-imagine.
grok-imagine
text, file
Required for reference modes
Credit rate: 4–5 per request The final cost is rounded up to whole credits.
Image
FIXED
5000 characters
Request fields
Set model at the top level. Put model-specific controls and reference inputs in params, using the format documented for this model.
| Key | Type | Required | Default | Description |
|---|---|---|---|---|
| model | string | Yes | grok-imagine | Set model to grok-imagine. |
| prompt | string | Yes | - | Maximum 5000 characters for this model. |
| params | object | No | - | The model-specific params object. Use the documented keys and reference-file format for this model. |
| client_request_id | string | No | - | Optional ID for tracing this request in your system. It does not replace Idempotency-Key. |
Model parameters
| Key | Type | Required | Default | Range | Options | Description |
|---|---|---|---|---|---|---|
| aspect_ratio | select | No | 1:1 | - | 1:1, 2:3, 3:2, 16:9, 9:16 | Aspect ratio |
| nsfw_checker | select | No | false | - | false, true | Enable the model's optional content filter. No automated filter can guarantee complete coverage. |
| enable_pro | select | No | false | - | false, true | This is the Grok Imagine quality toggle for text-to-image only. Standard is cheaper, while Quality leans toward more detail; the current image-edit path does not use it. |
Upload policy
Upload reference files through Files API first. Keep the original URLs, verified metadata, and tokens. Follow this model's request example: some models use params.referenceMediaItems, while others use different fields.
Reference image: Upload up to 1 image file for image projects.
1
image
When duration verification is required, use duration_token from /api/v1/files as durationToken in the request. Keep any additional signed metadata this model requires.
| kind | Max size | MIME types |
|---|---|---|
| image | 10 MB | image/jpeg, image/png, image/webp |
Minimal request
{
"model": "grok-imagine",
"prompt": "A product bottle on a light gray background, lit softly from the left.",
"params": {
"aspect_ratio": "1:1",
"nsfw_checker": "false",
"enable_pro": "false"
}
}Reference-file request
{
"model": "grok-imagine",
"prompt": "A product bottle on a light gray background, lit softly from the left.",
"params": {
"aspect_ratio": "1:1",
"nsfw_checker": "false",
"enable_pro": "false",
"referenceMediaItems": [
{
"url": "https://cdn.example.com/reference-image.png",
"kind": "image",
"name": "reference-image.png",
"mimeType": "image/png"
}
]
}
}Example response
An accepted generation request returns a task ID. Poll the status endpoint until the task succeeds or fails. A status request failure does not mean generation failed.
{
"id": "task_grok_imagine_example",
"status": "queued",
"model": "grok-imagine",
"reserved_credits": 4,
"final_credits": 0,
"settlement_status": "RESERVED",
"created_at": "2026-05-11T00:00:00.000Z",
"updated_at": "2026-05-11T00:00:00.000Z",
"result": null,
"error": null
}Common errors
validation_failed, insufficient_credits, idempotency_conflict, rate_limited, not_found
Some modes require Files API reference uploads.
