Skip to main content
POST
  1. After submission, a task_id will be returned. If you provided a callback_url, when the task status becomes finished or failed, a POST request will be sent to the callback_url.
  2. Regardless of whether callback_url is provided, you can retrieve the result through the unified Query Task Status endpoint.
Refine images with Grok Imagine Image 2.0, combining reference images and precise instructions to preserve subjects while changing visual details.

Models

  • xai/grok-imagine-image-v2.0/edit - Edit images using a prompt and image references.

Features

  • Edit images using a prompt and image references.
  • Accepts 1-3 images in image_urls.
  • Choose from 1K, 2K output resolutions.
  • Control the number of output images with n.

Output Options

Aspect Ratio

  • aspect_ratio: Optional. Accepted values: 1:1, 2:3, 3:2, 9:16, 16:9. Default: 1:1.

Resolution

  • resolution: Optional. Accepted values: 1K, 2K. Default: 1K.

Quality

  • quality: Optional. Accepted values: low, medium. Default: medium.

Image Count

  • n: Optional. Number of images to generate. Integer from 1 to 4. Default: 1.

Advanced Parameters

Set model and optional callback_url at the request root. Place all workflow parameters, including output options, inside input. Send only the input fields supported by this workflow. Unsupported input fields are rejected before credits are deducted. Input URLs must use HTTP(S), include a hostname, and contain no embedded credentials.

Prompt

  • prompt: Required. Describe the requested changes. Length: 1-8,000 characters.
  • The value must not be blank when supplied.

Image URLs

  • image_urls: Required. Provide publicly accessible image URLs. Supply 1-3 items. Each item must be an HTTP(S) URL.

Billing Factors

Billing depends on output quality (quality), output resolution (resolution), and output image count (n). Input image count (image_urls) adds a separate charge once per request; this charge is not multiplied by n. Credits are deducted on submission and refunded if the task fails.

Authorizations

Authorization
string
header
required

Use VIDGO_API_KEY.

Body

application/json

Keep model and callback_url at the root. Unknown root fields are ignored; unsupported input fields are rejected.

model
string
required
Example:

"xai/grok-imagine-image-v2.0/edit"

input
object
required
callback_url
string | null

Optional public HTTP(S) endpoint for task completion notifications. HTTPS is recommended. Omit, use null, or use an empty string to disable callbacks.

Response

Task submitted

code
enum<integer>
required
Available options:
200
data
object
required