Grok Imagine Image 2.0 | BeatAPI API Documentation

curl -X POST https://api.beatapi.io/v1/images/tasks \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "model": "grok-imagine-image-2.0",
  "prompt": "Bold launch campaign visual with cinematic contrast.",
  "aspect_ratio": "1:1"
}'

{
  "data": {
    "capability_id": "grok-imagine-image-2.0",
    "capability_version": null,
    "completed_at": null,
    "created_at": 1782210000,
    "error_code": null,
    "error_message": null,
    "id": "task_8K2qA",
    "media_type": "image",
    "model": "grok-imagine-image-2.0",
    "object": "task",
    "output": null,
    "request_id": "req_abc123",
    "stage": "queued",
    "status": "queued",
    "task_kind": "image",
    "updated_at": 1782210000,
    "usage": {
      "credits_charged": 0.03,
      "credits_refunded": 0,
      "credits_reserved": 0.03,
      "credits_settled": 0
    }
  }
}

Generate or edit one image from text and up to five public HTTPS reference images, with automatic edit-mode selection.

Supported modes

Mode	Required input	Rules
Text to image	`model`, `prompt`	Omit `images`.
Reference image	`model`, `prompt`, `images`	Provide 1–5 public HTTPS image URLs.

Async flow: Create the task, save data.id, then poll the Task with GET /v1/tasks/{task_id}. On succeeded, read data.output.media. On failed, read data.error_code and data.error_message, then follow the error and retry policy.

Using a local file? upload a local input first and pass the returned data.url.

Generate or edit one image from text and up to five public HTTPS reference images, with automatic edit-mode selection. ### Supported modes | Mode | Required input | Rules | | --- | --- | --- | | Text to image | `model`, `prompt` | Omit `images`. | | Reference image | `model`, `prompt`, `images` | Provide 1–5 public HTTPS image URLs. | **Async flow:** Create the task, save `data.id`, then [poll the Task](/quick-guide#get-task-status) with `GET /v1/tasks/{task_id}`. On `succeeded`, read `data.output.media`. On `failed`, read `data.error_code` and `data.error_message`, then follow the [error and retry policy](/quick-guide#errors-and-retry-policy). **Using a local file?** [upload a local input](/quick-guide#upload-an-input-file) first and pass the returned `data.url`.

Authentication

AuthorizationBearer

Send your API key as Authorization: Bearer <BEATAPI_API_KEY>.

Request

This endpoint expects an object.

model"grok-imagine-image-2.0"Required

Must be grok-imagine-image-2.0.

promptstringRequired1-5000 characters

Generation or image-editing instructions.

imageslist of stringsOptional

Public HTTPS reference-image URLs. Omit for text-to-image.

aspect_ratioenumOptionalDefaults to 1:1

Output image aspect ratio. auto requires at least one image.

Response

Image generation task accepted

Errors

400

Bad Request Error

401

Unauthorized Error

402

Payment Required Error

409

Conflict Error

429

Too Many Requests Error

Supported modes

Authentication

Headers

Request

Response

Errors

Supported modes