Skip to main content
← Grok Image Model name: grok-imagine-image/v2.0/edit
Generation type: image_to_image
Endpoint: POST /api/asset_generator/

Pricing

Prices are per output. When a request asks for several outputs, the charge is this price times the number of outputs.

Quick start

The example uses sample media from our CDN. Swap in publicly accessible URLs for your own files.

Input parameters

Send these fields in input_params.
string
required
The text prompt describing the desired edit.Minimum characters: 3. Maximum characters: 8000.
string[]
required
List of URLs of input images for editing. Up to 3 reference images.Minimum items: 1. Maximum items: 3.
string
default:"auto"
Aspect ratio of the edited image. ‘auto’ preserves the first input image’s aspect ratio.Allowed values: "auto", "1:1", "16:9", "9:16", "4:3", "3:4", "3:2", "2:3", "2:1", "1:2", "20:9", "19.5:9", "9:19.5", "9:20".
string
default:"1k"
Output resolution.Allowed values: "1k", "2k".
string
default:"medium"
Quality level of the edited image.Allowed values: "low", "medium".
integer
default:1
Number of images to generate.Minimum: 1. Maximum: 4.

Response

The request returns the task with status: "initializing". Poll GET /api/asset_generator/{id}/ until status is done or failed, or pass a webhook_url to be notified. A finished task lists its files in assets and the credits it charged in credits_used.