Grok Imagine - image to image

This page is generated from the upstream official OpenAPI documentation. Endpoints, parameters and examples match the official docs; brand and API domain are replaced with ModelFold.

Endpoint

POST /jobs/createTask

Full URL: https://ai.modelfold.online/v1/jobs/createTask

Authentication: every request must include the Authorization: Bearer <API_KEY> header.

Content generation using grok-imagine/image-to-image

File Upload Requirements

Before using the Image-to-Image API, you need to upload your reference image:

Step 1 · Upload Reference Image

Use the File Upload API to upload your reference image.

File Upload API — Learn how to upload images and get file URLs

Requirements:

File Type: JPEG, PNG, or WebP format
Max File Size: 10MB per file
Content: Image you want to use as reference for generation

Step 2 · Get File URL

After upload, you'll receive a file URL that you can use in the image_urls parameter.

WARNING

Supported formats: JPEG, PNG, WebP (Max: 10MB)

Query Task Status

After submitting a task, use the unified query endpoint to check progress and retrieve results:

Get Task Details — Learn how to query task status and retrieve generation results

TIP

For production use, we recommend using the callBackUrl parameter to receive automatic notifications when generation completes, rather than polling the status endpoint.

Market Overview — Explore all available models
Common API — Check credits and account usage

Request Parameters

Body (application/json)

Parameter	Type	Required	Description
`model`	`string`	Yes	The model name to use for generation. Required field. - Must be `grok-imagine/image-to-image` for this endpoint Default：`"grok-imagine/image-to-image"`。 Allowed values：`grok-imagine/image-to-image`。示例：`grok-imagine/image-to-image`。
`callBackUrl`	`string`	No	The URL to receive generation task completion updates. Optional but recommended for production use. - System will POST task status and results to this URL when generation completes - Callback includes generated content URLs and task information - Your callback endpoint should accept POST requests with JSON payload containing results - Alternatively, use the Get Task Details endpoint to poll task status - To ensure callback security, see Webhook Verification Guide for signature verification implementation 示例：`https://your-domain.com/api/callback`。
`input`	`object`	No	Input parameters for the generation task
`input.prompt`	`string`	No	A text description specifying the desired content or style of the generated image. (Max length: 390000 characters) 示例：Recreate the Titanic movie poster with two adorable anthropomorphic cats in the same romantic pose at the bow of the ship. The male cat is an orange tabby wearing a vest, standing behind a white long-haired female cat in a lace dress, holding her paws as they stretch forward in the wind. Both cats are photorealistic with detailed fur, wind-swept hair, and dramatic sunset lighting (warm golden highlights, cool blue shadows). Background: the Titanic ship at dusk with four smokestacks, glowing deck lights, calm ocean, and orange-pink sunset sky. Center title: “CATANIC” in the same gold metallic serif style as Titanic, same size and position.。
`input.image_urls`	`array<string>`	Yes	1–5 image URLs. (Use file URLs after upload, not raw file content. Accepted types: image/jpeg, image/png, image/webp. Max size: 10.0MB per image.) In your prompt, reference the uploaded image by typing @image(n) followed by a space (for example: @image1 a sunset over the ocean).
`input.nsfw_checker`	`boolean`	No	Defaults to false. When false, no additional content filtering is applied and results are returned directly by the model.

Request Example

bash

curl -X POST "https://ai.modelfold.online/v1/jobs/createTask" \
  -H "Authorization: Bearer $MODELFOLD_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "model": "grok-imagine/image-to-image",
  "callBackUrl": "https://your-domain.com/api/callback",
  "input": {
    "prompt": "Recreate the Titanic movie poster with two adorable anthropomorphic cats in the same romantic pose at the bow of the ship. The male cat is an orange tabby wearing a vest, standing behind a white long-haired female cat in a lace dress, holding her paws as they stretch forward in the wind. Both cats are photorealistic with detailed fur, wind-swept hair, and dramatic sunset lighting (warm golden highlights, cool blue shadows). Background: the Titanic ship at dusk with four smokestacks, glowing deck lights, calm ocean, and orange-pink sunset sky. Center title: “CATANIC” in the same gold metallic serif style as Titanic, same size and position.",
    "image_urls": [
      "https://static.aiquickdraw.com/tools/example/1767602105243_0MmMCrwq.png"
    ]
  }
}'

