Skip to main content
POST
/
v2
/
router
/
images
/
edits
Create image edit
curl --request POST \
  --url https://api.orq.ai/v2/router/images/edits \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: multipart/form-data' \
  --form 'model=<string>' \
  --form 'prompt=<string>' \
  --form 'image=<unknown>' \
  --form n=1 \
  --form 'size=<string>' \
  --form quality=auto \
  --form response_format=url \
  --form 'user=<string>' \
  --form 'name=<string>' \
  --form 'fallbacks={
  "model": "<string>"
}' \
  --form 'retry={
  "count": 3,
  "on_codes": [
    429,
    500,
    502,
    503,
    504
  ]
}' \
  --form 'orq={
  "name": "<string>",
  "retry": {
    "count": 3,
    "on_codes": [
      429,
      500,
      502,
      503,
      504
    ]
  },
  "fallbacks": [
    {
      "model": "openai/gpt-4o-mini"
    }
  ],
  "load_balancer": {
    "type": "weight_based",
    "models": [
      {
        "model": "openai/gpt-4o",
        "weight": 0.7
      },
      {
        "model": "anthropic/claude-3-5-sonnet",
        "weight": 0.3
      }
    ]
  }
}'
{
  "created": 123,
  "data": [
    {
      "b64_json": "<string>",
      "url": "<string>"
    }
  ],
  "output_format": "<string>",
  "size": "<string>",
  "quality": "<string>",
  "usage": {
    "total_tokens": 123,
    "input_tokens": 123,
    "output_tokens": 123,
    "input_tokens_details": {
      "text_tokens": 123,
      "image_tokens": 123
    }
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

multipart/form-data
​
model
string
required

The model to use for image edit. Check models

​
prompt
string
required

A text description of the desired image(s).

​
image
any

The image(s) to edit. Must be a supported image file or an array of images. Each image should be a png, webp, or jpg file less than 50MB. You can provide up to 16 images.

​
n
number | null
default:1

The number of images to generate. Must be between 1 and 10.

Required range: 1 <= x <= 10
​
size
string | null

The size of the generated images

​
quality
enum<string> | null

The quality of the image that will be generated. Auto will automatically select the best quality for the given model.

Available options:
auto,
high,
medium,
low,
standard,
null
​
response_format
enum<string>

The format in which the generated images are returned. Some of the models only return the image in base64 format.

Available options:
url,
b64_json
​
user
string

A unique identifier representing your end-user, which can help to monitor and detect abuse.

​
name
string

The name to display on the trace. If not specified, the default system name will be used.

​
fallbacks
object[]

Array of fallback models to use if primary model fails

​
retry
object

Retry configuration for the request

​
cache
object

Cache configuration for the request.

​
load_balancer
object

Load balancer configuration for the request.

​
timeout
object

Timeout configuration to apply to the request. If the request exceeds the timeout, it will be retried or fallback to the next model if configured.

​
orq
object

Response

200 - application/json

Represents an image edit response from the API.

​
created
number
required

The Unix timestamp (in seconds) of when the image was created.

​
data
object[]
required

The list of generated images.

​
output_format
string

The output format of the image generation

​
size
string

The size of the image generated

​
quality
string

The quality of the image generated

​
usage
object

The token usage information for the image generation.