Grok Imagine Image 2.0 Text 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.

Create Task

Use this endpoint to create a new image generation task with Grok Imagine Image 2.0.

• Get Task Details — After submitting a task, use the unified task detail endpoint to check progress and retrieve generated images

TIP

For production use, we recommend providing the callBackUrl parameter so your service can receive task completion notifications instead of polling for task status.

Related Resources

• Model Market — Browse all available models and capabilities
• Common API — View account credits and usage

Request Parameters

Body (application/json)

Parameter	Type	Required	Description
model	string	Yes	The model name used for generation. This field is required. This endpoint must use the grok-imagine-image-2-0/text-to-image model. Default："grok-imagine-image-2-0/text-to-image"。 Allowed values：grok-imagine-image-2-0/text-to-image。 示例：grok-imagine-image-2-0/text-to-image。
callBackUrl	string	No	Callback URL for task completion notifications. Optional parameter. If provided, the system will send a POST request to this URL when the task completes, whether it succeeds or fails. If omitted, no callback notification will be sent. 示例：https://your-domain.com/api/callback。
input	object	Yes	Input parameters for the image generation task.
input.prompt	string	Yes	Text prompt describing the desired image. This field is required. Up to 8,000 characters. 示例：A small wooden cabin beside a calm lake at sunrise, soft mist over the water。
input.aspect_ratio	string	Yes	Specifies the width-to-height ratio of the generated image. Controls the aspect ratio of the output. This field is required. Allowed values：1:1 / 2:3 / 3:2 / 16:9 / 9:16。 示例：1:1。

Request Example

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-2-0/text-to-image",
  "callBackUrl": "https://your-domain.com/api/callback",
  "input": {
    "prompt": "A small wooden cabin beside a calm lake at sunrise, soft mist over the water",
    "aspect_ratio": "1:1"
  }
}'

{
  "model": "grok-imagine-image-2-0/text-to-image",
  "callBackUrl": "https://your-domain.com/api/callback",
  "input": {
    "prompt": "A small wooden cabin beside a calm lake at sunrise, soft mist over the water",
    "aspect_ratio": "1:1"
  }
}

Response

200 — Request successful

参数	类型	必填	说明
data	object	否	—
data.taskId	string	否	Task ID used to query task status and results.

{
  "code": 200,
  "msg": "success",
  "data": {
    "taskId": "task_grok_imagine_image_2_0_12345678"
  }
}

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	否	Task completion details and generated image results.
data.completeTime	integer	否	Task completion time, represented as a Unix timestamp in milliseconds.
data.costTime	integer	否	Processing time in seconds. Present on both success and failure callbacks.
data.createTime	integer	否	Task creation time, represented as a Unix timestamp in milliseconds.
data.creditsConsumed	number	否	Credits consumed by the task; 0 for failed tasks.
data.model	string	否	Image generation model used for the task. 示例：grok-imagine-image-2-0/text-to-image。
data.param	string	否	Parameters submitted when creating the task, in JSON string format.
data.resultJson	string	否	Image generation result in JSON string format. The result URLs are contained in the resultUrls property. Present only when state is success. 示例：{"resultUrls":["https://example.com/generated-image-1.jpg"]}。
data.state	string	否	Task status. Allowed values：success / fail。 示例：success。
data.taskId	string	否	Task ID. 示例：task_grok_imagine_image_2_0_12345678。
data.updateTime	integer	否	Use completeTime as the completion time; updateTime may equal createTime.
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

{
  "code": 200,
  "msg": "Playground task completed successfully.",
  "data": {
    "taskId": "task_grok_imagine_image_2_0_12345678",
    "model": "grok-imagine-image-2-0/text-to-image",
    "state": "success",
    "resultJson": "{\"resultUrls\":[\"https://example.com/generated-image-1.jpg\"]}"
  }
}

Task failed

{
  "code": 501,
  "msg": "Playground task failed.",
  "data": {
    "taskId": "task_grok_imagine_image_2_0_12345678",
    "model": "grok-imagine-image-2-0/text-to-image",
    "state": "fail",
    "failCode": "500",
    "failMsg": "<error detail>",
    "creditsConsumed": 0
  }
}