json

{
  "model": "grok-imagine/image-to-image",
  "callBackUrl": "https://your-domain.com/api/callback",
  "input": {
    "prompt": "Recreate the Titanic movie poster with two adorable anthropomorphic cats in the same romantic pose at the bow of the ship. The male cat is an orange tabby wearing a vest, standing behind a white long-haired female cat in a lace dress, holding her paws as they stretch forward in the wind. Both cats are photorealistic with detailed fur, wind-swept hair, and dramatic sunset lighting (warm golden highlights, cool blue shadows). Background: the Titanic ship at dusk with four smokestacks, glowing deck lights, calm ocean, and orange-pink sunset sky. Center title: “CATANIC” in the same gold metallic serif style as Titanic, same size and position.",
    "image_urls": [
      "https://static.aiquickdraw.com/tools/example/1767602105243_0MmMCrwq.png"
    ]
  }
}

Response

200 — Request successful

json

{
  "code": 200,
  "msg": "success",
  "data": {
    "taskId": "task_grok-imagine_1767694553297"
  }
}

Callback

onImageGenerated

Callback URL: {$request.body#/callBackUrl} (the callBackUrl in the request body).

Sent when the task succeeds or fails.

Callback body parameters

参数	类型	必填	说明
`code`	`integer`	否	200: success. 501: failure; see data.failCode and data.failMsg. Allowed values：`200` / `501`。示例：`200`。
`msg`	`string`	否	Status message 示例：`Playground task completed successfully.`。
`data`	`object`	否	—
`data.completeTime`	`integer`	否	Task completion time, represented as a Unix timestamp in milliseconds 示例：`1786431871000`。
`data.costTime`	`integer`	否	Processing time in seconds. Present on both success and failure callbacks. 示例：`11`。
`data.createTime`	`integer`	否	Task creation time, represented as a Unix timestamp in milliseconds 示例：`1786431859000`。
`data.creditsConsumed`	`number`	否	Credits consumed by the task; 0 for failed tasks. 示例：`4`。
`data.model`	`string`	否	Image-to-image model used for the task 示例：`grok-imagine/image-to-image`。
`data.param`	`string`	否	Parameters submitted when creating the task, in JSON string format 示例：{"input":"{\"image_urls\":[\"https://static.aiquickdraw.com/tools/example/1767602105243_0MmMCrwq.png\"],\"prompt\":\"Recreate the Titanic movie poster with two adorable anthropomorphic cats in the same romantic pose at the bow of the ship. The male cat is an orange tabby wearing a vest, standing behind a white long-haired female cat in a lace dress, holding her paws as they stretch forward in the wind. Both cats are photorealistic with detailed fur, wind-swept hair, and dramatic sunset lighting (warm golden highlights, cool blue shadows). Background: the Titanic ship at dusk with four smokestacks, glowing deck lights, calm ocean, and orange-pink sunset sky. Center title: \\\"CATANIC\\\" in the same gold metallic serif style as Titanic, same size and position.\"}","callBackUrl":"https://your-domain.com/api/callback","model":"grok-imagine/image-to-image"}。
`data.resultJson`	`string`	否	Image generation result in JSON string format. resultUrls contains the list of generated image URLs. Present only when state is success. 示例：`{"resultUrls":["https://tempfile.aiquickdraw.com/g/users/9a2eef47-0997-4343-8b25-8ff800ae0529/generated/e51cd53b-736a-4742-858b-f2b8fbe5998a/image.jpg"]}`。
`data.state`	`string`	否	Task status Allowed values：`success` / `fail`。示例：`success`。
`data.taskId`	`string`	否	Task ID 示例：`9c6b5b687460e9fc898baff13649c2cf`。
`data.updateTime`	`integer`	否	Use completeTime as the completion time; updateTime may equal createTime. 示例：`1786431871000`。
`data.failCode`	`string`	否	Failure code, a numeric string such as "400" or "500". Present only when state is fail. 示例：`500`。
`data.failMsg`	`string`	否	Failure reason. Present only when state is fail. 示例：`<error detail>`。

Task completed successfully

json

{
  "code": 200,
  "msg": "Playground task completed successfully.",
  "data": {
    "taskId": "9c6b5b687460e9fc898baff13649c2cf",
    "model": "grok-imagine/image-to-image",
    "state": "success",
    "param": "{\"input\":\"{\\\"image_urls\\\":[\\\"https://static.aiquickdraw.com/tools/example/1767602105243_0MmMCrwq.png\\\"],\\\"prompt\\\":\\\"Recreate the Titanic movie poster with two adorable anthropomorphic cats in the same romantic pose at the bow of the ship. The male cat is an orange tabby wearing a vest, standing behind a white long-haired female cat in a lace dress, holding her paws as they stretch forward in the wind. Both cats are photorealistic with detailed fur, wind-swept hair, and dramatic sunset lighting (warm golden highlights, cool blue shadows). Background: the Titanic ship at dusk with four smokestacks, glowing deck lights, calm ocean, and orange-pink sunset sky. Center title: \\\\\\\"CATANIC\\\\\\\" in the same gold metallic serif style as Titanic, same size and position.\\\"}\",\"callBackUrl\":\"https://your-domain.com/api/callback\",\"model\":\"grok-imagine/image-to-image\"}",
    "resultJson": "{\"resultUrls\":[\"https://tempfile.aiquickdraw.com/g/users/9a2eef47-0997-4343-8b25-8ff800ae0529/generated/e51cd53b-736a-4742-858b-f2b8fbe5998a/image.jpg\"]}",
    "costTime": 11,
    "createTime": 1786431859000,
    "completeTime": 1786431871000,
    "updateTime": 1786431871000,
    "creditsConsumed": 4
  }
}

Task failed

json

{
  "code": 501,
  "msg": "Playground task failed.",
  "data": {
    "taskId": "9c6b5b687460e9fc898baff13649c2cf",
    "model": "grok-imagine/image-to-image",
    "state": "fail",
    "param": "{\"input\":\"{\\\"image_urls\\\":[\\\"https://static.aiquickdraw.com/tools/example/1767602105243_0MmMCrwq.png\\\"],\\\"prompt\\\":\\\"Recreate the Titanic movie poster with two adorable anthropomorphic cats in the same romantic pose at the bow of the ship. The male cat is an orange tabby wearing a vest, standing behind a white long-haired female cat in a lace dress, holding her paws as they stretch forward in the wind. Both cats are photorealistic with detailed fur, wind-swept hair, and dramatic sunset lighting (warm golden highlights, cool blue shadows). Background: the Titanic ship at dusk with four smokestacks, glowing deck lights, calm ocean, and orange-pink sunset sky. Center title: \\\\\\\"CATANIC\\\\\\\" in the same gold metallic serif style as Titanic, same size and position.\\\"}\",\"callBackUrl\":\"https://your-domain.com/api/callback\",\"model\":\"grok-imagine/image-to-image\"}",
    "costTime": 11,
    "createTime": 1786431859000,
    "completeTime": 1786431871000,
    "updateTime": 1786431871000,
    "creditsConsumed": 0,
    "failCode": "500",
    "failMsg": "<error detail>"
  }
}

Grok Imagine - image to image ​

Endpoint ​

File Upload Requirements ​

Query Task Status ​

Related Resources ​

Request Parameters ​

Body (application/json) ​

Request Example ​

Response ​

200 — Request successful ​

Callback ​

onImageGenerated ​

Grok Imagine - image to image

Endpoint

File Upload Requirements

Query Task Status

Related Resources

Request Parameters

Body (application/json)

Request Example

Response

200 — Request successful

Callback

onImageGenerated