Orq.ai Documentation - AI Gateway & LLM Collaboration Platform

Create speech

curl --request POST \
  --url https://api.orq.ai/v2/gateway/audio/speech \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "input": "<string>",
  "model": "<string>",
  "voice": "<string>",
  "response_format": "mp3",
  "speed": 1,
  "orq": {
    "retry": {
      "count": 3,
      "on_codes": [
        429,
        500,
        502,
        503,
        504
      ]
    },
    "fallbacks": [
      {
        "model": "openai/gpt-4o-mini"
      }
    ],
    "name": "<string>",
    "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"
      ]
    },
    "thread": {
      "id": "thread_01ARZ3NDEKTSV4RRFFQ69G5FAV",
      "tags": [
        "customer-support",
        "priority-high"
      ]
    },
    "load_balancer": [
      {
        "model": "openai/gpt-4o",
        "weight": 0.7
      },
      {
        "model": "anthropic/claude-3-5-sonnet",
        "weight": 0.3
      }
    ],
    "timeout": {
      "call_timeout": 30000
    }
  }
}
'

POST

gateway

audio

speech

Create speech

curl --request POST \
  --url https://api.orq.ai/v2/gateway/audio/speech \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "input": "<string>",
  "model": "<string>",
  "voice": "<string>",
  "response_format": "mp3",
  "speed": 1,
  "orq": {
    "retry": {
      "count": 3,
      "on_codes": [
        429,
        500,
        502,
        503,
        504
      ]
    },
    "fallbacks": [
      {
        "model": "openai/gpt-4o-mini"
      }
    ],
    "name": "<string>",
    "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"
      ]
    },
    "thread": {
      "id": "thread_01ARZ3NDEKTSV4RRFFQ69G5FAV",
      "tags": [
        "customer-support",
        "priority-high"
      ]
    },
    "load_balancer": [
      {
        "model": "openai/gpt-4o",
        "weight": 0.7
      },
      {
        "model": "anthropic/claude-3-5-sonnet",
        "weight": 0.3
      }
    ],
    "timeout": {
      "call_timeout": 30000
    }
  }
}
'

Authorizations

Authorization

string

header

required

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

Body

application/json

input

string

required

The text to generate audio for. The maximum length is 4096 characters

model

string

required

ID of the model to use

voice

string

required

The voice to use.

Available voices for OpenAI

alloy, echo, fable, onyx, nova, and shimmer

Available voices for ElevenLabs

aria, roger, sarah, laura, charlie, george, callum, river, liam, charlotte, alice, matilda, will, jessica, eric, chris, brian, daniel, lily, bill

response_format

enum<string>

default:mp3

The format to audio in. Supported formats are mp3, opus, aac, flac, wav, and pcm. If a format is provided but not supported by the provider, the response will be in the default format. When the provided format is not supported by the provider, the response will be in the default format.

Available options:

mp3,

opus,

aac,

flac,

wav,

pcm

speed

number

default:1

The speed of the generated audio.

orq

object

Show child attributes

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

string

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

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

object

Thread information to group related requests

Show child attributes

orq.thread.id

string

required

Unique thread identifier to group related invocations.

Example:

"thread_01ARZ3NDEKTSV4RRFFQ69G5FAV"

orq.thread.tags

string[]

Optional tags to differentiate or categorize threads

Example:

["customer-support", "priority-high"]

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

The audio file content.

Update tool

Create transcription

⌘I

Platform APIs

Gateway APIs

Create speech

Authorizations

Body

Response