Get a Node
Returns information about a specific node associated with the AI Gateway.
Path Parameters
Contains a unique identifier used for this resource.
Example:bf138ba2-c9b1-4229-b268-04d9d8a6410b
Contains a unique identifier used for this resource.
Example:bf138ba2-c9b1-4229-b268-04d9d8a6410b
Response
application/json
Response
A successful response containing the AI Gateway Data Plane Node.
AIGatewayDataPlaneNode
Contains a unique identifier used for this resource.
Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7
An ISO-8601 timestamp representation of entity creation date.
Example:2022-11-04T20:10:06.927Z
An ISO-8601 timestamp representation of entity update date.
Example:2022-11-04T20:10:06.927Z
The hash of the configuration applied by the node.
Show Child Parameters
Authentication
Path Parameters
AI Gateway Agents
AI Agents registered with the AI Gateway.
List AI Gateway Agents
Returns a list of all agents registered in the AI Gateway.
Query Parameters
The maximum number of items to include per page. The last page of a collection may include fewer items.
Example:10
Request the next page of data, starting with the item after this parameter.
Example:ewogICJpZCI6ICJoZWxsbyB3b3JsZCIKfQ
Path Parameters
Contains a unique identifier used for this resource.
Example:bf138ba2-c9b1-4229-b268-04d9d8a6410b
Response
application/json
Response
A paginated list of AI Agents.
Show Child Parameters
Pagination metadata.
Show Child Parameters
Authentication
Path Parameters
Query Parameters
Create an AI Gateway Agent
Creates a new agent for the AI Gateway.
Path Parameters
Contains a unique identifier used for this resource.
Example:bf138ba2-c9b1-4229-b268-04d9d8a6410b
Body
application/json
Body
CreateAIGatewayAgentRequest
The display name for this agent.
Example:Kong Air Flight Booking Agent
A user-defined unique identifier for this agent, used as a stable human-readable reference.
Example:kongair-flight-booking-agent
The type of the agent.
Allowed values:a2ahttp
Example:a2a
Lightweight object used to reference a policy instance, identified by its ref.
Show Child Parameters
Access control rules for allowing or denying consumer groups access to this agent.
Show Child Parameters
Configuration for the agent. The structure varies depending on the agent type.
Show Child Parameters
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"}
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
Response
AI Agent created successfully.
AIGatewayAgent
The display name for this agent.
Example:Kong Air Flight Booking Agent
A user-defined unique identifier for this agent, used as a stable human-readable reference.
Example:kongair-flight-booking-agent
The type of the agent.
Allowed values:a2ahttp
Example:a2a
Lightweight object used to reference a policy instance, identified by its ref.
Show Child Parameters
Access control rules for allowing or denying consumer groups access to this agent.
Show Child Parameters
Configuration for the agent. The structure varies depending on the agent type.
Show Child Parameters
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"}
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"}
Contains a unique identifier used for this resource.
Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7
An ISO-8601 timestamp representation of entity creation date.
Example:2022-11-04T20:10:06.927Z
An ISO-8601 timestamp representation of entity update date.
Example:2022-11-04T20:10:06.927Z
Authentication
Path Parameters
Body
Get an AI Gateway Agent
Returns the details of a specific AI Gateway agent.
Path Parameters
Contains a unique identifier used for this resource.
Example:bf138ba2-c9b1-4229-b268-04d9d8a6410b
Contains a unique identifier used for this resource.
Example:bf138ba2-c9b1-4229-b268-04d9d8a6410b
Response
application/json
Response
A successful response returning an AI Gateway Agent.
AIGatewayAgent
The display name for this agent.
Example:Kong Air Flight Booking Agent
A user-defined unique identifier for this agent, used as a stable human-readable reference.
Example:kongair-flight-booking-agent
The type of the agent.
Allowed values:a2ahttp
Example:a2a
Lightweight object used to reference a policy instance, identified by its ref.
Show Child Parameters
Access control rules for allowing or denying consumer groups access to this agent.
Show Child Parameters
Configuration for the agent. The structure varies depending on the agent type.
Show Child Parameters
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"}
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"}
Contains a unique identifier used for this resource.
Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7
An ISO-8601 timestamp representation of entity creation date.
Example:2022-11-04T20:10:06.927Z
An ISO-8601 timestamp representation of entity update date.
Example:2022-11-04T20:10:06.927Z