API Reference

AI Gateway

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Dynamic Routing

List dynamic routes

GET/accounts/{account_id}/ai-gateway/gateways/{gateway_id}/routes

Get a dynamic route

GET/accounts/{account_id}/ai-gateway/gateways/{gateway_id}/routes/{id}

Create a dynamic route

POST/accounts/{account_id}/ai-gateway/gateways/{gateway_id}/routes

Rename a dynamic route

PATCH/accounts/{account_id}/ai-gateway/gateways/{gateway_id}/routes/{id}

Delete a dynamic route

DELETE/accounts/{account_id}/ai-gateway/gateways/{gateway_id}/routes/{id}

List dynamic route deployments

GET/accounts/{account_id}/ai-gateway/gateways/{gateway_id}/routes/{id}/deployments

Deploy a dynamic route version

POST/accounts/{account_id}/ai-gateway/gateways/{gateway_id}/routes/{id}/deployments

List dynamic route versions

GET/accounts/{account_id}/ai-gateway/gateways/{gateway_id}/routes/{id}/versions

Create a dynamic route version

POST/accounts/{account_id}/ai-gateway/gateways/{gateway_id}/routes/{id}/versions

Get a dynamic route version

GET/accounts/{account_id}/ai-gateway/gateways/{gateway_id}/routes/{id}/versions/{version_id}

ModelsExpand Collapse

DynamicRoutingListResponse object { data, success }

data: object { order_by, order_by_direction, page, 2 more }

order_by: string

order_by_direction: string

page: number

per_page: number

routes: array of object { id, account_tag, created_at, 6 more }

id: string

account_tag: string

created_at: string

formatdate-time

deployment: object { created_at, deployment_id, version_id }

created_at: string

deployment_id: string

version_id: string

elements: array of object { id, outputs, type } or object { id, outputs, properties, type } or object { id, outputs, type } or 3 more

One of the following:

object { id, outputs, type }

id: string

outputs: object { next }

next: object { elementId }

elementId: string

type: "start"

object { id, outputs, properties, type }

id: string

outputs: object { false, true }

false: object { elementId }

elementId: string

true: object { elementId }

elementId: string

properties: object { conditions }

conditions: optional unknown

type: "conditional"

object { id, outputs, type }

id: string

outputs: map[object { elementId } ]

elementId: string

type: "percentage"

object { id, outputs, properties, type }

id: string

outputs: object { fallback, success }

fallback: object { elementId }

elementId: string

success: object { elementId }

elementId: string

properties: object { key, limit, limitType, window }

key: string

limit: number

limitType: "count" or "cost"

One of the following:

"count"

"cost"

window: number

type: "rate"

object { id, outputs, properties, type }

id: string

outputs: object { fallback, success }

fallback: object { elementId }

elementId: string

success: object { elementId }

elementId: string

properties: object { model, provider, retries, timeout }

model: string

provider: string

retries: number

timeout: number

type: "model"

object { id, outputs, type }

id: string

outputs: map[object { elementId } ]

elementId: string

type: "end"

gateway_id: string

modified_at: string

formatdate-time

name: string

minLength1

version: object { active, created_at, data, 2 more }

active: "true" or "false"

One of the following:

"true"

"false"

created_at: string

data: string

version_id: string

is_valid: optional boolean

success: boolean

DynamicRoutingGetResponse object { id, created_at, deployment, 5 more }

id: string

created_at: string

formatdate-time

deployment: object { created_at, deployment_id, version_id }

created_at: string

deployment_id: string

version_id: string

elements: array of object { id, outputs, type } or object { id, outputs, properties, type } or object { id, outputs, type } or 3 more

One of the following:

object { id, outputs, type }

id: string

outputs: object { next }

next: object { elementId }

elementId: string

type: "start"

object { id, outputs, properties, type }

id: string

outputs: object { false, true }

false: object { elementId }

elementId: string

true: object { elementId }

elementId: string

properties: object { conditions }

conditions: optional unknown

type: "conditional"

object { id, outputs, type }

id: string

outputs: map[object { elementId } ]

elementId: string

type: "percentage"

object { id, outputs, properties, type }

id: string

outputs: object { fallback, success }

fallback: object { elementId }

elementId: string

success: object { elementId }

elementId: string

properties: object { key, limit, limitType, window }

key: string

limit: number

limitType: "count" or "cost"

One of the following:

"count"

"cost"

window: number

type: "rate"

object { id, outputs, properties, type }

id: string

outputs: object { fallback, success }

fallback: object { elementId }

elementId: string

success: object { elementId }

elementId: string

properties: object { model, provider, retries, timeout }

model: string

provider: string

retries: number

timeout: number

type: "model"

object { id, outputs, type }

id: string

outputs: map[object { elementId } ]

elementId: string

type: "end"

gateway_id: string

modified_at: string

formatdate-time

name: string

minLength1

version: object { active, created_at, data, 2 more }

active: "true" or "false"

One of the following:

"true"

"false"

created_at: string

data: string

version_id: string

is_valid: optional boolean

DynamicRoutingCreateResponse object { id, created_at, deployment, 5 more }

