Orq.ai Documentation - AI Gateway & LLM Collaboration Platform

Create image

curl --request POST \
  --url https://api.orq.ai/v2/gateway/images/generations \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "prompt": "<string>",
  "model": "<string>",
  "background": "transparent",
  "moderation": "low",
  "n": 1,
  "output_compression": 50,
  "output_format": "png",
  "quality": "auto",
  "response_format": "url",
  "size": "<string>",
  "style": "vivid",
  "orq": {
    "name": "<string>",
    "fallbacks": [
      {
        "model": "openai/gpt-4o-mini"
      }
    ],
    "cache": {
      "type": "exact_match",
      "ttl": 3600
    },
    "retry": {
      "count": 3,
      "on_codes": [
        429,
        500,
        502,
        503,
        504
      ]
    },
    "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"
      ]
    },
    "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": [
    {
      "revised_prompt": "<string>",
      "b64_json": "<string>",
      "url": "<string>"
    }
  ],
  "usage": {
    "input_tokens_details": {
      "image_tokens": 123,
      "text_tokens": 123
    },
    "input_tokens": 123,
    "output_tokens": 123,
    "total_tokens": 123
  }
}

POST

gateway

images

generations

Create image

curl --request POST \
  --url https://api.orq.ai/v2/gateway/images/generations \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "prompt": "<string>",
  "model": "<string>",
  "background": "transparent",
  "moderation": "low",
  "n": 1,
  "output_compression": 50,
  "output_format": "png",
  "quality": "auto",
  "response_format": "url",
  "size": "<string>",
  "style": "vivid",
  "orq": {
    "name": "<string>",
    "fallbacks": [
      {
        "model": "openai/gpt-4o-mini"
      }
    ],
    "cache": {
      "type": "exact_match",
      "ttl": 3600
    },
    "retry": {
      "count": 3,
      "on_codes": [
        429,
        500,
        502,
        503,
        504
      ]
    },
    "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"
      ]
    },
    "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": [
    {
      "revised_prompt": "<string>",
      "b64_json": "<string>",
      "url": "<string>"
    }
  ],
  "usage": {
    "input_tokens_details": {
      "image_tokens": 123,
      "text_tokens": 123
    },
    "input_tokens": 123,
    "output_tokens": 123,
    "total_tokens": 123
  }
}

Authorizations

Authorization

string

header

required

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

Body

application/json

input

prompt

string

required

A text description of the desired image(s).

model

string

required

The model to use for image generation. One of openai/dall-e-2, openai/dall-e-3, or openai/gpt-image-1.

background

enum<string> | null

Allows to set transparency for the background of the generated image(s). This parameter is only supported for openai/gpt-image-1.

Available options:

transparent,

opaque,

auto

moderation

enum<string> | null

Control the content-moderation level for images generated by gpt-image-1. Must be either low or auto.

Available options:

low,

auto

integer | null

default:1

The number of images to generate. Must be between 1 and 10. For dall-e-3, only n=1 is supported.

Required range: 1 <= x <= 10

output_compression

integer | null

The compression level (0-100%) for the generated images. This parameter is only supported for gpt-image-1 with the webp or jpeg output formats.

Required range: 0 <= x <= 100

output_format

enum<string> | null

The format in which the generated images are returned. This parameter is only supported for openai/gpt-image-1.

Available options:

png,

jpeg,

webp

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,

hd,

standard

response_format

enum<string> | null

The format in which generated images are returned. Must be one of url or b64_json. This parameter isn't supported for gpt-image-1 which will always return base64-encoded images.

Available options:

url,

b64_json

size

string | null

The size of the generated images. Must be one of the specified sizes for each model.

style

enum<string> | null

The style of the generated images. This parameter is only supported for openai/dall-e-3. Must be one of vivid or natural.

Available options:

vivid,

natural

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.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.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.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.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.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 generation response from the API.

created

number

required

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

data

object[]

required

Represents the url or the content of an image generated.

Show child attributes

data.revised_prompt

string | null

The prompt that was used to generate the image, if there was any revision to the prompt.

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)

usage

object

Show child attributes

usage.input_tokens_details

object

required

Show child attributes

usage.input_tokens_details.image_tokens

number

usage.input_tokens_details.text_tokens

number

usage.input_tokens

number

usage.output_tokens

number

usage.total_tokens

number

Create embeddings

Create image edit

⌘I

Platform APIs

Gateway APIs

Create image

Authorizations

Body

Response