Sign in

v1

latestOpenAPI 3.1.02026-07-2611077199.5 KB

Edit images

post/grok/image/edits

Request body

promptstring required

Prompt

model'grok-imagine-1.0-edit' | 'grok-imagine-image' | 'grok-imagine-image-quality'

Image editing model.

refer_imagesstring[]

Reference image list, currently only one image is supported

aspect_ratio'1:1' | '16:9' | '9:16' | '3:2' | '2:3' | '4:3' | '3:4' | '2:1' | '1:2' | '19.5:9' | '9:19.5' | '20:9' | '9:20' | 'auto'

Output aspect ratio; determined by model if not provided. grok-imagine-1.0-edit supports: 1:1 (social media, avatars, thumbnails), 16:9 (landscape images, covers, desktop backgrounds), 9:16 (mobile portrait, short video covers, Stories), 3:2 (landscape photography), 2:3 (portrait photography, posters). grok-imagine-image and grok-imagine-image-quality additionally support: 4:3 (presentations, traditional landscape), 3:4 (portraits, vertical design), 2:1 (horizontal banners, headers), 1:2 (vertical banners, long images), 19.5:9 (horizontal smartphone screens), 9:19.5 (vertical smartphone wallpapers), 20:9 (horizontal ultra-wide screens), 9:20 (vertical ultra-wide screens), auto (model automatically selects ratio based on prompt).

resolution'1k' | '2k'

Output resolution. 1k is standard (all models); 2k is higher resolution (only grok-imagine-image and grok-imagine-image-quality).

ninteger

Number of images to generate, range: 1 - 4

hook_urlstring

Callback URL. The system will send a notification to this URL when the task is completed or failed. The notification data structure is consistent with the <a href="fetch" target="_self">fetch structure</a>. If not set, you need to call the <a href="fetch" target="_self">fetch endpoint</a> to query the result

Example request

{
  "refer_images": [
    "https://cdn.ttapi.io/grok/2026-03-30/bd61449e07eb46a5ac8870651f374e50.jpg"
  ],
  "hook_url": "https://example.com/callback"
}

Response

Request successful

statusstring required
messagestring required
dataobject required

Example response

{
  "status": "SUCCESS",
  "message": "success",
  "data": {
    "jobId": "jobId"
  }
}