Skip to main content
POST
/
dedicated
/
v1
/
images
/
edits
Image edits
curl --request POST \
  --url https://api.friendli.ai/dedicated/v1/images/edits \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "image": "@/path/to/file/image.png",
  "model": "(endpoint-id)",
  "prompt": "Add a red sports car in the foreground."
}
'
{
  "data": [
    {
      "url": "(url-to-edited-image)",
      "seed": 789,
      "response_format": "url"
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://friendli.ai/docs/llms.txt

Use this file to discover all available pages before exploring further.

Given an image and a description, the model edits the image. To request successfully, it is mandatory to enter a Personal API Key (e.g. flp_XXX) value in the Bearer Token field. Refer to the authentication section on our introduction page to learn how to acquire this variable and visit here to generate your API Key.

Authorizations

​
Authorization
string
header
required

When using Friendli Suite API for inference requests, you need to provide a Friendli Token for authentication and authorization purposes.

For more detailed information, please refer here.

Headers

​
X-Friendli-Team
string | null

ID of team to run requests as (optional parameter).

Body

application/json
​
image
ImageInput · object
required

The image(s) to edit. Must be in a supported image format.

​
prompt
string
required

A text description of the desired image(s).

​
model
string
required

ID of target endpoint. If you want to send request to specific adapter, use the format "YOUR_ENDPOINT_ID:YOUR_ADAPTER_ROUTE". Otherwise, you can just use "YOUR_ENDPOINT_ID" alone.

Example:

"(endpoint-id)"

​
num_inference_steps
integer
default:20

The number of inference steps to use during image generation. Defaults to 20. Supported range: [1, 50].

​
guidance_scale
number | null

Adjusts the alignment of the generated image with the input prompt. Higher values (e.g., 8-10) make the output more faithful to the prompt, while lower values (e.g., 1-5) encourage more creative freedom. This parameter may be irrelevant for certain models, such as FLUX.Schnell.

​
seed
integer | null

The seed to use for image generation.

​
response_format
enum<string> | null
default:url

The format in which the generated image(s) will be returned. One of url(default), raw, png, jpeg, and jpg.

Available options:
url,
raw,
png,
jpeg,
jpg

Response

Successfully edited image(s).

​
data
UrlImageItem · object
required
Last modified on April 29, 2026