id: string

created_at: string

formatdate-time

deployment: object { created_at, deployment_id, version_id }

created_at: string

deployment_id: string

version_id: string

elements: array of object { id, outputs, type } or object { id, outputs, properties, type } or object { id, outputs, type } or 3 more

One of the following:

object { id, outputs, type }

id: string

outputs: object { next }

next: object { elementId }

elementId: string

type: "start"

object { id, outputs, properties, type }

id: string

outputs: object { false, true }

false: object { elementId }

elementId: string

true: object { elementId }

elementId: string

properties: object { conditions }

conditions: optional unknown

type: "conditional"

object { id, outputs, type }

id: string

outputs: map[object { elementId } ]

elementId: string

type: "percentage"

object { id, outputs, properties, type }

id: string

outputs: object { fallback, success }

fallback: object { elementId }

elementId: string

success: object { elementId }

elementId: string

properties: object { key, limit, limitType, window }

key: string

limit: number

limitType: "count" or "cost"

One of the following:

"count"

"cost"

window: number

type: "rate"

object { id, outputs, properties, type }

id: string

outputs: object { fallback, success }

fallback: object { elementId }

elementId: string

success: object { elementId }

elementId: string

properties: object { model, provider, retries, timeout }

model: string

provider: string

retries: number

timeout: number

type: "model"

object { id, outputs, type }

id: string

outputs: map[object { elementId } ]

elementId: string

type: "end"

gateway_id: string

modified_at: string

formatdate-time

name: string

minLength1

version: object { active, created_at, data, 2 more }

active: "true" or "false"

One of the following:

"true"

"false"

created_at: string

data: string

version_id: string

is_valid: optional boolean

DynamicRoutingUpdateResponse object { route, success }

route: object { id, account_tag, created_at, 6 more }

id: string

account_tag: string

created_at: string

formatdate-time

deployment: object { created_at, deployment_id, version_id }

created_at: string

deployment_id: string

version_id: string

elements: array of object { id, outputs, type } or object { id, outputs, properties, type } or object { id, outputs, type } or 3 more

One of the following:

object { id, outputs, type }

id: string

outputs: object { next }

next: object { elementId }

elementId: string

type: "start"

object { id, outputs, properties, type }

id: string

outputs: object { false, true }

false: object { elementId }

elementId: string

true: object { elementId }

elementId: string

properties: object { conditions }

conditions: optional unknown

type: "conditional"

object { id, outputs, type }

id: string

outputs: map[object { elementId } ]

elementId: string

type: "percentage"

object { id, outputs, properties, type }

id: string

outputs: object { fallback, success }

fallback: object { elementId }

elementId: string

success: object { elementId }

elementId: string

properties: object { key, limit, limitType, window }

key: string

limit: number

limitType: "count" or "cost"

One of the following:

"count"

"cost"

window: number

type: "rate"

object { id, outputs, properties, type }

id: string

outputs: object { fallback, success }

fallback: object { elementId }

elementId: string

success: object { elementId }

elementId: string

properties: object { model, provider, retries, timeout }

model: string

provider: string

retries: number

timeout: number

type: "model"

object { id, outputs, type }

id: string

outputs: map[object { elementId } ]

elementId: string

type: "end"

gateway_id: string

modified_at: string

formatdate-time

name: string

minLength1

version: object { active, created_at, data, 2 more }

active: "true" or "false"

One of the following:

"true"

"false"

created_at: string

data: string

version_id: string

is_valid: optional boolean

success: boolean

DynamicRoutingDeleteResponse object { id, created_at, elements, 3 more }

id: string

created_at: string

formatdate-time

elements: array of object { id, outputs, type } or object { id, outputs, properties, type } or object { id, outputs, type } or 3 more

One of the following:

object { id, outputs, type }

id: string

outputs: object { next }

next: object { elementId }

elementId: string

type: "start"

object { id, outputs, properties, type }

id: string

outputs: object { false, true }

false: object { elementId }

elementId: string

true: object { elementId }

elementId: string

properties: object { conditions }

conditions: optional unknown

type: "conditional"

object { id, outputs, type }

id: string

outputs: map[object { elementId } ]

elementId: string

type: "percentage"

object { id, outputs, properties, type }

id: string

outputs: object { fallback, success }

fallback: object { elementId }

elementId: string

success: object { elementId }

elementId: string

properties: object { key, limit, limitType, window }

key: string

limit: number

limitType: "count" or "cost"

One of the following:

"count"

"cost"

window: number

type: "rate"

object { id, outputs, properties, type }

id: string

outputs: object { fallback, success }

fallback: object { elementId }

elementId: string

success: object { elementId }

elementId: string

properties: object { model, provider, retries, timeout }

model: string

provider: string

retries: number

timeout: number

type: "model"

object { id, outputs, type }

id: string

outputs: map[object { elementId } ]

elementId: string

type: "end"

gateway_id: string

modified_at: string

formatdate-time

name: string

minLength1

DynamicRoutingListDeploymentsResponse object { data, success }

data: object { deployments, order_by, order_by_direction, 2 more }

