Skip to main content
POST
  1. Submit the request with VIDGO_API_KEY. A task_id is returned immediately. Keep it until the task reaches finished or failed.
  2. Use Query Task Status to retrieve the result. If you provide a callback_url, Vidgo sends the result to your webhook when the task finishes or fails.

Grok Imagine Edit

Reimagine an existing image with Grok Imagine, using text to guide changes to the subject, setting, or visual style.

Available Models

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

Output Options

Image Size

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

Key Features

  • Edit images using a prompt and image references.
  • Accepts exactly 1 image in image_urls.

Advanced Parameters

Set model and optional callback_url at the request root. Place all workflow parameters, including output options, inside input. Use the input fields listed below. Supply publicly accessible HTTP(S) URLs for reference images.

Prompt

  • prompt: Required. Describe the requested changes. Length: 1-5,000 characters.

Image URLs

  • image_urls: Required. Provide publicly accessible image URLs. Supply exactly 1 item. Use JPEG, PNG, or WebP, up to 10 MB.

Authorizations

Authorization
string
header
required

Use VIDGO_API_KEY.

Body

application/json

Set model and callback_url at the request root. Place generation parameters inside input.

model
string
required
Example:

"xai/grok-imagine-image/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