---
title: "Async Ai Edit Generation Api"
method: POST
path: "/v1/image/ai-edit"
tags: ["Image"]
---

# Async Ai Edit Generation Api

`POST /v1/image/ai-edit`

AI Edit

## Request body

- AiEditAPIRequest
  - `output` union — Customize output format, destination and number of images.
    - AIEditRequestOutputObject
      - `number_of_images` integer — Number of output images.
      - `destination` string, uri — Customize the result output.
      - `format` 'jpeg' | 'png' — An enumeration.
    - string, uri
  - `input` string, uri, required — URL of the input image. Image must be accessible by our system.
  - `options` AiEditRequestOptionsObject, required
    - `model` 'v1' | 'v2' — An enumeration.
    - `prompt` string, required — Prompt for the generation.
    - `aspect_ratio` '1:1' | '2:3' | '3:2' | '3:4' | '4:3' | '9:16' | '16:9' | '9:21' | '21:9' — An enumeration.
    - `inference_steps` integer — Number of inference steps.
    - `guidance_scale` number — Guidance scale for the generation.

## Response `200`

Successful Response

- ResponseAiEditAcceptedResponse — Wrapper for responses
  - `data` AiEditAcceptedResponse
    - `id` integer, required
    - `status` 'ACCEPTED' | 'WAITING' | 'PROCESSING' | 'DONE' | 'ERROR' | 'CANCELLED' | 'PAUSED', required — An enumeration.
    - `created_at` string, date-time, required
    - `request` object, required
    - `result_url` string, uri, required

## Other responses

- `401` — Authorization is required.
- `402` — No API calls left.
- `403` — Not enough permissions.
- `422` — Unprocessable Entity.
- `429` — Too many requests.

---

[API](https://skmtc.net/claid/apis/claid-rest-api.md) · [All operations](https://skmtc.net/claid/apis/claid-rest-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/claid/claid-rest-api/revisions/410fc0db9665/schema)