Edit

Edit is a versatile post-processing endpoint that preserves identity and product fidelity while executing freeform instructions. Use it to change poses or viewpoints for extra angles, style a shot with accessories or lighting, or fix issues in Product to Model or Model Swap outputs.

Model Specifications

Model Name: edit
Lifecycle: experimental
Processing Time: 12 seconds
Credits: 1

Request

Refine images by submitting the source image and edit instructions to the universal /v1/run endpoint:

POST`https://api.fashn.ai/v1/run`

Request Examples

curl -X POST https://api.fashn.ai/v1/run \
     -H "Content-Type: application/json" \
     -H "Authorization: Bearer YOUR_API_KEY" \
     -d '{
           "model_name": "edit",
           "inputs": {
             "image": "https://example.com/model.jpg",
             "prompt": "turn the model slightly to the left, add a black leather crossbody bag, soft daylight studio lighting"
           }
         }'

Response

Returns a prediction ID for status polling:

{
  "id": "123a87r9-4129-4bb3-be18-9c9fb5bd7fc1-u1",
  "error": null
}

Request Parameters

`image`
Required
image URL | base64

Source image to refine. The model preserves subject identity and product details while applying the requested edits.

`prompt`
Required
string

Freeform instructions for the edits you want to apply, ideal for pose or view adjustments, styling (accessories, lighting, environment), or small fixes to existing outputs.

`seed`integer

Sets random operations to a fixed state. Use the same seed to reproduce results with the same inputs, or different seed to force different results.

Default: 42
Range: 0 to 2^32 - 1

`output_format`'png' | 'jpeg'

Specifies the output image format.

-png: Delivers the highest quality image, ideal for use cases such as content creation where quality is paramount.
-jpeg: Provides a faster response with a slightly compressed image, more suitable for real-time applications.

Default: png

`return_base64`boolean

When set to true, the API will return the generated image as a base64-encoded string instead of a CDN URL. The base64 string will be prefixed according to the output_format (e.g., data:image/png;base64,... or data:image/jpeg;base64,...).

This option offers enhanced privacy as user-generated outputs are not stored on our servers when return_base64 is enabled.

Default: false

Response Polling

After submitting your request, poll the status endpoint using the returned prediction ID. See API Fundamentals for complete polling details.

Successful Response

When your edit completes successfully, the status endpoint will return:

{
  "id": "123a87r9-4129-4bb3-be18-9c9fb5bd7fc1-u1",
  "status": "completed",
  "output": [
    "https://cdn.fashn.ai/123a87r9-4129-4bb3-be18-9c9fb5bd7fc1-u1/output_0.png"
  ],
  "error": null
}

The output array contains URLs to your edited images, which follow your instructions while preserving product and subject fidelity.

Runtime Errors

Edit may encounter the following model-specific errors during processing:

Name	Cause	Solution
`ImageLoadError`	The pipeline was unable to load the input image from the provided inputs.	For Image URLs: Ensure the URL is publicly accessible and not restricted by permissions. Verify that the Content-Type header specifies the correct image format (e.g., image/jpeg, image/png). For Base64-encoded images: Prefix the string with data:image/`format`;base64, where format is the image type (e.g., jpeg, png).
`ContentModerationError`	Prohibited content detected in the provided image or edit prompt.	Review your input image and edit prompt to ensure they comply with content policies. Explicit or inappropriate imagery is prohibited, particularly when involving human subjects. Rephrasing an instruction with more considerate fashion terminology can often resolve the issue. If you believe your content was incorrectly flagged, contact support@fashn.ai with the prediction ID.
`ThirdPartyError`	A third-party processor failed or refused to handle the request.	FASHN AI relies on external providers for tasks like captioning, moderation, and compute. These services can fail, be unavailable, or experience heavy load. Please retry, and if the issue persists, contact support@fashn.ai.
`PipelineError`	An unexpected error occurred during the execution of the pipeline.	Retry the request (you will not be charged for failed attempts). If the issue persists, please reach out to us at support@fashn.ai and include the prediction ID from the failed attempt to help us locate and address the issue promptly.

The Error Object

{
  "error": {
    "name": "PipelineError",
    "message": "Internal server error. If the problem persists, please contact support."
  }
}

Example of an error when polling the /status endpoint:

{
  "id": "123a87r9-4129-4bb3-be18-9c9fb5bd7fc1-u1",
  "status": "failed",
  "error": {
    "name": "ImageLoadError",
    "message": "Error loading image: The URL's Content-Type is not an image. Content-Type: text/plain;charset=UTF-8"
  }
}

If you encounter an unrecognized error, please contact us at support@fashn.ai.

For detailed implementation guidance and best practices:

Image Preprocessing Best Practices - Optimize your source images for editing

Edit

POSThttps://api.fashn.ai/v1/run

Response

imageRequiredimage URL | base64

promptRequiredstring

seedinteger

output_format'png' | 'jpeg'