Skip to main content
POST
/
v1
/
images
/
edits
Image Edit
curl --request POST \
  --url https://api.zarkai.xyz/v1/images/edits \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "prompt": "Render this as a pencil sketch with detailed shading",
  "workspace_id": "wks-xxxxx",
  "file_id": "file-abc123"
}
'
{
  "file_id": "file-img-82f06097-a9ad-4db4-9c8d-8197c74eebd1",
  "name": "pencil-sketch.png",
  "mime_type": "image/png"
}

Authorizations

​
x-api-key
string
header
required

API key for authentication

Body

application/json
​
prompt
string
required

Text description of the edits to apply

​
workspace_id
string
required

Your Space ID

​
file_id
string
required

File ID of the source image to edit

Response

Image edited

​
file_id
string

File ID of the generated image in your Space

​
name
string

Filename

​
mime_type
string

MIME type of the generated image