{"servers":[{"url":"https://api.modellix.ai/api/v1/xai/grok-imagine-image-2.0-edit"}],"post":{"description":"[Core Function] Grok Imagine Image 2.0 Edit edits one to three source images from a text prompt. [Strengths] It supports quality (low or medium), 1k or 2k resolution, and the same aspect ratios as Grok Imagine Image 2.0. [Best For] Highly recommended for: restyling, combining up to 3 references, and iterative refinement. [Limitations] Requires at least one source image; at most 3 images per request. This model does not generate from text alone. [Routing] For text-to-image generation, use Grok Imagine Image 2.0.","operationId":"grokImagineImage20EditAsync","requestBody":{"content":{"application/json":{"examples":{"full_options":{"summary":"Multiple images with options","value":{"aspect_ratio":"16:9","images":["https://example.com/ref1.png","https://example.com/ref2.png"],"prompt":"Blend these references into a single cohesive watercolor scene","quality":"medium","resolution":"2k","response_format":"url"}},"single_image":{"summary":"Single source image","value":{"images":["https://example.com/photo.png"],"prompt":"Render this as a pencil sketch with detailed shading"}}},"schema":{"description":"Edit one to three source images from a text prompt. Pass a single image as a one-element `images` array.","properties":{"aspect_ratio":{"description":"Aspect ratio of the output image. If omitted, the output follows the first input image.","enum":["1:1","16:9","9:16","4:3","3:4","3:2","2:3","2:1","1:2","19.5:9","9:19.5","20:9","9:20","21:9","5:2","auto"],"example":"16:9","type":"string"},"images":{"description":"Source image URLs to edit (1-3). Each item must be a publicly accessible HTTP(S) URL.","example":["https://example.com/photo.png"],"items":{"minLength":1,"type":"string"},"maxItems":3,"minItems":1,"type":"array"},"n":{"default":1,"description":"Number of edited images to generate.","example":1,"maximum":10,"minimum":1,"type":"integer"},"prompt":{"description":"Text description of the edit to apply.","example":"Render this as a pencil sketch with detailed shading","minLength":1,"type":"string"},"quality":{"default":"medium","description":"Generation quality.","enum":["low","medium"],"example":"medium","type":"string"},"resolution":{"default":"1k","description":"Output resolution.","enum":["1k","2k"],"example":"1k","type":"string"},"response_format":{"default":"url","description":"How images are returned: a temporary URL, or base64 in the task result.","enum":["url","b64_json"],"example":"url","type":"string"}},"required":["prompt","images"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"example":{"code":0,"data":{"get_result":{"method":"GET","url":"https://api.modellix.ai/api/v1/tasks/task-xai-i2i-003"},"model_id":"xai/grok-imagine-image-2.0-edit","status":"pending","task_id":"task-xai-i2i-003"},"message":"success"},"schema":{"properties":{"code":{"description":"Response code, 0 indicates success","example":0,"type":"integer"},"data":{"description":"Detailed data about the submitted asynchronous task.","properties":{"get_result":{"description":"API information to query the task result","properties":{"method":{"example":"GET","type":"string"},"url":{"example":"https://api.modellix.ai/api/v1/tasks/task-abc123","type":"string"}},"type":"object"},"model_id":{"description":"Model ID in `provider/model` format","example":"xai/grok-imagine-image-edit","type":"string"},"status":{"description":"Task status","enum":["pending","processing"],"example":"pending","type":"string"},"task_id":{"description":"Unique task identifier for polling","example":"task-abc123","type":"string"}},"required":["status","task_id","model_id"],"type":"object"},"message":{"description":"Response message","example":"success","type":"string"}},"required":["code","message","data"],"type":"object"}}},"description":"Task submitted successfully"},"400":{"content":{"application/json":{"example":{"code":400,"message":"Invalid parameters: parameter 'images' is required"},"schema":{"properties":{"code":{"example":400,"type":"integer"},"message":{"example":"Invalid parameters: parameter 'images' is required","type":"string"}},"required":["code","message"],"type":"object"}}},"description":"Invalid request parameters"},"401":{"content":{"application/json":{"example":{"code":401,"message":"Authentication failed: invalid API key"},"schema":{"properties":{"code":{"example":400,"type":"integer"},"message":{"example":"Invalid parameters: parameter 'images' is required","type":"string"}},"required":["code","message"],"type":"object"}}},"description":"Unauthorized - Invalid or missing API Key"},"429":{"content":{"application/json":{"example":{"code":429,"message":"Rate limit exceeded: 100 requests per minute, retry after 60 seconds"},"schema":{"properties":{"code":{"example":400,"type":"integer"},"message":{"example":"Invalid parameters: parameter 'images' is required","type":"string"}},"required":["code","message"],"type":"object"}}},"description":"Too many requests - Rate limit exceeded","headers":{"X-RateLimit-Limit":{"description":"Maximum requests per minute","schema":{"example":100,"type":"integer"}},"X-RateLimit-Remaining":{"description":"Remaining quota in current window","schema":{"example":0,"type":"integer"}},"X-RateLimit-Reset":{"description":"Rate limit window reset time (Unix timestamp)","schema":{"example":1704067260,"type":"integer"}}}},"500":{"content":{"application/json":{"example":{"code":500,"message":"Internal server error"},"schema":{"properties":{"code":{"example":400,"type":"integer"},"message":{"example":"Invalid parameters: parameter 'images' is required","type":"string"}},"required":["code","message"],"type":"object"}}},"description":"Internal server error"}},"summary":"Grok Imagine Image 2.0 Edit","x-mint":{"href":"xai/grok-imagine-image-2-0-edit"}}}