Theme
Edit image
POST
https://www.kkiai.com/v1/images/edits
Request Parameters
Header Parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
Authorization | string | Optional | Bearer {{YOUR_API_KEY}} |
Body Parameters (multipart/form-data)
| Parameter | Type | Required | Description |
|---|---|---|---|
model | string | Required | The model used to generate images. |
prompt | string | Required | |
image | file | Required | The image to edit. Supports uploading 1 image. |
aspect_ratio | string | Optional | [Optional parameter] Aspect ratio "1:1" | "3:4" | "4:3" | "9:16" | "16:9" | "2:3" | "3:2" | "9:19.5" | "19.5:9" | "9:20" | "20:9" | "1:2" | "2:1" | "auto" |
response_format | string | Optional | [Optional parameter] Output format b64_json or url |
resolution | string | Optional | [Optional parameter] Resolution "1k" | "2k" |
quality | string | Optional | [Optional parameter] Quality "low" | "medium" | "high" |
n | integer | Optional | [Optional parameter] Number of output images. Default is 1, maximum is 10. |
cURL Example
bash
curl --location --request POST 'https://www.kkiai.com/v1/images/edits' \
--header 'Authorization: Bearer <token>' \
--form 'model="grok-3-image"' \
--form 'prompt="Add a small duck to the image."' \
--form 'image=@"C:/Users/ly/Pictures/image-edit-2.webp"' \
--form 'n="1"'Response
🟢 200 Success
Response Example
json
{
"created": 1773127037,
"data": [
{
"url": "https://pub-85624410c6c44bdb802187ae2bd8afff.r2.dev/grok/8903fc79-152b-4b80-b384-d74ae6775b07.jpg"
}
],
"usage": {
"generated_images": 1,
"output_tokens": 16384,
"total_tokens": 16384
}
}