# Image Editing

> The reframe endpoint intelligently adjusts an image's aspect ratio while preserving the main subject's position, composition, pose, and perspective


## Overview

- **Endpoint**: `https://fal.run/fal-ai/image-editing/reframe`
- **Model ID**: `fal-ai/image-editing/reframe`
- **Category**: image-to-image
- **Kind**: inference
**Tags**: stylized, transform



## Pricing

- **Price**: $0.04 per images

For more details, see [fal.ai pricing](https://fal.ai/pricing).

## API Information

This model can be used via our HTTP API or more conveniently via our client libraries.
See the input and output schema below, as well as the usage examples.


### Input Schema

The API accepts the following input parameters:


- **`image_url`** (`string`, _required_):
  URL of the old or damaged photo to restore.
  - Examples: "https://v3.fal.media/files/elephant/7ekErKT--mhgKJ5kgtvU__image.webp"

- **`guidance_scale`** (`float`, _optional_):
  The CFG (Classifier Free Guidance) scale is a measure of how close you want the model to stick to your prompt when looking for a related image to show you. Default value: `3.5`
  - Default: `3.5`
  - Range: `0` to `20`

- **`num_inference_steps`** (`integer`, _optional_):
  Number of inference steps for sampling. Default value: `30`
  - Default: `30`
  - Range: `1` to `50`

- **`safety_tolerance`** (`SafetyToleranceEnum`, _optional_):
  The safety tolerance level for the generated image. 1 being the most strict and 6 being the most permissive. Default value: `"2"`
  - Default: `"2"`
  - Options: `"1"`, `"2"`, `"3"`, `"4"`, `"5"`, `"6"`

- **`output_format`** (`OutputFormatEnum`, _optional_):
  The format of the generated image. Default value: `"jpeg"`
  - Default: `"jpeg"`
  - Options: `"jpeg"`, `"png"`

- **`aspect_ratio`** (`AspectRatioEnum`, _optional_):
  The desired aspect ratio for the reframed image. Default value: `"16:9"`
  - Default: `"16:9"`
  - Options: `"21:9"`, `"16:9"`, `"4:3"`, `"3:2"`, `"1:1"`, `"2:3"`, `"3:4"`, `"9:16"`, `"9:21"`
  - Examples: "16:9"

- **`seed`** (`integer`, _optional_):
  The same seed and the same prompt given to the same version of the model will output the same image every time.

- **`sync_mode`** (`boolean`, _optional_):
  If `True`, the media will be returned as a data URI and the output data won't be available in the request history.
  - Default: `false`



**Required Parameters Example**:

```json
{
  "image_url": "https://v3.fal.media/files/elephant/7ekErKT--mhgKJ5kgtvU__image.webp"
}
```

**Full Example**:

```json
{
  "image_url": "https://v3.fal.media/files/elephant/7ekErKT--mhgKJ5kgtvU__image.webp",
  "guidance_scale": 3.5,
  "num_inference_steps": 30,
  "safety_tolerance": "2",
  "output_format": "jpeg",
  "aspect_ratio": "16:9"
}
```


### Output Schema

The API returns the following output format:

- **`images`** (`list<Image>`, _required_)
  - Array of Image
  - Examples: [{"url":"https://fal.media/files/elephant/V76OoObzc65eDtueHsXYI_a8879759964f4defaef62f44bacdaced.jpg"}]

- **`seed`** (`integer`, _required_)



**Example Response**:

```json
{
  "images": [
    {
      "url": "https://fal.media/files/elephant/V76OoObzc65eDtueHsXYI_a8879759964f4defaef62f44bacdaced.jpg"
    }
  ]
}
```


## Usage Examples

### cURL

```bash
curl --request POST \
  --url https://fal.run/fal-ai/image-editing/reframe \
  --header "Authorization: Key $FAL_KEY" \
  --header "Content-Type: application/json" \
  --data '{
     "image_url": "https://v3.fal.media/files/elephant/7ekErKT--mhgKJ5kgtvU__image.webp"
   }'
```

### Python

Ensure you have the Python client installed:

```bash
pip install fal-client
```

Then use the API client to make requests:

```python
import fal_client

def on_queue_update(update):
    if isinstance(update, fal_client.InProgress):
        for log in update.logs:
           print(log["message"])

result = fal_client.subscribe(
    "fal-ai/image-editing/reframe",
    arguments={
        "image_url": "https://v3.fal.media/files/elephant/7ekErKT--mhgKJ5kgtvU__image.webp"
    },
    with_logs=True,
    on_queue_update=on_queue_update,
)
print(result)
```

### JavaScript

Ensure you have the JavaScript client installed:

```bash
npm install --save @fal-ai/client
```

Then use the API client to make requests:

```javascript
import { fal } from "@fal-ai/client";

const result = await fal.subscribe("fal-ai/image-editing/reframe", {
  input: {
    image_url: "https://v3.fal.media/files/elephant/7ekErKT--mhgKJ5kgtvU__image.webp"
  },
  logs: true,
  onQueueUpdate: (update) => {
    if (update.status === "IN_PROGRESS") {
      update.logs.map((log) => log.message).forEach(console.log);
    }
  },
});
console.log(result.data);
console.log(result.requestId);
```


## Additional Resources

### Documentation

- [Model Playground](https://fal.ai/models/fal-ai/image-editing/reframe)
- [API Documentation](https://fal.ai/models/fal-ai/image-editing/reframe/api)
- [OpenAPI Schema](https://fal.ai/api/openapi/queue/openapi.json?endpoint_id=fal-ai/image-editing/reframe)

### fal.ai Platform

- [Platform Documentation](https://docs.fal.ai)
- [Python Client](https://docs.fal.ai/clients/python)
- [JavaScript Client](https://docs.fal.ai/clients/javascript)