Orq.ai Documentation - AI Gateway & LLM Collaboration Platform

Create embeddings

curl --request POST \
  --url https://api.orq.ai/v2/gateway/embeddings \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "input": "<string>",
  "model": "<string>",
  "encoding_format": "float",
  "dimensions": 123,
  "user": "<string>",
  "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
    }
  }
}
'

{
  "object": "list",
  "data": [
    {
      "object": "embedding",
      "embedding": [
        123
      ],
      "index": 123
    }
  ],
  "model": "<string>",
  "usage": {
    "prompt_tokens": 123,
    "total_tokens": 123
  }
}

POST

gateway

embeddings

Create embeddings

curl --request POST \
  --url https://api.orq.ai/v2/gateway/embeddings \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "input": "<string>",
  "model": "<string>",
  "encoding_format": "float",
  "dimensions": 123,
  "user": "<string>",
  "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
    }
  }
}
'

{
  "object": "list",
  "data": [
    {
      "object": "embedding",
      "embedding": [
        123
      ],
      "index": 123
    }
  ],
  "model": "<string>",
  "usage": {
    "prompt_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

required

Input text to embed, encoded as a string or array of tokens.

model

string

required

ID of the model to use

encoding_format

enum<string>

default:float

Type of the document element

Available options:

base64,

float

dimensions

number

The number of dimensions the resulting output embeddings should have.

user

string

A unique identifier representing your end-user

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

Returns the embedding vector.

object

enum<string>

required

Available options:

list

data

object[]

required

Show child attributes

data.object

enum<string>

required

The object type, which is always embedding.

Available options:

embedding

data.embedding

required

The embedding vector, which is a list of floats. The length of vector depends on the model.

data.index

number

required

The index of the embedding in the list of embeddings.

model

string

required

ID of the model to used.

usage

object

required

The usage information for the request.

Show child attributes

usage.prompt_tokens

number

required

The number of tokens used by the prompt.

usage.total_tokens

number

required

The total number of tokens used by the request.

Create completion

Create image

⌘I

Platform APIs

Gateway APIs

Create embeddings

Authorizations

Body

Response