AI Gateway Nodes

API related to the management of AI Gateway nodes.

List Nodes

Returns a list of nodes associated with the specified 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 Data Plane Nodes.

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

Pagination metadata.

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

Get a Node

Returns information about a specific node associated with the AI Gateway.

get

Path Parameters

gatewayIdstring(uuid)requiredread-only

Contains a unique identifier used for this resource.

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

dataPlaneNodeIdstring(uuid)requiredread-only

Contains a unique identifier used for this resource.

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

Response

application/json

A successful response containing the AI Gateway Data Plane Node.

AIGatewayDataPlaneNode

* Additional properties are NOT allowed.
idstring(uuid)requiredread-only

Contains a unique identifier used for this resource.

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

versionstringrequired
hostnamestringrequired
last_pingintegerrequired
typestringrequired
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

config_hashstringrequiredread-only

The hash of the configuration applied by the node.

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

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.

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 Agents.

dataarray[object]required
* Additional properties are allowed.
Show Child Parameters
metaobjectrequired

Pagination metadata.

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