deployments: array of object { created_at, deployment_id, version_id }

created_at: string

deployment_id: string

version_id: string

order_by: string

order_by_direction: string

page: number

per_page: number

success: boolean

DynamicRoutingCreateDeploymentResponse object { id, created_at, elements, 3 more }

id: string

created_at: string

formatdate-time

elements: array of object { id, outputs, type } or object { id, outputs, properties, type } or object { id, outputs, type } or 3 more

One of the following:

object { id, outputs, type }

id: string

outputs: object { next }

next: object { elementId }

elementId: string

type: "start"

object { id, outputs, properties, type }

id: string

outputs: object { false, true }

false: object { elementId }

elementId: string

true: object { elementId }

elementId: string

properties: object { conditions }

conditions: optional unknown

type: "conditional"

object { id, outputs, type }

id: string

outputs: map[object { elementId } ]

elementId: string

type: "percentage"

object { id, outputs, properties, type }

id: string

outputs: object { fallback, success }

fallback: object { elementId }

elementId: string

success: object { elementId }

elementId: string

properties: object { key, limit, limitType, window }

key: string

limit: number

limitType: "count" or "cost"

One of the following:

"count"

"cost"

window: number

type: "rate"

object { id, outputs, properties, type }

id: string

outputs: object { fallback, success }

fallback: object { elementId }

elementId: string

success: object { elementId }

elementId: string

properties: object { model, provider, retries, timeout }

model: string

provider: string

retries: number

timeout: number

type: "model"

object { id, outputs, type }

id: string

outputs: map[object { elementId } ]

elementId: string

type: "end"

gateway_id: string

modified_at: string

formatdate-time

name: string

minLength1

DynamicRoutingListVersionsResponse object { data, success }

data: object { order_by, order_by_direction, page, 2 more }

order_by: string

order_by_direction: string

page: number

per_page: number

versions: array of object { active, created_at, data, 2 more }

active: "true" or "false"

One of the following:

"true"

"false"

created_at: string

data: string

version_id: string

is_valid: optional boolean

success: boolean

DynamicRoutingCreateVersionResponse object { id, created_at, elements, 3 more }

id: string

created_at: string

formatdate-time

elements: array of object { id, outputs, type } or object { id, outputs, properties, type } or object { id, outputs, type } or 3 more

One of the following:

object { id, outputs, type }

id: string

outputs: object { next }

next: object { elementId }

elementId: string

type: "start"

object { id, outputs, properties, type }

id: string

outputs: object { false, true }

false: object { elementId }

elementId: string

true: object { elementId }

elementId: string

properties: object { conditions }

conditions: optional unknown

type: "conditional"

object { id, outputs, type }

id: string

outputs: map[object { elementId } ]

elementId: string

type: "percentage"

object { id, outputs, properties, type }

id: string

outputs: object { fallback, success }

fallback: object { elementId }

elementId: string

success: object { elementId }

elementId: string

properties: object { key, limit, limitType, window }

key: string

limit: number

limitType: "count" or "cost"

One of the following:

"count"

"cost"

window: number

type: "rate"

object { id, outputs, properties, type }

id: string

outputs: object { fallback, success }

fallback: object { elementId }

elementId: string

success: object { elementId }

elementId: string

properties: object { model, provider, retries, timeout }

model: string

provider: string

retries: number

timeout: number

type: "model"

object { id, outputs, type }

id: string

outputs: map[object { elementId } ]

elementId: string

type: "end"

gateway_id: string

modified_at: string

formatdate-time

name: string

minLength1

DynamicRoutingGetVersionResponse object { id, active, created_at, 7 more }

id: string

active: "true" or "false"

One of the following:

"true"

"false"

created_at: string

data: string

elements: array of object { id, outputs, type } or object { id, outputs, properties, type } or object { id, outputs, type } or 3 more

One of the following:

object { id, outputs, type }

id: string

outputs: object { next }

next: object { elementId }

elementId: string

type: "start"

object { id, outputs, properties, type }

id: string

outputs: object { false, true }

false: object { elementId }

elementId: string

true: object { elementId }

elementId: string

properties: object { conditions }

conditions: optional unknown

type: "conditional"

object { id, outputs, type }

id: string

outputs: map[object { elementId } ]

elementId: string

type: "percentage"

object { id, outputs, properties, type }

id: string

outputs: object { fallback, success }

fallback: object { elementId }

elementId: string

success: object { elementId }

elementId: string

properties: object { key, limit, limitType, window }

key: string

limit: number

limitType: "count" or "cost"

One of the following:

"count"

"cost"

window: number

type: "rate"

object { id, outputs, properties, type }

id: string

outputs: object { fallback, success }

fallback: object { elementId }

elementId: string

success: object { elementId }

elementId: string

properties: object { model, provider, retries, timeout }

model: string

provider: string

retries: number

timeout: number

type: "model"

object { id, outputs, type }

id: string

outputs: map[object { elementId } ]

elementId: string

type: "end"

gateway_id: string

modified_at: string

formatdate-time

name: string

minLength1

version_id: string

is_valid: optional boolean