AI Gateway Providers

Providers that define the backend AI service connections for the AI Gateway.

List AI Gateway Providers

Returns a list of providers configured for 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 paginated list of AI Gateway Providers.

dataOne Of
array[object]required
AIGatewayProviderAnthropicobject

Configuration for an upstream LLM provider.

* Additional properties are NOT allowed.
Show Child Parameters
metaobjectrequired

Pagination metadata.

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

Create an AI Gateway Provider

Registers a new provider for the AI Gateway.

post

Path Parameters

gatewayIdstring(uuid)requiredread-only

Contains a unique identifier used for this resource.

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

Body

application/json

CreateAIGatewayProviderRequest

CreateAIGatewayProviderRequest
One Of
typestringrequired

Allowed values:anthropic

display_namestringrequired

The display name for this provider instance.

Example:Azure AI SE

refstringrequired

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

Example:azure-ai-se

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"}

configobjectrequired

Configuration for the provider.

* Additional properties are NOT allowed.
Show Child Parameters

Response

application/json

Provider created successfully.

AIGatewayProvider

One Of
typestringrequired

Allowed values:anthropic

display_namestringrequired

The display name for this provider instance.

Example:Azure AI SE

refstringrequired

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

Example:azure-ai-se

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"}

configobjectrequired

Configuration for the provider.

* Additional properties are NOT allowed.
Show Child Parameters
post/ai-gateways/{gatewayId}/providers

Body

{}
 
application/json

Get an AI Gateway Provider

Returns the details of a specific AI Gateway provider.

get

Path Parameters

gatewayIdstring(uuid)requiredread-only

Contains a unique identifier used for this resource.

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

providerIdstring(uuid)requiredread-only

Contains a unique identifier used for this resource.

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

Response

application/json

A successful response returning an AI Gateway Provider.

AIGatewayProvider

One Of
typestringrequired

Allowed values:anthropic

display_namestringrequired

The display name for this provider instance.

Example:Azure AI SE

refstringrequired

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

Example:azure-ai-se

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"}

configobjectrequired

Configuration for the provider.

* Additional properties are NOT allowed.
Show Child Parameters
get/ai-gateways/{gatewayId}/providers/{providerId}
 
application/json

Update an AI Gateway Provider

Updates the configuration of an existing AI Gateway provider.

put

Path Parameters

gatewayIdstring(uuid)requiredread-only

Contains a unique identifier used for this resource.

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

providerIdstring(uuid)requiredread-only

Contains a unique identifier used for this resource.

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

Body

application/json

UpdateAIGatewayProviderRequest

UpdateAIGatewayProviderRequest
One Of
typestringrequired

Allowed values:anthropic

display_namestringrequired

The display name for this provider instance.

Example:Azure AI SE

refstringrequired

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

Example:azure-ai-se

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"}

configobjectrequired

Configuration for the provider.

* Additional properties are NOT allowed.
Show Child Parameters

Response

application/json

Provider updated successfully.

AIGatewayProvider

One Of
typestringrequired

Allowed values:anthropic

display_namestringrequired

The display name for this provider instance.

Example:Azure AI SE

refstringrequired

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

Example:azure-ai-se

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"}

configobjectrequired

Configuration for the provider.

* Additional properties are NOT allowed.
Show Child Parameters
put/ai-gateways/{gatewayId}/providers/{providerId}

Body

{}
 
application/json