Sign in
AI Gateway Agents

Create an AI Gateway Agent

Pre-release Endpoint This endpoint is currently in beta and is subject to change.

Creates a new agent for the AI Gateway.

post/v1/ai-gateways/{gatewayId}/agents

Request body

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.

Example request

{
  "display_name": "Kong Air Flight Booking Agent",
  "name": "my-entity-name",
  "enabled": true,
  "type": "a2a",
  "access": {
    "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"
  }
}

Response

AI Agent created successfully.

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": {
    "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

Changed in 2 of the 30 revisions of this API.87

  • cef0f947e9c986See the full diff
    • ●

      the // request property's max was set to 2147483646.00

      request-property-max-set

    • ●

      the / request property's max was set to 2147483646.00

      request-property-max-set

    • ●

      the // request property's max was set to 599.00

      request-property-max-set

    • ●

      the // request property's max was set to 2147483647.00

      request-property-max-set

    • ●

      the // request property's min was set to 0.00

      request-property-min-set

    • ●

      the / request property's min was set to 0.00

      request-property-min-set

    • ●

      the // request property's min was set to 100.00

      request-property-min-set

    • ●

      the // request property's min was set to -2147483648.00

      request-property-min-set

    • ○

      added the new optional request property /

      new-optional-request-property

    • ○

      request property / deprecated

      request-property-deprecated

    • ○

      request property // deprecated

      request-property-deprecated

    • ○

      added the optional property / to the response with the status

      response-optional-property-added

    • ○

      response property access/identity_providers deprecated

      response-property-deprecated

    • ○

      response property access/identity_providers/items/ deprecated

      response-property-deprecated

    This revision also has 9 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 658ffb748f951See the full diff
    • ○

      endpoint added

      endpoint-added

    This revision also has 3 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog