CreateAIGatewayModelRequest

Configuration for an AI Gateway model.

One Of
display_namestringrequired

The display name for this policy instance.

Example:My GPT 5 model

refstringrequired

A user-defined unique identifier for this model, used as a stable human-readable reference.

Example:my-gpt-5-model

enabledboolean

Whether the model is enabled.

Default:true

Example:true

aclsobjectrequired

Access control rules for allowing or denying consumer groups access to this model.

* Additional properties are NOT allowed.
Show Child Parameters
configobjectrequired

Routing, logging, and load balancing configuration for the model.

* Additional properties are NOT allowed.
Show Child Parameters
formatsarray[object]required

Request and response format supported by this model.

* Additional properties are NOT allowed.
Show Child Parameters
target_modelsarray[object]required

A target model instance that this model entry routes requests to.

* Additional properties are NOT allowed.
Show Child Parameters
policiesarray[object]required

Lightweight object used to reference a policy instance, identified by its ref.

* Additional properties are NOT allowed.
Show Child Parameters
labelsobject

Public labels store information about an entity that can be used for filtering a list of objects.

Public labels are intended to store PUBLIC metadata.

Keys must be of length 1-63 characters, and cannot start with “kong”, “konnect”, “mesh”, “kic”, or “_”.

Example:{"category":"finance"}

managed_byobject

Indicates the managing entities for a resource. A maximum of 5 keys is allowed.

Keys must be 63 characters or less, starting and ending with an alphanumeric character,
and may include dashes (-), underscores (_), and dots (.).

Values must be non-empty strings of 127 characters or less.

Keys and values must not contain spaces or control characters, and are case-insensitive.

Example:{"team":"platform","owner":"kong"}

typestringrequired

Allowed values:model

capabilitiesarray[string]required

List of AI capabilities enabled for this model.

Allowed values:chatembeddingsassistantsresponsesaudio-transcriptionsaudio-translationsimage-generationimage-editsvideo-generationsrealtime

Example

UpdateAIGatewayModelRequest

Configuration for an AI Gateway model.

One Of
display_namestringrequired

The display name for this policy instance.

Example:My GPT 5 model

refstringrequired

A user-defined unique identifier for this model, used as a stable human-readable reference.

Example:my-gpt-5-model

enabledboolean

Whether the model is enabled.

Default:true

Example:true

aclsobjectrequired

Access control rules for allowing or denying consumer groups access to this model.

* Additional properties are NOT allowed.
Show Child Parameters
configobjectrequired

Routing, logging, and load balancing configuration for the model.

* Additional properties are NOT allowed.
Show Child Parameters
formatsarray[object]required

Request and response format supported by this model.

* Additional properties are NOT allowed.
Show Child Parameters
target_modelsarray[object]required

A target model instance that this model entry routes requests to.

* Additional properties are NOT allowed.
Show Child Parameters
policiesarray[object]required

Lightweight object used to reference a policy instance, identified by its ref.

* Additional properties are NOT allowed.
Show Child Parameters
labelsobject

Public labels store information about an entity that can be used for filtering a list of objects.

Public labels are intended to store PUBLIC metadata.

Keys must be of length 1-63 characters, and cannot start with “kong”, “konnect”, “mesh”, “kic”, or “_”.

Example:{"category":"finance"}

managed_byobject

Indicates the managing entities for a resource. A maximum of 5 keys is allowed.

Keys must be 63 characters or less, starting and ending with an alphanumeric character,
and may include dashes (-), underscores (_), and dots (.).

Values must be non-empty strings of 127 characters or less.

Keys and values must not contain spaces or control characters, and are case-insensitive.

Example:{"team":"platform","owner":"kong"}

typestringrequired

Allowed values:model

capabilitiesarray[string]required

List of AI capabilities enabled for this model.

Allowed values:chatembeddingsassistantsresponsesaudio-transcriptionsaudio-translationsimage-generationimage-editsvideo-generationsrealtime

Example

AIGatewayModel

object

Configuration for an AI Gateway model.

* Additional properties are NOT allowed.
One Of
display_namestringrequired

The display name for this policy instance.

Example:My GPT 5 model

refstringrequired

A user-defined unique identifier for this model, used as a stable human-readable reference.

Example:my-gpt-5-model

enabledboolean

Whether the model is enabled.

Default:true

Example:true

aclsobjectrequired

Access control rules for allowing or denying consumer groups access to this model.

* Additional properties are NOT allowed.
Show Child Parameters
configobjectrequired

Routing, logging, and load balancing configuration for the model.

* Additional properties are NOT allowed.
Show Child Parameters
formatsarray[object]required

Request and response format supported by this model.

* Additional properties are NOT allowed.
Show Child Parameters
target_modelsarray[object]required

A target model instance that this model entry routes requests to.

* Additional properties are NOT allowed.
Show Child Parameters
policiesarray[object]required

Lightweight object used to reference a policy instance, identified by its ref.

* Additional properties are NOT allowed.
Show Child Parameters
labelsobject

Public labels store information about an entity that can be used for filtering a list of objects.

Public labels are intended to store PUBLIC metadata.

Keys must be of length 1-63 characters, and cannot start with “kong”, “konnect”, “mesh”, “kic”, or “_”.

Example:{"category":"finance"}

managed_byobject

Indicates the managing entities for a resource. A maximum of 5 keys is allowed.

Keys must be 63 characters or less, starting and ending with an alphanumeric character,
and may include dashes (-), underscores (_), and dots (.).

Values must be non-empty strings of 127 characters or less.

Keys and values must not contain spaces or control characters, and are case-insensitive.

Example:{"team":"platform","owner":"kong"}

typestringrequired

Allowed values:model

capabilitiesarray[string]required

List of AI capabilities enabled for this model.

Allowed values:chatembeddingsassistantsresponsesaudio-transcriptionsaudio-translationsimage-generationimage-editsvideo-generationsrealtime

Example

AIGatewayModelConfig

object

Routing, logging, and load balancing configuration for the model.

* Additional properties are NOT allowed.
routeobjectrequired

Configuration for an AI Gateway route.

* Additional properties are NOT allowed.
Show Child Parameters
loggingobjectrequired

Configuration for AI Gateway logging.

* Additional properties are NOT allowed.
Show Child Parameters
response_streamingstringrequired

Allowed values:allowalwaysdeny

Default:allow

max_request_body_sizeintegerrequired

Default:1048576

modelobjectrequired
* Additional properties are NOT allowed.
Show Child Parameters
balancerobject

Load balancing strategy when multiple target models are configured.

* Additional properties are NOT allowed.
Show Child Parameters
Example

AIGatewayEmbeddingsModelConfig

Configuration for an embeddings model.

One Of
namestringrequired

The name of the embeddings model.

upstream_urlstringrequired

The URL of the embeddings model.

typestringrequired

Allowed values:azure

deployment_idstring

The Azure deployment ID for the model.

api_versionstring

The Azure OpenAI API version to use.

Default:2023-05-15

Example