AI Gateway Models

Models that define routing, capabilities, and backend targets for the AI Gateway.

List AI Gateway Models

Returns a list of all models registered in the AI Gateway.

get

Query Parameters

page[size]integer

The maximum number of items to include per page. The last page of a collection may include fewer items.

Example:10

page[after]string

Request the next page of data, starting with the item after this parameter.

Example:ewogICJpZCI6ICJoZWxsbyB3b3JsZCIKfQ

Path Parameters

gatewayIdstring(uuid)requiredread-only

Contains a unique identifier used for this resource.

Example:bf138ba2-c9b1-4229-b268-04d9d8a6410b

Response

application/json

A successful response listing AI Gateway Models.

dataOne Of
array[object]required

Configuration for an AI Gateway model.

* Additional properties are NOT allowed.
AIGatewayModelModelobject
* Additional properties are NOT allowed.
Show Child Parameters
metaobjectrequired

Pagination metadata.

Show Child Parameters
get/ai-gateways/{gatewayId}/models
 
application/json

Create an AI Gateway Model

Registers a new model with routing, capabilities, and target backends.

post

Path Parameters

gatewayIdstring(uuid)requiredread-only

Contains a unique identifier used for this resource.

Example:bf138ba2-c9b1-4229-b268-04d9d8a6410b

Body

application/json

CreateAIGatewayModelRequest

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 | null

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

Response

application/json

Model created successfully.

AIGatewayModel

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 | null

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

post/ai-gateways/{gatewayId}/models

Body

{}
 
application/json

Get an AI Gateway Model

Returns the details of a specific AI Gateway model.

get

Path Parameters

gatewayIdstring(uuid)requiredread-only

Contains a unique identifier used for this resource.

Example:bf138ba2-c9b1-4229-b268-04d9d8a6410b

modelIdstring(uuid)requiredread-only

Contains a unique identifier used for this resource.

Example:bf138ba2-c9b1-4229-b268-04d9d8a6410b

Response

application/json

A successful response returning the AI Gateway Model.

AIGatewayModel

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 | null

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

get/ai-gateways/{gatewayId}/models/{modelId}
 
application/json

Update an AI Gateway Model

Updates the configuration of an existing AI Gateway model.

put

Path Parameters

gatewayIdstring(uuid)requiredread-only

Contains a unique identifier used for this resource.

Example:bf138ba2-c9b1-4229-b268-04d9d8a6410b

modelIdstring(uuid)requiredread-only

Contains a unique identifier used for this resource.

Example:bf138ba2-c9b1-4229-b268-04d9d8a6410b

Body

application/json

UpdateAIGatewayModelRequest

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 | null

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

Response

application/json

Model updated successfully.

AIGatewayModel

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 | null

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

put/ai-gateways/{gatewayId}/models/{modelId}

Body

{}
 
application/json