AI Gateway Agents

Get an AI Gateway Agent

Changed on

Returns the details of a specific AI Gateway agent.

get/v1/ai-gateways/{gatewayId}/agents/{agentIdOrName}

Request

  • Base URL: https://global.api.konghq.com
  • URL: https://global.api.konghq.com/v1/ai-gateways/{gatewayId}/agents/{agentIdOrName}
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer
    • HTTP bearer
    • HTTP bearer

Response

A successful response returning an AI Gateway Agent.

display_namestring required

The display name for this agent.

namestring required

Identifier for an AI Gateway entity. In some cases, this may be the entity name or ID.

enabledboolean

Whether the Agent is enabled.

type'a2a' | 'http' required

The type of the agent.

policiesstring[]

List of policy references.

labelsPublicLabels

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 "_".

managed_byManagedBy

Stores information about what manages this entity, such as the tool or system responsible for its lifecycle (for example, terraform).

Keys must be 1–63 characters long and start with an alphanumeric character.

idstring uuid required

Contains a unique identifier used for this resource.

created_atstring date-time required

An ISO-8601 timestamp representation of entity creation date.

updated_atstring date-time required

An ISO-8601 timestamp representation of entity update date.

Example response

{
  "display_name": "Kong Air Flight Booking Agent",
  "name": "my-entity-name",
  "enabled": true,
  "type": "a2a",
  "access": {
    "acls": {
      "allow": [
        "consumer-group-1"
      ]
    },
    "identity_providers": [
      "okta-ai-se"
    ],
    "auth_strategies": [
      "okta-ai-se"
    ]
  },
  "config": {
    "url": "https://booking-agent.internal.kongair.com",
    "upstream": {
      "auth": {
        "type": "aws",
        "region": "us-east-1",
        "access_key_id": "AKIAIOSFODNN7EXAMPLE"
      }
    },
    "route": {
      "headers": {
        "version": [
          "v1",
          "v2"
        ]
      },
      "hosts": [
        "foo.example.com"
      ]
    },
    "logging": {
      "max_payload_size": 524288
    }
  },
  "labels": {
    "category": "finance"
  },
  "managed_by": {
    "owner": "terraform"
  },
  "id": "5f9fd312-a987-4628-b4c5-bb4f4fddd5f7",
  "created_at": "2022-11-04T20:10:06.927Z",
  "updated_at": "2022-11-04T20:10:06.927Z"
}

Changes

  • 7aab863a6daaRevision changes
    • breaking

      added to the / response property oneOf list for the response status

  • 68d43091b84dRevision changes
    • warning

      added the new 403.00 enum value to the response property for the response status

    • warning

      added the new 404.00 enum value to the response property for the response status