Orq.ai Documentation - AI Gateway & LLM Collaboration Platform

Create image edit

curl --request POST \
  --url https://api.orq.ai/v2/gateway/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 'orq={
  "name": "<string>",
  "retry": {
    "count": 3,
    "on_codes": [
      429,
      500,
      502,
      503,
      504
    ]
  },
  "fallbacks": [
    {
      "model": "openai/gpt-4o-mini"
    }
  ],
  "prompt": {
    "id": "prompt_01ARZ3NDEKTSV4RRFFQ69G5FAV",
    "version": "latest"
  },
  "contact": {
    "id": "contact_01ARZ3NDEKTSV4RRFFQ69G5FAV",
    "display_name": "Jane Doe",
    "email": "[email protected]",
    "metadata": [
      {
        "department": "Engineering",
        "role": "Senior Developer"
      }
    ],
    "logo_url": "https://example.com/avatars/jane-doe.jpg",
    "tags": [
      "hr",
      "engineering"
    ]
  },
  "cache": {
    "type": "exact_match",
    "ttl": 3600
  },
  "load_balancer": [
    {
      "model": "openai/gpt-4o",
      "weight": 0.7
    },
    {
      "model": "anthropic/claude-3-5-sonnet",
      "weight": 0.3
    }
  ],
  "timeout": {
    "call_timeout": 30000
  }
}'

{
  "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
    }
  }
}

POST

gateway

images

edits

Create image edit

curl --request POST \
  --url https://api.orq.ai/v2/gateway/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 'orq={
  "name": "<string>",
  "retry": {
    "count": 3,
    "on_codes": [
      429,
      500,
      502,
      503,
      504
    ]
  },
  "fallbacks": [
    {
      "model": "openai/gpt-4o-mini"
    }
  ],
  "prompt": {
    "id": "prompt_01ARZ3NDEKTSV4RRFFQ69G5FAV",
    "version": "latest"
  },
  "contact": {
    "id": "contact_01ARZ3NDEKTSV4RRFFQ69G5FAV",
    "display_name": "Jane Doe",
    "email": "[email protected]",
    "metadata": [
      {
        "department": "Engineering",
        "role": "Senior Developer"
      }
    ],
    "logo_url": "https://example.com/avatars/jane-doe.jpg",
    "tags": [
      "hr",
      "engineering"
    ]
  },
  "cache": {
    "type": "exact_match",
    "ttl": 3600
  },
  "load_balancer": [
    {
      "model": "openai/gpt-4o",
      "weight": 0.7
    },
    {
      "model": "anthropic/claude-3-5-sonnet",
      "weight": 0.3
    }
  ],
  "timeout": {
    "call_timeout": 30000
  }
}'

{
  "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.

integer | 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

response_format

enum<string> | null

default:url

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.

orq

object

Show child attributes

orq.name

string

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

orq.retry

object

Retry configuration for the request

Show child attributes

orq.retry.count

number

default:3

Number of retry attempts (1-5)

Required range: 1 <= x <= 5

Example:

3

orq.retry.on_codes

number[]

HTTP status codes that trigger retry logic

Minimum array length: 1

Required range: 100 <= x <= 599

Example:

[429, 500, 502, 503, 504]

orq.fallbacks

object[]

Array of fallback models to use if primary model fails

Show child attributes

orq.fallbacks.model

string

required

Fallback model identifier

Example:

"openai/gpt-4o-mini"

orq.prompt

object

Prompt configuration for the request

Show child attributes

orq.prompt.id

string

required

Unique identifier of the prompt to use

Example:

"prompt_01ARZ3NDEKTSV4RRFFQ69G5FAV"

orq.prompt.version

enum<string>

required

Version of the prompt to use (currently only "latest" supported)

Available options:

latest

Example:

"latest"

orq.contact

object

Information about the contact making the request. If the contact does not exist, it will be created automatically.

Show child attributes

orq.contact.id

string

required

Unique identifier for the contact

Example:

"contact_01ARZ3NDEKTSV4RRFFQ69G5FAV"

orq.contact.display_name

string

Display name of the contact

Example:

"Jane Doe"

orq.contact.email

string<email>

Email address of the contact

Example:

"[email protected]"

orq.contact.metadata

object[]

A hash of key/value pairs containing any other data about the contact

Show child attributes

orq.contact.metadata.{key}

any

Example:

[
  {
    "department": "Engineering",
    "role": "Senior Developer"
  }
]

orq.contact.logo_url

string

URL to the contact's avatar or logo

Example:

"https://example.com/avatars/jane-doe.jpg"

orq.contact.tags

string[]

A list of tags associated with the contact

Example:

["hr", "engineering"]

orq.cache

object

Cache configuration for the request.

Show child attributes

orq.cache.type

enum<string>

required

Available options:

exact_match

orq.cache.ttl

number

default:1800

Time to live for cached responses in seconds. Maximum 259200 seconds (3 days).

Required range: 1 <= x <= 259200

Example:

3600

orq.load_balancer

object[]

Array of models with weights for load balancing requests

Show child attributes

orq.load_balancer.model

string

required

Model identifier for load balancing

Example:

"openai/gpt-4o"

orq.load_balancer.weight

number

default:0.5

Weight assigned to this model for load balancing

Required range: 0.001 <= x <= 1

Example:

0.7

Example:

[
  { "model": "openai/gpt-4o", "weight": 0.7 },
  {
    "model": "anthropic/claude-3-5-sonnet",
    "weight": 0.3
  }
]

orq.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.

Show child attributes

orq.timeout.call_timeout

number

required

Timeout value in milliseconds

Required range: x >= 1

Example:

30000

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.

Show child attributes

data.b64_json

string

The base64-encoded JSON of the generated image, if response_format is b64_json

data.url

string

The URL of the generated image, if response_format is url (default)

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.

Show child attributes

usage.total_tokens

number

required

The total number of tokens (images and text) used for the image generation.

usage.input_tokens

number

required

The number of tokens (images and text) in the input prompt.

usage.output_tokens

number

required

The number of output tokens generated by the model.

usage.input_tokens_details

object

required

The input tokens detailed information for the image generation.

Show child attributes

usage.input_tokens_details.text_tokens

number

required

The number of text tokens in the input prompt.

usage.input_tokens_details.image_tokens

number

required

The number of image tokens in the input prompt.

Create image

Create image variation

⌘I

Platform APIs

Gateway APIs

Create image edit

Authorizations

Body

Response