fashn-logo
FASHNAI

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:

POSThttps://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.

maskimage URL | base64

Optional mask image that guides the edit toward specific regions. White pixels (255) mark areas to prioritize, black pixels (0) mark areas to preserve. The model may still adjust nearby pixels to keep the image coherent, so treat the mask as a strong hint rather than strict inpainting.

The mask must have the same dimensions as the source image.

image_contextimage URL | base64

Optional reference image that provides visual context to guide the edit. Use this when the desired result cannot be fully described in words alone. Examples include a specific background scene, complex pose, or texture pattern.

resolution'1k' | '4k'

Chooses the generation profile. '1k' produces precise, instruction-following results suited for consistent catalog imagery. '4k' unlocks creative, ultra high-definition renders with richer product detail but slightly less control over pose and styling.

Default: '1k'

seedinteger

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_base64boolean

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 shares the common runtime errors in Error Handling.

For detailed implementation guidance and best practices:

Previous

Model Swap

Next

Reframe

On this page

RequestRequest ExamplesResponseRequest ParametersResponse PollingSuccessful ResponseRuntime ErrorsRelated Guides