Create an AI Gateway Agent

Creates a new agent 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

CreateAIGatewayAgentRequest

* Additional properties are allowed.
display_namestringrequired

The display name for this agent.

Example:Kong Air Flight Booking Agent

refstringrequired

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

Example:kongair-flight-booking-agent

typestringrequired

The type of the agent.

Allowed values:a2ahttp

Example:a2a

policiesarray[object]required

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

* Additional properties are NOT allowed.
Show Child Parameters
aclsobjectrequired

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

* Additional properties are NOT allowed.
Show Child Parameters
configobjectrequired

Configuration for the agent. The structure varies depending on the agent type.

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

Response

application/json

AI Agent created successfully.

AIGatewayAgent

* Additional properties are allowed.
display_namestringrequired

The display name for this agent.

Example:Kong Air Flight Booking Agent

refstringrequired

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

Example:kongair-flight-booking-agent

typestringrequired

The type of the agent.

Allowed values:a2ahttp

Example:a2a

policiesarray[object]required

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

* Additional properties are NOT allowed.
Show Child Parameters
aclsobjectrequired

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

* Additional properties are NOT allowed.
Show Child Parameters
configobjectrequired

Configuration for the agent. The structure varies depending on the agent type.

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

idstring(uuid)requiredread-only

Contains a unique identifier used for this resource.

Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7

created_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity creation date.

Example:2022-11-04T20:10:06.927Z

updated_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity update date.

Example:2022-11-04T20:10:06.927Z

post/ai-gateways/{gatewayId}/agents

Body

{ "display_name": "Kong Air Flight Booking Agent", "ref": "kongair-flight-booking-agent", "type": "a2a", "policies": [ { "ref": "ai-pii-sanitizer-1234" } ], "acls": { "allow": [], "deny": [] }, "config": {} }
 
application/json

Get an AI Gateway Agent

Returns the details of a specific AI Gateway agent.

get

Path Parameters

gatewayIdstring(uuid)requiredread-only

Contains a unique identifier used for this resource.

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

agentIdstring(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 Agent.

AIGatewayAgent

* Additional properties are allowed.
display_namestringrequired

The display name for this agent.

Example:Kong Air Flight Booking Agent

refstringrequired

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

Example:kongair-flight-booking-agent

typestringrequired

The type of the agent.

Allowed values:a2ahttp

Example:a2a

policiesarray[object]required

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

* Additional properties are NOT allowed.
Show Child Parameters
aclsobjectrequired

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

* Additional properties are NOT allowed.
Show Child Parameters
configobjectrequired

Configuration for the agent. The structure varies depending on the agent type.

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

idstring(uuid)requiredread-only

Contains a unique identifier used for this resource.

Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7

created_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity creation date.

Example:2022-11-04T20:10:06.927Z

updated_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity update date.

Example:2022-11-04T20:10:06.927Z

get/ai-gateways/{gatewayId}/agents/{agentId}
 
application/json

Update an AI Gateway Agent

Updates the configuration of an existing AI Gateway agent.

put

Path Parameters

gatewayIdstring(uuid)requiredread-only

Contains a unique identifier used for this resource.

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

agentIdstring(uuid)requiredread-only

Contains a unique identifier used for this resource.

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

Body

application/json

UpdateAIGatewayAgentRequest

* Additional properties are allowed.
display_namestringrequired

The display name for this agent.

Example:Kong Air Flight Booking Agent

refstringrequired

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

Example:kongair-flight-booking-agent

typestringrequired

The type of the agent.

Allowed values:a2ahttp

Example:a2a

policiesarray[object]required

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

* Additional properties are NOT allowed.
Show Child Parameters
aclsobjectrequired

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

* Additional properties are NOT allowed.
Show Child Parameters
configobjectrequired

Configuration for the agent. The structure varies depending on the agent type.

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

Response

application/json

Agent updated successfully.

AIGatewayAgent

* Additional properties are allowed.
display_namestringrequired

The display name for this agent.

Example:Kong Air Flight Booking Agent

refstringrequired

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

Example:kongair-flight-booking-agent

typestringrequired

The type of the agent.

Allowed values:a2ahttp

Example:a2a

policiesarray[object]required

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

* Additional properties are NOT allowed.
Show Child Parameters
aclsobjectrequired

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

* Additional properties are NOT allowed.
Show Child Parameters
configobjectrequired

Configuration for the agent. The structure varies depending on the agent type.

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

idstring(uuid)requiredread-only

Contains a unique identifier used for this resource.

Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7

created_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity creation date.

Example:2022-11-04T20:10:06.927Z

updated_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity update date.

Example:2022-11-04T20:10:06.927Z

put/ai-gateways/{gatewayId}/agents/{agentId}

Body

{ "display_name": "Kong Air Flight Booking Agent", "ref": "kongair-flight-booking-agent", "type": "a2a", "policies": [ { "ref": "ai-pii-sanitizer-1234" } ], "acls": { "allow": [], "deny": [] }, "config": {} }
 
application/json

Delete an AI Gateway Agent

Removes a specific AI Gateway agent.

delete

Path Parameters

gatewayIdstring(uuid)requiredread-only

Contains a unique identifier used for this resource.

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

agentIdstring(uuid)requiredread-only

Contains a unique identifier used for this resource.

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

Response

Agent deleted successfully.

delete/ai-gateways/{gatewayId}/agents/{agentId}
 

AI Gateway Consumers

Individual consumers with credentials and group memberships for AI Gateway access control.