---
title: "Konnect AI Gateway"
url: "https://nov18-dev.movespot.fyi/apis/konnect-ai-gateway-dev-0/versions/eaabd2fa-a9d5-44cc-b086-e210c9c21bf3"
---

# Konnect AI Gateway

OpenAPI specification document.

```json
{"openapi":"3.0.0","info":{"title":"Konnect AI Gateway","version":"0.0.0","description":"Internal API for managing Kong AI Gateway policies.","contact":{"name":"Kong","url":"https://cloud.konghq.com"}},"servers":[{"url":"https://us.api.konghq.com/v1","description":"United-States Production region"},{"url":"https://eu.api.konghq.com/v1","description":"Europe Production region"},{"url":"https://au.api.konghq.com/v1","description":"Australia Production region"},{"url":"https://me.api.konghq.com/v1","description":"Middle-East Production region"},{"url":"https://in.api.konghq.com/v1","description":"India Production region"},{"url":"https://sg.api.konghq.com/v1","description":"Singapore Production region"}],"paths":{"/ai-gateways":{"get":{"operationId":"list-ai-gateways","summary":"List AI Gateways","description":"Returns a list of AI Gateways in the organization.","parameters":[{"$ref":"#/components/parameters/PageSize"},{"$ref":"#/components/parameters/PageNumber"}],"responses":{"200":{"$ref":"#/components/responses/ListAIGatewaysResponse"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"tags":["AI Gateways"]},"post":{"operationId":"create-ai-gateway","summary":"Create an AI Gateway","description":"Creates a new AI Gateway in the organization.","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateAIGatewayRequest"},"examples":{"Example Request Body":{"$ref":"#/components/examples/CreateAIGatewayRequestExample"}}}}},"responses":{"201":{"$ref":"#/components/responses/CreateAIGatewayResponse"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"409":{"$ref":"#/components/responses/Conflict"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"tags":["AI Gateways"]}},"/ai-gateways/{gatewayId}":{"parameters":[{"$ref":"#/components/parameters/AIGatewayId"}],"get":{"operationId":"get-ai-gateway","summary":"Get an AI Gateway","description":"Returns the details of a specific AI Gateway.","responses":{"200":{"$ref":"#/components/responses/GetAIGatewayResponse"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"tags":["AI Gateways"]},"put":{"operationId":"update-ai-gateway","summary":"Update an AI Gateway","description":"Updates the configuration of an existing AI Gateway.","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateAIGatewayRequest"},"examples":{"Example Request Body":{"$ref":"#/components/examples/UpdateAIGatewayRequestExample"}}}}},"responses":{"200":{"$ref":"#/components/responses/UpdateAIGatewayResponse"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"tags":["AI Gateways"]},"delete":{"operationId":"delete-ai-gateway","summary":"Delete an AI Gateway","description":"Deletes an existing AI Gateway.","responses":{"204":{"description":"AI Gateway deleted successfully."},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"tags":["AI Gateways"]}},"/ai-gateways/{gatewayId}/data-plane-certificates":{"parameters":[{"$ref":"#/components/parameters/AIGatewayId"}],"get":{"operationId":"list-ai-gateway-data-plane-certificates","summary":"List AI Gateway DataPlane Certificates","description":"Returns a list of DataPlane certificates that are associated to this AI Gateway. A DataPlane certificate allows DataPlanes configured with the certificate and corresponding private key to establish connection with this AI Gateway.","parameters":[{"$ref":"#/components/parameters/PageSize"},{"$ref":"#/components/parameters/PageAfter"}],"responses":{"200":{"$ref":"#/components/responses/ListAIGatewayDataPlaneCertificatesResponse"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"tags":["AI Gateway DataPlane Certificates"]},"post":{"operationId":"create-ai-gateway-data-plane-certificate","summary":"Create New AI Gateway DataPlane Certificate","description":"Create a new DataPlane Certificate for this AI Gateway. A DataPlane certificate allows DataPlanes configured with the certificate and corresponding private key to establish connection with this AI Gateway.","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateAIGatewayDataPlaneCertificateRequest"},"examples":{"Example Request Body":{"$ref":"#/components/examples/AIGatewayDataplaneCertificateExample"}}}}},"responses":{"201":{"$ref":"#/components/responses/CreateAIGatewayDataPlaneCertificateResponse"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"tags":["AI Gateway DataPlane Certificates"]}},"/ai-gateways/{gatewayId}/data-plane-certificates/{certificateId}":{"parameters":[{"$ref":"#/components/parameters/AIGatewayId"},{"$ref":"#/components/parameters/AIGatewayDataPlaneCertificateId"}],"get":{"operationId":"get-ai-gateway-data-plane-certificate","summary":"Get a DataPlane Certificate","description":"Retrieve a DataPlane certificate associated to this AI Gateway. A DataPlane certificate allows DataPlanes configured with the certificate and corresponding private key to establish connection with this AI Gateway.","responses":{"200":{"$ref":"#/components/responses/GetAIGatewayDataPlaneCertificateResponse"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"tags":["AI Gateway DataPlane Certificates"]},"delete":{"operationId":"delete-ai-gateway-data-plane-certificate","summary":"Delete AI Gateway DataPlane Certificate","description":"Remove a DataPlane client certificate associated to this AI Gateway. Removing a DataPlane certificate would invalidate any DataPlanes currently connected to this AI Gateway using this certificate.","responses":{"204":{"description":"No Content"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"tags":["AI Gateway DataPlane Certificates"]}},"/ai-gateways/{gatewayId}/nodes":{"get":{"operationId":"list-ai-gateway-nodes","summary":"List Nodes","description":"Returns a list of nodes associated with the specified AI Gateway.","parameters":[{"$ref":"#/components/parameters/PageSize"},{"$ref":"#/components/parameters/PageAfter"}],"responses":{"200":{"$ref":"#/components/responses/ListAIGatewayDataPlaneNodesResponse"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"tags":["AI Gateway Nodes"]},"parameters":[{"$ref":"#/components/parameters/AIGatewayId"}]},"/ai-gateways/{gatewayId}/nodes/{dataPlaneNodeId}":{"parameters":[{"$ref":"#/components/parameters/AIGatewayId"},{"$ref":"#/components/parameters/AIGatewayDataPlaneNodeId"}],"get":{"operationId":"get-ai-gateway-node","summary":"Get a Node","description":"Returns information about a specific node associated with the AI Gateway.","responses":{"200":{"$ref":"#/components/responses/GetAIGatewayDataPlaneNodeResponse"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"tags":["AI Gateway Nodes"]}},"/ai-gateways/{gatewayId}/policies":{"parameters":[{"$ref":"#/components/parameters/AIGatewayId"}],"get":{"operationId":"list-ai-gateway-policies","summary":"List AI Gateway Policies","description":"Returns a list of policies configured for the AI Gateway.","parameters":[{"$ref":"#/components/parameters/PageSize"},{"$ref":"#/components/parameters/PageAfter"}],"responses":{"200":{"$ref":"#/components/responses/ListAIGatewayPoliciesResponse"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"tags":["AI Gateway Policies"]},"post":{"operationId":"create-ai-gateway-policy","summary":"Create an AI Gateway Policy","description":"Registers a new policy for the AI Gateway.","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateAIGatewayPolicyRequest"}}}},"responses":{"201":{"$ref":"#/components/responses/CreateAIGatewayPolicyResponse"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"409":{"$ref":"#/components/responses/Conflict"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"tags":["AI Gateway Policies"]}},"/ai-gateways/{gatewayId}/policies/{policyId}":{"parameters":[{"$ref":"#/components/parameters/AIGatewayId"},{"$ref":"#/components/parameters/AIGatewayPolicyId"}],"get":{"operationId":"get-ai-gateway-policy","summary":"Get an AI Gateway Policy","description":"Returns the details of a specific AI Gateway policy.","responses":{"200":{"$ref":"#/components/responses/GetAIGatewayPolicyResponse"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"tags":["AI Gateway Policies"]},"put":{"operationId":"update-ai-gateway-policy","summary":"Update an AI Gateway Policy","description":"Updates the configuration of an existing AI Gateway policy.","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateAIGatewayPolicyRequest"}}}},"responses":{"200":{"$ref":"#/components/responses/UpdateAIGatewayPolicyResponse"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"tags":["AI Gateway Policies"]},"delete":{"operationId":"delete-ai-gateway-policy","summary":"Delete an AI Gateway Policy","description":"Removes a specific AI Gateway policy.","responses":{"204":{"description":"Policy deleted successfully."},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"tags":["AI Gateway Policies"]}},"/ai-gateways/{gatewayId}/models":{"parameters":[{"$ref":"#/components/parameters/AIGatewayId"}],"get":{"operationId":"list-ai-gateway-models","summary":"List AI Gateway Models","description":"Returns a list of all models registered in the AI Gateway.","parameters":[{"$ref":"#/components/parameters/PageSize"},{"$ref":"#/components/parameters/PageAfter"}],"responses":{"200":{"$ref":"#/components/responses/ListAIGatewayModelsResponse"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"tags":["AI Gateway Models"]},"post":{"operationId":"create-ai-gateway-model","summary":"Create an AI Gateway Model","description":"Registers a new model with routing, capabilities, and target backends.","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateAIGatewayModelRequest"}}}},"responses":{"201":{"$ref":"#/components/responses/CreateAIGatewayModelResponse"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"409":{"$ref":"#/components/responses/Conflict"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"tags":["AI Gateway Models"]}},"/ai-gateways/{gatewayId}/models/{modelId}":{"parameters":[{"$ref":"#/components/parameters/AIGatewayId"},{"$ref":"#/components/parameters/AIGatewayModelId"}],"get":{"operationId":"get-ai-gateway-model","summary":"Get an AI Gateway Model","description":"Returns the details of a specific AI Gateway model.","responses":{"200":{"$ref":"#/components/responses/GetAIGatewayModelResponse"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"tags":["AI Gateway Models"]},"put":{"operationId":"update-ai-gateway-model","summary":"Update an AI Gateway Model","description":"Updates the configuration of an existing AI Gateway model.","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateAIGatewayModelRequest"}}}},"responses":{"200":{"$ref":"#/components/responses/UpdateAIGatewayModelResponse"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"tags":["AI Gateway Models"]},"delete":{"operationId":"delete-ai-gateway-model","summary":"Delete an AI Gateway Model","description":"Removes a specific AI Gateway model.","responses":{"204":{"description":"Model deleted successfully."},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"tags":["AI Gateway Models"]}},"/ai-gateways/{gatewayId}/agents":{"parameters":[{"$ref":"#/components/parameters/AIGatewayId"}],"get":{"operationId":"list-ai-gateway-agents","summary":"List AI Gateway Agents","description":"Returns a list of all agents registered in the AI Gateway.","parameters":[{"$ref":"#/components/parameters/PageSize"},{"$ref":"#/components/parameters/PageAfter"}],"responses":{"200":{"$ref":"#/components/responses/ListAIGatewayAgentsResponse"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"tags":["AI Gateway Agents"]},"post":{"operationId":"create-ai-gateway-agent","summary":"Create an AI Gateway Agent","description":"Creates a new agent for the AI Gateway.","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateAIGatewayAgentRequest"}}}},"responses":{"201":{"$ref":"#/components/responses/CreateAIGatewayAgentResponse"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"409":{"$ref":"#/components/responses/Conflict"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"tags":["AI Gateway Agents"]}},"/ai-gateways/{gatewayId}/agents/{agentId}":{"parameters":[{"$ref":"#/components/parameters/AIGatewayId"},{"$ref":"#/components/parameters/AIGatewayAgentId"}],"get":{"operationId":"get-ai-gateway-agent","summary":"Get an AI Gateway Agent","description":"Returns the details of a specific AI Gateway agent.","responses":{"200":{"$ref":"#/components/responses/GetAIGatewayAgentResponse"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"tags":["AI Gateway Agents"]},"put":{"operationId":"update-ai-gateway-agent","summary":"Update an AI Gateway Agent","description":"Updates the configuration of an existing AI Gateway agent.","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateAIGatewayAgentRequest"}}}},"responses":{"200":{"$ref":"#/components/responses/UpdateAIGatewayAgentResponse"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"tags":["AI Gateway Agents"]},"delete":{"operationId":"delete-ai-gateway-agent","summary":"Delete an AI Gateway Agent","description":"Removes a specific AI Gateway agent.","responses":{"204":{"description":"Agent deleted successfully."},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"tags":["AI Gateway Agents"]}},"/ai-gateways/{gatewayId}/consumers":{"parameters":[{"$ref":"#/components/parameters/AIGatewayId"}],"get":{"operationId":"list-ai-gateway-consumers","summary":"List AI Gateway Consumers","description":"Returns a list of all consumers for the AI Gateway.","parameters":[{"$ref":"#/components/parameters/PageSize"},{"$ref":"#/components/parameters/PageAfter"}],"responses":{"200":{"$ref":"#/components/responses/ListAIGatewayConsumersResponse"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"tags":["AI Gateway Consumers"]},"post":{"operationId":"create-ai-gateway-consumer","summary":"Create an AI Gateway Consumer","description":"Creates a new consumer for the AI Gateway.","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateAIGatewayConsumerRequest"}}}},"responses":{"201":{"$ref":"#/components/responses/CreateAIGatewayConsumerResponse"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"409":{"$ref":"#/components/responses/Conflict"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"tags":["AI Gateway Consumers"]}},"/ai-gateways/{gatewayId}/consumers/{consumerId}":{"parameters":[{"$ref":"#/components/parameters/AIGatewayId"},{"$ref":"#/components/parameters/AIGatewayConsumerId"}],"get":{"operationId":"get-ai-gateway-consumer","summary":"Get an AI Gateway Consumer","description":"Returns the details of a specific AI Gateway consumer.","responses":{"200":{"$ref":"#/components/responses/GetAIGatewayConsumerResponse"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"tags":["AI Gateway Consumers"]},"put":{"operationId":"update-ai-gateway-consumer","summary":"Update an AI Gateway Consumer","description":"Updates the configuration of an existing AI Gateway consumer.","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateAIGatewayConsumerRequest"}}}},"responses":{"200":{"$ref":"#/components/responses/UpdateAIGatewayConsumerResponse"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"tags":["AI Gateway Consumers"]},"delete":{"operationId":"delete-ai-gateway-consumer","summary":"Delete an AI Gateway Consumer","description":"Removes a specific AI Gateway consumer.","responses":{"204":{"description":"Consumer deleted successfully."},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"tags":["AI Gateway Consumers"]}},"/ai-gateways/{gatewayId}/consumer-groups":{"parameters":[{"$ref":"#/components/parameters/AIGatewayId"}],"get":{"operationId":"list-ai-gateway-consumer-groups","summary":"List AI Gateway Consumer Groups","description":"Returns a list of all consumer groups for the AI Gateway.","parameters":[{"$ref":"#/components/parameters/PageSize"},{"$ref":"#/components/parameters/PageAfter"}],"responses":{"200":{"$ref":"#/components/responses/ListAIGatewayConsumerGroupsResponse"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"tags":["AI Gateway Consumer Groups"]},"post":{"operationId":"create-ai-gateway-consumer-group","summary":"Create an AI Gateway Consumer Group","description":"Creates a new Consumer Group for the AI Gateway.","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateAIGatewayConsumerGroupRequest"}}}},"responses":{"201":{"$ref":"#/components/responses/CreateAIGatewayConsumerGroupResponse"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"409":{"$ref":"#/components/responses/Conflict"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"tags":["AI Gateway Consumer Groups"]}},"/ai-gateways/{gatewayId}/consumer-groups/{consumerGroupId}":{"parameters":[{"$ref":"#/components/parameters/AIGatewayId"},{"$ref":"#/components/parameters/AIGatewayConsumerGroupId"}],"get":{"operationId":"get-ai-gateway-consumer-group","summary":"Get an AI Gateway Consumer Group","description":"Returns the details of a specific AI Gateway Consumer Group.","responses":{"200":{"$ref":"#/components/responses/GetAIGatewayConsumerGroupResponse"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"tags":["AI Gateway Consumer Groups"]},"put":{"operationId":"update-ai-gateway-consumer-group","summary":"Update an AI Gateway Consumer Group","description":"Updates the configuration of an existing AI Gateway Consumer Group.","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateAIGatewayConsumerGroupRequest"}}}},"responses":{"200":{"$ref":"#/components/responses/UpdateAIGatewayConsumerGroupResponse"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"tags":["AI Gateway Consumer Groups"]},"delete":{"operationId":"delete-ai-gateway-consumer-group","summary":"Delete an AI Gateway Consumer Group","description":"Removes a specific AI Gateway Consumer Group.","responses":{"204":{"description":"Consumer Group deleted successfully."},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"tags":["AI Gateway Consumer Groups"]}},"/ai-gateways/{gatewayId}/mcp-servers":{"parameters":[{"$ref":"#/components/parameters/AIGatewayId"}],"get":{"operationId":"list-ai-gateway-mcp-servers","summary":"List MCP Servers","description":"Returns a list of MCP Servers configured for the AI Gateway.","parameters":[{"$ref":"#/components/parameters/PageSize"},{"$ref":"#/components/parameters/PageAfter"}],"responses":{"200":{"$ref":"#/components/responses/ListAIGatewayMCPServersResponse"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"tags":["AI Gateway MCP Servers"]},"post":{"operationId":"create-ai-gateway-mcp-server","summary":"Create an MCP Server","description":"Registers a new MCP Server for the AI Gateway.","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateAIGatewayMCPServerRequest"}}}},"responses":{"201":{"$ref":"#/components/responses/CreateAIGatewayMCPServerResponse"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"409":{"$ref":"#/components/responses/Conflict"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"tags":["AI Gateway MCP Servers"]}},"/ai-gateways/{gatewayId}/mcp-servers/{mcpServerId}":{"parameters":[{"$ref":"#/components/parameters/AIGatewayId"},{"$ref":"#/components/parameters/AIGatewayMcpServerId"}],"get":{"operationId":"get-ai-gateway-mcp-server","summary":"Get an MCP Server","description":"Returns the details of a specific MCP Server.","responses":{"200":{"$ref":"#/components/responses/GetMCPServerResponse"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"tags":["AI Gateway MCP Servers"]},"put":{"operationId":"update-ai-gateway-mcp-server","summary":"Update an MCP Server","description":"Updates the configuration of an existing MCP Server.","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateAIGatewayMCPServerRequest"}}}},"responses":{"200":{"$ref":"#/components/responses/UpdateAIGatewayMCPServerResponse"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"tags":["AI Gateway MCP Servers"]},"delete":{"operationId":"delete-ai-gateway-mcp-server","summary":"Delete an MCP Server","description":"Removes a specific MCP Server from the AI Gateway.","responses":{"204":{"description":"MCP Server deleted successfully."},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"tags":["AI Gateway MCP Servers"]}},"/ai-gateways/{gatewayId}/providers":{"parameters":[{"$ref":"#/components/parameters/AIGatewayId"}],"get":{"operationId":"list-ai-gateway-providers","summary":"List AI Gateway Providers","description":"Returns a list of providers configured for the AI Gateway.","parameters":[{"$ref":"#/components/parameters/PageSize"},{"$ref":"#/components/parameters/PageAfter"}],"responses":{"200":{"$ref":"#/components/responses/ListAIGatewayProvidersResponse"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"tags":["AI Gateway Providers"]},"post":{"operationId":"create-ai-gateway-provider","summary":"Create an AI Gateway Provider","description":"Registers a new provider for the AI Gateway.","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateAIGatewayProviderRequest"}}}},"responses":{"201":{"$ref":"#/components/responses/CreateAIGatewayProviderResponse"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"409":{"$ref":"#/components/responses/Conflict"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"tags":["AI Gateway Providers"]}},"/ai-gateways/{gatewayId}/providers/{providerId}":{"parameters":[{"$ref":"#/components/parameters/AIGatewayId"},{"$ref":"#/components/parameters/AIGatewayProviderId"}],"get":{"operationId":"get-ai-gateway-provider","summary":"Get an AI Gateway Provider","description":"Returns the details of a specific AI Gateway provider.","responses":{"200":{"$ref":"#/components/responses/GetAIGatewayProviderResponse"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"tags":["AI Gateway Providers"]},"put":{"operationId":"update-ai-gateway-provider","summary":"Update an AI Gateway Provider","description":"Updates the configuration of an existing AI Gateway provider.","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateAIGatewayProviderRequest"}}}},"responses":{"200":{"$ref":"#/components/responses/UpdateAIGatewayProviderResponse"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"tags":["AI Gateway Providers"]},"delete":{"operationId":"delete-ai-gateway-provider","summary":"Delete an AI Gateway Provider","description":"Removes a specific AI Gateway provider.","responses":{"204":{"description":"Provider deleted successfully."},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"}},"tags":["AI Gateway Providers"]}}},"components":{"parameters":{"AIGatewayAgentId":{"name":"agentId","in":"path","required":true,"description":"The unique ID of the AI Gateway agent.","example":"bf138ba2-c9b1-4229-b268-04d9d8a6410b","schema":{"$ref":"#/components/schemas/UUID"}},"AIGatewayConsumerGroupId":{"name":"consumerGroupId","in":"path","required":true,"description":"The unique ID of the AI Gateway Consumer Group.","example":"bf138ba2-c9b1-4229-b268-04d9d8a6410b","schema":{"$ref":"#/components/schemas/UUID"}},"AIGatewayConsumerId":{"name":"consumerId","in":"path","required":true,"description":"The unique ID of the AI Gateway consumer.","example":"bf138ba2-c9b1-4229-b268-04d9d8a6410b","schema":{"$ref":"#/components/schemas/UUID"}},"AIGatewayDataPlaneCertificateId":{"name":"certificateId","in":"path","required":true,"description":"The unique ID of the DataPlane Certificate.","example":"bf138ba2-c9b1-4229-b268-04d9d8a6410b","schema":{"$ref":"#/components/schemas/UUID"}},"AIGatewayDataPlaneNodeId":{"name":"dataPlaneNodeId","in":"path","required":true,"description":"The unique ID of the AI Gateway DataPlane Node.","example":"bf138ba2-c9b1-4229-b268-04d9d8a6410b","schema":{"$ref":"#/components/schemas/UUID"}},"AIGatewayId":{"name":"gatewayId","in":"path","required":true,"description":"The unique ID of the AI Gateway.","example":"bf138ba2-c9b1-4229-b268-04d9d8a6410b","schema":{"$ref":"#/components/schemas/UUID"}},"AIGatewayMcpServerId":{"name":"mcpServerId","in":"path","required":true,"description":"The unique ID of the MCP Server.","example":"bf138ba2-c9b1-4229-b268-04d9d8a6410b","schema":{"$ref":"#/components/schemas/UUID"}},"AIGatewayModelId":{"name":"modelId","in":"path","required":true,"description":"The unique ID of the AI Gateway model.","example":"bf138ba2-c9b1-4229-b268-04d9d8a6410b","schema":{"$ref":"#/components/schemas/UUID"}},"AIGatewayPolicyId":{"name":"policyId","in":"path","required":true,"description":"The unique ID of the AI Gateway policy.","example":"bf138ba2-c9b1-4229-b268-04d9d8a6410b","schema":{"$ref":"#/components/schemas/UUID"}},"AIGatewayProviderId":{"name":"providerId","in":"path","required":true,"description":"The unique ID of the AI Gateway provider.","example":"bf138ba2-c9b1-4229-b268-04d9d8a6410b","schema":{"$ref":"#/components/schemas/UUID"}},"PageAfter":{"name":"page[after]","description":"Request the next page of data, starting with the item after this parameter.","required":false,"in":"query","allowEmptyValue":true,"schema":{"type":"string","example":"ewogICJpZCI6ICJoZWxsbyB3b3JsZCIKfQ"}},"PageNumber":{"name":"page[number]","description":"Determines which page of the entities to retrieve.","required":false,"in":"query","allowEmptyValue":true,"schema":{"type":"integer","example":1}},"PageSize":{"name":"page[size]","description":"The maximum number of items to include per page. The last page of a collection may include fewer items.","required":false,"in":"query","allowEmptyValue":true,"schema":{"type":"integer","example":10}}},"schemas":{"CreateAIGatewayRequest":{"type":"object","properties":{"name":{"description":"The name of the AI Gateway.","type":"string","example":"My AI Gateway"},"description":{"description":"The description of the AI Gateway.","type":"string","example":"An AI Gateway for my organization."},"labels":{"$ref":"#/components/schemas/PublicLabels"}},"additionalProperties":true,"required":["name"]},"UpdateAIGatewayRequest":{"type":"object","properties":{"name":{"description":"The name of the AI Gateway.","type":"string","example":"My AI Gateway"},"description":{"description":"The description of the AI Gateway.","type":"string","example":"An AI Gateway for my organization."},"labels":{"$ref":"#/components/schemas/PublicLabels"}},"additionalProperties":true,"required":["name"]},"AIGateway":{"type":"object","properties":{"name":{"description":"The name of the AI Gateway.","type":"string","example":"My AI Gateway"},"description":{"description":"The description of the AI Gateway.","type":"string","example":"An AI Gateway for my organization."},"labels":{"$ref":"#/components/schemas/PublicLabels"},"id":{"$ref":"#/components/schemas/UUID"},"endpoints":{"description":"Object containing AI Gateway access endpoints.","type":"object","additionalProperties":false,"properties":{"configuration":{"description":"Configuration Endpoint.","type":"string","format":"url","example":"https://acfe5f253f.cp.konghq.com","readOnly":true},"telemetry":{"description":"Telemetry Endpoint.","type":"string","format":"url","example":"https://acfe5f253f.tp0.konghq.com","readOnly":true}},"required":["configuration","telemetry"]},"config_hash":{"description":"The hash of the latest configuration for the gateway. Every change to an entity\nunder this gateway will result in a new config_hash being generated.\nThe config hash can be used to verify if the config hash of an AI Gateway\nnode is up to date with the AI Gateway. The config hash will be the same if they are in sync.\n","type":"string","readOnly":true},"created_at":{"$ref":"#/components/schemas/CreatedAt"},"updated_at":{"$ref":"#/components/schemas/UpdatedAt"}},"additionalProperties":true,"required":["name","id","endpoints","config_hash","created_at","updated_at"]},"CreateAIGatewayDataPlaneCertificateRequest":{"type":"object","properties":{"cert":{"description":"JSON escaped string of the certificate.","type":"string"},"title":{"description":"A human-readable name for the certificate.","type":"string"},"description":{"description":"An optional description of the certificate.","type":"string"}},"additionalProperties":false,"required":["cert","title"]},"AIGatewayDataPlaneClientCertificate":{"type":"object","properties":{"cert":{"description":"JSON escaped string of the certificate.","type":"string"},"title":{"description":"A human-readable name for the certificate.","type":"string"},"description":{"description":"An optional description of the certificate.","type":"string"},"id":{"$ref":"#/components/schemas/UUID"},"created_at":{"$ref":"#/components/schemas/CreatedAt"},"updated_at":{"$ref":"#/components/schemas/UpdatedAt"}},"additionalProperties":false,"required":["cert","title","id","created_at","updated_at"]},"AIGatewayDataPlaneNode":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/UUID"},"version":{"type":"string"},"hostname":{"type":"string"},"last_ping":{"type":"integer"},"type":{"type":"string"},"created_at":{"$ref":"#/components/schemas/CreatedAt"},"updated_at":{"$ref":"#/components/schemas/UpdatedAt"},"config_hash":{"description":"The hash of the configuration applied by the node.","type":"string","readOnly":true},"compatibility_status":{"type":"object","additionalProperties":false,"properties":{"state":{"type":"string"},"issues":{"type":"array","items":{"$ref":"#/components/schemas/AIGatewayDataPlaneNodeCompatibilityIssue"}}}}},"additionalProperties":false,"required":["id","version","hostname","last_ping","type","created_at","updated_at","config_hash","compatibility_status"]},"AIGatewayDataPlaneNodeCompatibilityIssue":{"type":"object","properties":{"code":{"description":"The compatibility issue code.","type":"string"},"severity":{"description":"The severity of the issue.","type":"string"},"description":{"description":"The description of the issue.","type":"string"},"resolution":{"description":"Steps required to take in order to resolve the issue.","type":"string"},"affected_resources":{"description":"Details of the resources affected by the issue.","type":"array","items":{"$ref":"#/components/schemas/AIGatewayDataPlaneNodeCompatibilityIssueAffectedResource"}},"documentation_url":{"description":"Doc URL for the compatibility issue.","type":"string"}},"additionalProperties":false,"required":["code","severity","description","resolution","affected_resources","documentation_url"]},"AIGatewayDataPlaneNodeCompatibilityIssueAffectedResource":{"type":"object","properties":{"id":{"description":"ID of the affected resource.","type":"string"},"type":{"description":"Type of the affected resource.","type":"string"},"parent_code":{"description":"Parent Issue Code.","type":"string"},"details":{"description":"Details of the affected resource.","type":"array","items":{"type":"string"}}},"additionalProperties":false,"required":["id","type","parent_code","details"]},"AIGatewayModelModel":{"type":"object","properties":{"display_name":{"description":"The display name for this policy instance.","type":"string","example":"My GPT 5 model"},"ref":{"description":"A user-defined unique identifier for this model, used as a stable human-readable reference.","type":"string","example":"my-gpt-5-model"},"enabled":{"description":"Whether the model is enabled.","type":"boolean","example":true,"default":true},"acls":{"description":"Access control rules for allowing or denying consumer groups access to this model.","allOf":[{"$ref":"#/components/schemas/AIGatewayACLS"}]},"config":{"$ref":"#/components/schemas/AIGatewayModelConfig"},"formats":{"description":"List of request/response formats supported by this model. Defaults to OpenAI format.","type":"array","items":{"$ref":"#/components/schemas/AIGatewayModelFormat"}},"target_models":{"description":"One or more backend models that this model entry routes to.","type":"array","items":{"$ref":"#/components/schemas/AIGatewayTargetModel"}},"policies":{"type":"array","items":{"$ref":"#/components/schemas/AIGatewayPolicyReference"}},"labels":{"$ref":"#/components/schemas/PublicLabels"},"managed_by":{"$ref":"#/components/schemas/AIGatewayManagedBy"},"type":{"type":"string","enum":["model"]},"capabilities":{"description":"List of AI capabilities enabled for this model.","type":"array","items":{"type":"string","enum":["chat","embeddings","assistants","responses","audio-transcriptions","audio-translations","image-generation","image-edits","video-generations","realtime"]}}},"additionalProperties":false,"required":["display_name","ref","formats","acls","config","target_models","policies","type","capabilities"]},"AIGatewayModelAPI":{"type":"object","properties":{"display_name":{"description":"The display name for this policy instance.","type":"string","example":"My GPT 5 model"},"ref":{"description":"A user-defined unique identifier for this model, used as a stable human-readable reference.","type":"string","example":"my-gpt-5-model"},"enabled":{"description":"Whether the model is enabled.","type":"boolean","example":true,"default":true},"acls":{"description":"Access control rules for allowing or denying consumer groups access to this model.","allOf":[{"$ref":"#/components/schemas/AIGatewayACLS"}]},"config":{"$ref":"#/components/schemas/AIGatewayModelConfig"},"formats":{"description":"List of request/response formats supported by this model. Defaults to OpenAI format.","type":"array","items":{"$ref":"#/components/schemas/AIGatewayModelFormat"}},"target_models":{"description":"One or more backend models that this model entry routes to.","type":"array","items":{"$ref":"#/components/schemas/AIGatewayTargetModel"}},"policies":{"type":"array","items":{"$ref":"#/components/schemas/AIGatewayPolicyReference"}},"labels":{"$ref":"#/components/schemas/PublicLabels"},"managed_by":{"$ref":"#/components/schemas/AIGatewayManagedBy"},"type":{"type":"string","enum":["api"]},"capabilities":{"description":"List of AI capabilities enabled for this API model.","type":"array","items":{"type":"string","enum":["batches","files"]}}},"additionalProperties":false,"required":["display_name","ref","formats","acls","config","target_models","policies","type","capabilities"]},"CreateAIGatewayModelRequest":{"description":"Configuration for an AI Gateway model.","discriminator":{"propertyName":"type","mapping":{"model":"#/components/schemas/AIGatewayModelModel","api":"#/components/schemas/AIGatewayModelAPI"}},"oneOf":[{"$ref":"#/components/schemas/AIGatewayModelModel"},{"$ref":"#/components/schemas/AIGatewayModelAPI"}]},"UpdateAIGatewayModelRequest":{"description":"Configuration for an AI Gateway model.","discriminator":{"propertyName":"type","mapping":{"model":"#/components/schemas/AIGatewayModelModel","api":"#/components/schemas/AIGatewayModelAPI"}},"oneOf":[{"$ref":"#/components/schemas/AIGatewayModelModel"},{"$ref":"#/components/schemas/AIGatewayModelAPI"}]},"AIGatewayModel":{"description":"Configuration for an AI Gateway model.","type":"object","properties":{"id":{"$ref":"#/components/schemas/UUID"},"created_at":{"$ref":"#/components/schemas/CreatedAt"},"updated_at":{"$ref":"#/components/schemas/UpdatedAt"}},"additionalProperties":false,"discriminator":{"propertyName":"type","mapping":{"model":"#/components/schemas/AIGatewayModelModel","api":"#/components/schemas/AIGatewayModelAPI"}},"oneOf":[{"$ref":"#/components/schemas/AIGatewayModelModel"},{"$ref":"#/components/schemas/AIGatewayModelAPI"}],"required":["id","created_at","updated_at"]},"AIGatewayModelConfig":{"description":"Routing, logging, and load balancing configuration for the model.","type":"object","properties":{"route":{"$ref":"#/components/schemas/AIGatewayRouteConfig"},"logging":{"$ref":"#/components/schemas/AIGatewayLoggingConfig"},"response_streaming":{"type":"string","default":"allow","enum":["allow","always","deny"]},"max_request_body_size":{"type":"integer","default":1048576},"model":{"type":"object","additionalProperties":false,"properties":{"alias":{"description":"An optional alias for the model, used to select the target virtual model when passed in the \"model\" parameter of the request body.","type":"string"},"name_header":{"description":"Display the model name selected in the X-Kong-LLM-Model response header","type":"boolean"}},"required":["name_header"]},"balancer":{"description":"Load balancing strategy when multiple target models are configured.","type":"object","additionalProperties":false,"properties":{"algorithm":{"description":"Which load balancing algorithm to use.","type":"string","default":"round-robin","enum":["consistent-hashing","least-connections","lowest-latency","lowest-usage","priority","round-robin","semantic"]},"connect_timeout":{"type":"integer","default":60000,"maximum":2147483646,"minimum":1},"embeddings":{"description":"Embeddings model configuration for this model.","type":"object","additionalProperties":false,"properties":{"provider":{"$ref":"#/components/schemas/AIGatewayProviderReference"},"name":{"description":"The name of the embeddings model.","type":"string"},"config":{"$ref":"#/components/schemas/AIGatewayEmbeddingsModelConfig"}},"required":["name","provider"]},"fail_timeout":{"description":"The period of time (in milliseconds) the target will be considered unavailable after the number of unsuccessful attempts reaches `max_fails`.","type":"integer","default":10000,"maximum":2147483646,"minimum":1},"failover_criteria":{"description":"Specifies in which cases an upstream response should be failover to the next target. Each option in the array is equivalent to the function of https://nginx.org/en/docs/http/ngx_http_proxy_module.html#proxy_next_upstream","type":"array","items":{"type":"string","enum":["error","http_403","http_404","http_429","http_500","http_502","http_503","http_504","invalid_header","non_idempotent","timeout"]},"default":["error","timeout"]},"hash_on_header":{"description":"The header to use for consistent-hashing.","type":"string","default":"X-Kong-LLM-Request-ID"},"latency_strategy":{"description":"What metrics to use for latency. Available values are: `tpot` (time-per-output-token) and `e2e`.","type":"string","default":"tpot","enum":["e2e","tpot"]},"max_fails":{"description":"Number of unsuccessful attempts to communicate with a target that should occur in the duration defined by `fail_timeout` before the target is considered unavailable. The zero value disables the circuit breaker. What is considered an unsuccessful attempt is defined by `failover_criteria`. Note the cases of `error`, `timeout` and `invalid_header` are always considered unsuccessful attempts, while the cases of `http_403` and `http_404` are never considered unsuccessful attempts.","type":"integer","default":0,"maximum":32767,"minimum":0},"read_timeout":{"type":"integer","default":60000,"maximum":2147483646,"minimum":1},"retries":{"description":"The number of retries to execute upon failure to proxy.","type":"integer","default":5,"maximum":32767,"minimum":0},"slots":{"description":"The number of slots in the load balancer algorithm.","type":"integer","default":10000,"maximum":65536,"minimum":10},"tokens_count_strategy":{"description":"What tokens to use for usage calculation. Available values are: `total_tokens` `prompt_tokens`, `completion_tokens` and `cost`.","type":"string","default":"total-tokens","enum":["completion-tokens","cost","llm-accuracy","prompt-tokens","total-tokens"]},"vectordb":{"$ref":"#/components/schemas/AIGatewayModelVectorDBConfig"},"write_timeout":{"type":"integer","default":60000,"maximum":2147483646,"minimum":1}},"required":["algorithm","connect_timeout","fail_timeout","failover_criteria","hash_on_header","latency_strategy","max_fails","read_timeout","retries","slots","tokens_count_strategy","vectordb","write_timeout"]}},"additionalProperties":false,"required":["route","logging","model","response_streaming","max_request_body_size"]},"AIGatewayEmbeddingsModelConfig":{"description":"Configuration for an embeddings model.","discriminator":{"propertyName":"type","mapping":{"azure":"#/components/schemas/AIGatewayAzureEmbeddingsModelConfig","bedrock":"#/components/schemas/AIGatewayBedrockEmbeddingsModelConfig","gemini":"#/components/schemas/AIGatewayGeminiEmbeddingsModelConfig","huggingface":"#/components/schemas/AIGatewayHuggingfaceEmbeddingsModelConfig"}},"oneOf":[{"$ref":"#/components/schemas/AIGatewayAzureEmbeddingsModelConfig"},{"$ref":"#/components/schemas/AIGatewayBedrockEmbeddingsModelConfig"},{"$ref":"#/components/schemas/AIGatewayGeminiEmbeddingsModelConfig"},{"$ref":"#/components/schemas/AIGatewayHuggingfaceEmbeddingsModelConfig"}]},"AIGatewayAzureEmbeddingsModelConfig":{"description":"Azure-specific configuration for a model.","type":"object","properties":{"name":{"description":"The name of the embeddings model.","type":"string"},"upstream_url":{"description":"The URL of the embeddings model.","type":"string"},"type":{"type":"string","enum":["azure"]},"deployment_id":{"description":"The Azure deployment ID for the model.","type":"string"},"api_version":{"description":"The Azure OpenAI API version to use.","type":"string","default":"2023-05-15"}},"additionalProperties":false,"required":["name","upstream_url","type"]},"AIGatewayBedrockEmbeddingsModelConfig":{"description":"AWS Bedrock-specific configuration for a model.","type":"object","properties":{"name":{"description":"The name of the embeddings model.","type":"string"},"upstream_url":{"description":"The URL of the embeddings model.","type":"string"},"type":{"type":"string","enum":["bedrock"]},"batch_bucket_prefix":{"description":"S3 bucket prefix for batch inference jobs.","type":"string"},"embeddings_normalize":{"description":"Whether to normalize embedding vectors in the response.","type":"boolean","default":false},"performance_config_latency":{"description":"Latency performance configuration for the model invocation.","type":"string"},"video_output_s3_uri":{"description":"S3 URI for storing video generation outputs.","type":"string"}},"additionalProperties":false,"required":["name","upstream_url","type"]},"AIGatewayGeminiEmbeddingsModelConfig":{"description":"Google Gemini-specific configuration for a model.","type":"object","properties":{"name":{"description":"The name of the embeddings model.","type":"string"},"upstream_url":{"description":"The URL of the embeddings model.","type":"string"},"type":{"type":"string","enum":["gemini"]},"location_id":{"description":"The Google Cloud location ID for the model endpoint.","type":"string"},"api_endpoint":{"description":"The custom API endpoint for the Gemini model.","type":"string"}},"additionalProperties":false,"required":["name","upstream_url","type"]},"AIGatewayHuggingfaceEmbeddingsModelConfig":{"description":"Hugging Face-specific configuration for a model.","type":"object","properties":{"name":{"description":"The name of the embeddings model.","type":"string"},"upstream_url":{"description":"The URL of the embeddings model.","type":"string"},"type":{"type":"string","enum":["huggingface"]},"use_cache":{"description":"Whether to use the Hugging Face inference cache.","type":"boolean","default":false},"wait_for_model":{"description":"Whether to wait for the model to load if it is not ready.","type":"boolean","default":false}},"additionalProperties":false,"required":["name","upstream_url","type"]},"AIGatewayModelVectorDBConfig":{"description":"Configuration for the vector database used by the model.","discriminator":{"propertyName":"strategy","mapping":{"pgvector":"#/components/schemas/AIGatewayModelVectorDBConfigPgVector","redis":"#/components/schemas/AIGatewayModelVectorDBConfigRedis"}},"oneOf":[{"$ref":"#/components/schemas/AIGatewayModelVectorDBConfigPgVector"},{"$ref":"#/components/schemas/AIGatewayModelVectorDBConfigRedis"}]},"AIGatewayModelVectorDBConfigRedis":{"description":"Config for connecting to a Cloud Provider's Redis instance.","type":"object","properties":{"strategy":{"type":"string","enum":["redis"]},"dimensions":{"description":"the desired dimensionality for the vectors","type":"integer"},"distance_metric":{"description":"the distance metric to use for vector searches","type":"string","enum":["cosine","euclidean"]},"threshold":{"description":"the default similarity threshold for accepting semantic search results (float). Higher threshold means more results are considered similar.","type":"number"},"cloud_authentication":{"description":"Auth related config for connecting to a Cloud Provider's Redis instance.","discriminator":{"propertyName":"type","mapping":{"aws":"#/components/schemas/AIGatewayRedisAWSAuthentication","azure":"#/components/schemas/AIGatewayRedisAzureAuthentication","gcp":"#/components/schemas/AIGatewayRedisGCPAuthentication"}},"oneOf":[{"$ref":"#/components/schemas/AIGatewayRedisAWSAuthentication"},{"$ref":"#/components/schemas/AIGatewayRedisAzureAuthentication"},{"$ref":"#/components/schemas/AIGatewayRedisGCPAuthentication"}]},"cluster":{"description":"Cluster configuration for the Redis connection.","type":"object","additionalProperties":false,"properties":{"max_redirections":{"description":"Maximum retry attempts for redirection.","type":"integer","default":5},"nodes":{"description":"Cluster addresses to use for Redis connections when the `redis` strategy is defined. Defining this field implies using a Redis Cluster. The minimum length of the array is 1 element.","type":"array","items":{"type":"object","properties":{"ip":{"description":"A string representing a host name, such as example.com.","type":"string","default":"127.0.0.1"},"port":{"description":"An integer representing a port number between 0 and 65535, inclusive.","type":"integer","default":6379,"maximum":65535,"minimum":0}}},"minItems":1}}},"connect_timeout":{"description":"An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2.","type":"integer","default":2000,"maximum":2147483646,"minimum":0},"connection_is_proxied":{"description":"If the connection to Redis is proxied (e.g. Envoy), set it `true`. Set the `host` and `port` to point to the proxy address.","type":"boolean","default":false},"database":{"description":"Database to use for the Redis connection when using the `redis` strategy","type":"integer","default":0},"host":{"description":"A string representing a host name, such as example.com. \nThis field is [referenceable](/gateway/entities/vault/#how-do-i-reference-secrets-stored-in-a-vault).","type":"string","default":"127.0.0.1","x-referenceable":true},"keepalive":{"description":"Keepalive configuration for the Redis connection.","type":"object","additionalProperties":false,"properties":{"backlog":{"description":"Limits the total number of opened connections for a pool. If the connection pool is full, connection queues above the limit go into the backlog queue. If the backlog queue is full, subsequent connect operations fail and return `nil`. Queued operations (subject to set timeouts) resume once the number of connections in the pool is less than `pool_size`. If latency is high or throughput is low, try increasing this value. Empirically, this value is larger than `pool_size`.","type":"integer","maximum":2147483646,"minimum":0},"pool_size":{"description":"The size limit for every cosocket connection pool associated with every remote server, per worker process. If neither `pool_size` nor `backlog` is specified, no pool is created. If `pool_size` isn't specified but `backlog` is specified, then the pool uses the default value. Try to increase (e.g. 512) this value if latency is high or throughput is low.","type":"integer","default":256,"maximum":2147483646,"minimum":1}}},"password":{"description":"Password to use for Redis connections. If undefined, no AUTH commands are sent to Redis. \nThis field is [referenceable](/gateway/entities/vault/#how-do-i-reference-secrets-stored-in-a-vault). \nThis field is [encrypted](/gateway/keyring/).","type":"string","x-encrypted":true,"x-referenceable":true},"port":{"description":"An integer representing a port number between 0 and 65535, inclusive. \nThis field is [referenceable](/gateway/entities/vault/#how-do-i-reference-secrets-stored-in-a-vault).","type":"integer","default":6379,"maximum":65535,"minimum":0,"x-referenceable":true},"read_timeout":{"description":"An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2.","type":"integer","default":2000,"maximum":2147483646,"minimum":0},"send_timeout":{"description":"An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2.","type":"integer","default":2000,"maximum":2147483646,"minimum":0},"sentinel":{"description":"Configuration for Redis Sentinel.","type":"object","additionalProperties":false,"properties":{"master":{"description":"Sentinel master to use for Redis connections. Defining this value implies using Redis Sentinel.","type":"string"},"nodes":{"description":"Sentinel node addresses to use for Redis connections when the `redis` strategy is defined. Defining this field implies using a Redis Sentinel. The minimum length of the array is 1 element.","type":"array","items":{"type":"object","properties":{"host":{"description":"A string representing a host name, such as example.com.","type":"string","default":"127.0.0.1"},"port":{"description":"An integer representing a port number between 0 and 65535, inclusive.","type":"integer","default":6379,"maximum":65535,"minimum":0}}},"minItems":1},"password":{"description":"Sentinel password to authenticate with a Redis Sentinel instance. If undefined, no AUTH commands are sent to Redis Sentinels. \nThis field is [referenceable](/gateway/entities/vault/#how-do-i-reference-secrets-stored-in-a-vault). \nThis field is [encrypted](/gateway/keyring/).","type":"string","x-encrypted":true,"x-referenceable":true},"role":{"description":"Sentinel role to use for Redis connections when the `redis` strategy is defined. Defining this value implies using Redis Sentinel.","type":"string","enum":["any","master","slave"]},"username":{"description":"Sentinel username to authenticate with a Redis Sentinel instance. If undefined, ACL authentication won't be performed. This requires Redis v6.2.0+. \nThis field is [referenceable](/gateway/entities/vault/#how-do-i-reference-secrets-stored-in-a-vault).","type":"string","x-referenceable":true}}},"server_name":{"description":"A string representing an SNI (server name indication) value for TLS. \nThis field is [referenceable](/gateway/entities/vault/#how-do-i-reference-secrets-stored-in-a-vault).","type":"string","x-referenceable":true},"ssl":{"description":"If set to true, uses SSL to connect to Redis.","type":"boolean","default":false},"ssl_verify":{"description":"If set to true, verifies the validity of the server SSL certificate. If setting this parameter, also configure `lua_ssl_trusted_certificate` in `kong.conf` to specify the CA (or server) certificate used by your Redis server. You may also need to configure `lua_ssl_verify_depth` accordingly.","type":"boolean","default":true},"username":{"description":"Username to use for Redis connections. If undefined, ACL authentication won't be performed. This requires Redis v6.0.0+. To be compatible with Redis v5.x.y, you can set it to `default`. \nThis field is [referenceable](/gateway/entities/vault/#how-do-i-reference-secrets-stored-in-a-vault).","type":"string","x-referenceable":true}},"additionalProperties":false,"required":["strategy","dimensions","distance_metric"]},"AIGatewayModelVectorDBConfigPgVector":{"type":"object","properties":{"strategy":{"type":"string","enum":["pgvector"]},"dimensions":{"description":"the desired dimensionality for the vectors","type":"integer"},"distance_metric":{"description":"the distance metric to use for vector searches","type":"string","enum":["cosine","euclidean"]},"threshold":{"description":"the default similarity threshold for accepting semantic search results (float). Higher threshold means more results are considered similar.","type":"number"},"database":{"description":"the database of the pgvector database","type":"string","default":"kong-pgvector"},"host":{"description":"the host of the pgvector database","type":"string","default":"127.0.0.1"},"password":{"description":"the password of the pgvector database \nThis field is [referenceable](/gateway/entities/vault/#how-do-i-reference-secrets-stored-in-a-vault). \nThis field is [encrypted](/gateway/keyring/).","type":"string","writeOnly":true,"x-encrypted":true,"x-referenceable":true},"port":{"description":"the port of the pgvector database","type":"integer","default":5432},"ssl":{"type":"object","additionalProperties":false,"properties":{"enabled":{"description":"whether to use ssl for the pgvector database","type":"boolean","default":false},"cert":{"description":"the path of ssl cert to use for the pgvector database","type":"string"},"cert_key":{"description":"the path of ssl cert key to use for the pgvector database","type":"string"},"required":{"description":"whether ssl is required for the pgvector database","type":"boolean","default":false},"verify":{"description":"whether to verify ssl for the pgvector database","type":"boolean","default":true},"version":{"description":"the ssl version to use for the pgvector database","type":"string","default":"tlsv1_2","enum":["any","tlsv1_2","tlsv1_3"]}}},"timeout":{"description":"the timeout of the pgvector database","type":"number","default":5000},"user":{"description":"the user of the pgvector database \nThis field is [referenceable](/gateway/entities/vault/#how-do-i-reference-secrets-stored-in-a-vault).","type":"string","default":"postgres","x-referenceable":true}},"additionalProperties":false,"required":["strategy","dimensions","distance_metric"]},"AIGatewayModelFormat":{"description":"Request and response format supported by this model.","type":"object","properties":{"type":{"description":"The format type.","type":"string","example":"openai"}},"additionalProperties":false},"AIGatewayTargetModel":{"description":"A target model instance that this model entry routes requests to.","type":"object","properties":{"name":{"description":"The name of the model defined in the upstream provider that will be executed.","type":"string","example":"gpt-5-model"},"provider":{"$ref":"#/components/schemas/AIGatewayProviderReference"},"config":{"$ref":"#/components/schemas/AIGatewayTargetModelConfig"}},"additionalProperties":false,"required":["name","provider"]},"AIGatewayTargetModelConfig":{"description":"Configuration for a target model.","discriminator":{"propertyName":"type","mapping":{"anthropic":"#/components/schemas/AIGatewayTargetModelAnthropicConfig","azure":"#/components/schemas/AIGatewayTargetModelAzureConfig","bedrock":"#/components/schemas/AIGatewayTargetModelBedrockConfig","cohere":"#/components/schemas/AIGatewayTargetModelCohereConfig","dashscope":"#/components/schemas/AIGatewayTargetModelDashscopeConfig","databricks":"#/components/schemas/AIGatewayTargetModelDatabricksConfig","gemini":"#/components/schemas/AIGatewayTargetModelGeminiConfig","huggingface":"#/components/schemas/AIGatewayTargetModelHuggingfaceConfig","llama2":"#/components/schemas/AIGatewayTargetModelLlama2Config","mistral":"#/components/schemas/AIGatewayTargetModelMistralConfig"}},"oneOf":[{"$ref":"#/components/schemas/AIGatewayTargetModelAnthropicConfig"},{"$ref":"#/components/schemas/AIGatewayTargetModelAzureConfig"},{"$ref":"#/components/schemas/AIGatewayTargetModelBedrockConfig"},{"$ref":"#/components/schemas/AIGatewayTargetModelCohereConfig"},{"$ref":"#/components/schemas/AIGatewayTargetModelDashscopeConfig"},{"$ref":"#/components/schemas/AIGatewayTargetModelDatabricksConfig"},{"$ref":"#/components/schemas/AIGatewayTargetModelGeminiConfig"},{"$ref":"#/components/schemas/AIGatewayTargetModelHuggingfaceConfig"},{"$ref":"#/components/schemas/AIGatewayTargetModelLlama2Config"},{"$ref":"#/components/schemas/AIGatewayTargetModelMistralConfig"}]},"AIGatewayTargetModelAnthropicConfig":{"description":"Anthropic-specific configuration for a model.","type":"object","properties":{"embeddings_dimensions":{"description":"The number of dimensions for embedding outputs.","type":"integer"},"max_tokens":{"description":"The maximum number of tokens to generate in the response.","type":"integer"},"input_cost":{"description":"Cost per input token for billing and cost tracking.","type":"number"},"output_cost":{"description":"Cost per output token for billing and cost tracking.","type":"number"},"temperature":{"description":"Controls randomness in the model output. Higher values produce more varied responses.","type":"number"},"top_k":{"description":"Limits the number of highest-probability tokens considered during generation.","type":"integer"},"top_p":{"description":"Nucleus sampling probability mass. Tokens with cumulative probability up to top_p are considered.","type":"number"},"upstream_url":{"description":"The upstream URL for the model endpoint.","type":"string","format":"uri"},"type":{"type":"string","enum":["anthropic"]},"version":{"description":"The Anthropic API version to use.","type":"string"}},"additionalProperties":false,"required":["type"]},"AIGatewayTargetModelAzureConfig":{"description":"Azure-specific configuration for a model.","type":"object","properties":{"embeddings_dimensions":{"description":"The number of dimensions for embedding outputs.","type":"integer"},"max_tokens":{"description":"The maximum number of tokens to generate in the response.","type":"integer"},"input_cost":{"description":"Cost per input token for billing and cost tracking.","type":"number"},"output_cost":{"description":"Cost per output token for billing and cost tracking.","type":"number"},"temperature":{"description":"Controls randomness in the model output. Higher values produce more varied responses.","type":"number"},"top_k":{"description":"Limits the number of highest-probability tokens considered during generation.","type":"integer"},"top_p":{"description":"Nucleus sampling probability mass. Tokens with cumulative probability up to top_p are considered.","type":"number"},"upstream_url":{"description":"The upstream URL for the model endpoint.","type":"string","format":"uri"},"type":{"type":"string","enum":["azure"]},"deployment_id":{"description":"The Azure deployment ID for the model.","type":"string"},"api_version":{"description":"The Azure OpenAI API version to use.","type":"string","default":"2023-05-15"}},"additionalProperties":false,"required":["type"]},"AIGatewayTargetModelBedrockConfig":{"description":"AWS Bedrock-specific configuration for a model.","type":"object","properties":{"embeddings_dimensions":{"description":"The number of dimensions for embedding outputs.","type":"integer"},"max_tokens":{"description":"The maximum number of tokens to generate in the response.","type":"integer"},"input_cost":{"description":"Cost per input token for billing and cost tracking.","type":"number"},"output_cost":{"description":"Cost per output token for billing and cost tracking.","type":"number"},"temperature":{"description":"Controls randomness in the model output. Higher values produce more varied responses.","type":"number"},"top_k":{"description":"Limits the number of highest-probability tokens considered during generation.","type":"integer"},"top_p":{"description":"Nucleus sampling probability mass. Tokens with cumulative probability up to top_p are considered.","type":"number"},"upstream_url":{"description":"The upstream URL for the model endpoint.","type":"string","format":"uri"},"type":{"type":"string","enum":["bedrock"]},"batch_bucket_prefix":{"description":"S3 bucket prefix for batch inference jobs.","type":"string"},"embeddings_normalize":{"description":"Whether to normalize embedding vectors in the response.","type":"boolean","default":false},"performance_config_latency":{"description":"Latency performance configuration for the model invocation.","type":"string"},"video_output_s3_uri":{"description":"S3 URI for storing video generation outputs.","type":"string"}},"additionalProperties":false,"required":["type"]},"AIGatewayTargetModelCohereConfig":{"description":"Cohere-specific configuration for a model.","type":"object","properties":{"embeddings_dimensions":{"description":"The number of dimensions for embedding outputs.","type":"integer"},"max_tokens":{"description":"The maximum number of tokens to generate in the response.","type":"integer"},"input_cost":{"description":"Cost per input token for billing and cost tracking.","type":"number"},"output_cost":{"description":"Cost per output token for billing and cost tracking.","type":"number"},"temperature":{"description":"Controls randomness in the model output. Higher values produce more varied responses.","type":"number"},"top_k":{"description":"Limits the number of highest-probability tokens considered during generation.","type":"integer"},"top_p":{"description":"Nucleus sampling probability mass. Tokens with cumulative probability up to top_p are considered.","type":"number"},"upstream_url":{"description":"The upstream URL for the model endpoint.","type":"string","format":"uri"},"type":{"type":"string","enum":["cohere"]},"embedding_input_type":{"description":"The intended downstream use of the embeddings to improve model quality.","type":"string","default":"classification","enum":["classification","clustering","image","search_document","search_query"]},"wait_for_model":{"description":"Whether to wait for the model to be ready before sending the request.","type":"boolean","default":false}},"additionalProperties":false,"required":["type"]},"AIGatewayTargetModelDashscopeConfig":{"description":"Alibaba DashScope-specific configuration for a model.","type":"object","properties":{"embeddings_dimensions":{"description":"The number of dimensions for embedding outputs.","type":"integer"},"max_tokens":{"description":"The maximum number of tokens to generate in the response.","type":"integer"},"input_cost":{"description":"Cost per input token for billing and cost tracking.","type":"number"},"output_cost":{"description":"Cost per output token for billing and cost tracking.","type":"number"},"temperature":{"description":"Controls randomness in the model output. Higher values produce more varied responses.","type":"number"},"top_k":{"description":"Limits the number of highest-probability tokens considered during generation.","type":"integer"},"top_p":{"description":"Nucleus sampling probability mass. Tokens with cumulative probability up to top_p are considered.","type":"number"},"upstream_url":{"description":"The upstream URL for the model endpoint.","type":"string","format":"uri"},"type":{"type":"string","enum":["dashscope"]},"international":{"description":"Whether to use the international DashScope endpoint.","type":"boolean","default":true}},"additionalProperties":false,"required":["type"]},"AIGatewayTargetModelDatabricksConfig":{"description":"Databricks-specific configuration for a model.","type":"object","properties":{"embeddings_dimensions":{"description":"The number of dimensions for embedding outputs.","type":"integer"},"max_tokens":{"description":"The maximum number of tokens to generate in the response.","type":"integer"},"input_cost":{"description":"Cost per input token for billing and cost tracking.","type":"number"},"output_cost":{"description":"Cost per output token for billing and cost tracking.","type":"number"},"temperature":{"description":"Controls randomness in the model output. Higher values produce more varied responses.","type":"number"},"top_k":{"description":"Limits the number of highest-probability tokens considered during generation.","type":"integer"},"top_p":{"description":"Nucleus sampling probability mass. Tokens with cumulative probability up to top_p are considered.","type":"number"},"upstream_url":{"description":"The upstream URL for the model endpoint.","type":"string","format":"uri"},"type":{"type":"string","enum":["databricks"]},"workspace_instance_id":{"description":"The Databricks workspace instance ID.","type":"string"}},"additionalProperties":false,"required":["type"]},"AIGatewayTargetModelGeminiConfig":{"description":"Google Gemini-specific configuration for a model.","type":"object","properties":{"embeddings_dimensions":{"description":"The number of dimensions for embedding outputs.","type":"integer"},"max_tokens":{"description":"The maximum number of tokens to generate in the response.","type":"integer"},"input_cost":{"description":"Cost per input token for billing and cost tracking.","type":"number"},"output_cost":{"description":"Cost per output token for billing and cost tracking.","type":"number"},"temperature":{"description":"Controls randomness in the model output. Higher values produce more varied responses.","type":"number"},"top_k":{"description":"Limits the number of highest-probability tokens considered during generation.","type":"integer"},"top_p":{"description":"Nucleus sampling probability mass. Tokens with cumulative probability up to top_p are considered.","type":"number"},"upstream_url":{"description":"The upstream URL for the model endpoint.","type":"string","format":"uri"},"type":{"type":"string","enum":["gemini"]},"location_id":{"description":"The Google Cloud location ID for the model endpoint.","type":"string"},"api_endpoint":{"description":"The custom API endpoint for the Gemini model.","type":"string"}},"additionalProperties":false,"required":["type"]},"AIGatewayTargetModelHuggingfaceConfig":{"description":"Hugging Face-specific configuration for a model.","type":"object","properties":{"embeddings_dimensions":{"description":"The number of dimensions for embedding outputs.","type":"integer"},"max_tokens":{"description":"The maximum number of tokens to generate in the response.","type":"integer"},"input_cost":{"description":"Cost per input token for billing and cost tracking.","type":"number"},"output_cost":{"description":"Cost per output token for billing and cost tracking.","type":"number"},"temperature":{"description":"Controls randomness in the model output. Higher values produce more varied responses.","type":"number"},"top_k":{"description":"Limits the number of highest-probability tokens considered during generation.","type":"integer"},"top_p":{"description":"Nucleus sampling probability mass. Tokens with cumulative probability up to top_p are considered.","type":"number"},"upstream_url":{"description":"The upstream URL for the model endpoint.","type":"string","format":"uri"},"type":{"type":"string","enum":["huggingface"]},"use_cache":{"description":"Whether to use the Hugging Face inference cache.","type":"boolean","default":false},"wait_for_model":{"description":"Whether to wait for the model to load if it is not ready.","type":"boolean","default":false}},"additionalProperties":false,"required":["type"]},"AIGatewayTargetModelLlama2Config":{"description":"Llama2-specific configuration for a model.","type":"object","properties":{"embeddings_dimensions":{"description":"The number of dimensions for embedding outputs.","type":"integer"},"max_tokens":{"description":"The maximum number of tokens to generate in the response.","type":"integer"},"input_cost":{"description":"Cost per input token for billing and cost tracking.","type":"number"},"output_cost":{"description":"Cost per output token for billing and cost tracking.","type":"number"},"temperature":{"description":"Controls randomness in the model output. Higher values produce more varied responses.","type":"number"},"top_k":{"description":"Limits the number of highest-probability tokens considered during generation.","type":"integer"},"top_p":{"description":"Nucleus sampling probability mass. Tokens with cumulative probability up to top_p are considered.","type":"number"},"upstream_url":{"description":"The upstream URL for the model endpoint.","type":"string","format":"uri"},"type":{"type":"string","enum":["llama2"]},"format":{"description":"The request format to use when communicating with the Llama2 model.","type":"string","enum":["ollama","openai","raw"]}},"additionalProperties":false,"required":["type"]},"AIGatewayTargetModelMistralConfig":{"description":"Mistral-specific configuration for a model.","type":"object","properties":{"embeddings_dimensions":{"description":"The number of dimensions for embedding outputs.","type":"integer"},"max_tokens":{"description":"The maximum number of tokens to generate in the response.","type":"integer"},"input_cost":{"description":"Cost per input token for billing and cost tracking.","type":"number"},"output_cost":{"description":"Cost per output token for billing and cost tracking.","type":"number"},"temperature":{"description":"Controls randomness in the model output. Higher values produce more varied responses.","type":"number"},"top_k":{"description":"Limits the number of highest-probability tokens considered during generation.","type":"integer"},"top_p":{"description":"Nucleus sampling probability mass. Tokens with cumulative probability up to top_p are considered.","type":"number"},"upstream_url":{"description":"The upstream URL for the model endpoint.","type":"string","format":"uri"},"type":{"type":"string","enum":["mistral"]},"format":{"description":"The request format to use when communicating with the Mistral model.","type":"string","enum":["ollama","openai"]}},"additionalProperties":false,"required":["type"]},"AIGatewayManagedBy":{"description":"Indicates the managing entities for a resource. A maximum of 5 keys is allowed.\n\nKeys must be 63 characters or less, starting and ending with an alphanumeric character,\nand may include dashes (-), underscores (_), and dots (.).\n\nValues must be non-empty strings of 127 characters or less.\n\nKeys and values must not contain spaces or control characters, and are case-insensitive.\n","type":"object","example":{"team":"platform","owner":"kong"},"additionalProperties":{"type":"string","minLength":1,"maxLength":127},"maxProperties":5,"nullable":true},"AIGatewayACLS":{"type":"object","properties":{"allow":{"description":"List of consumer group names permitted access.","type":"array","items":{"type":"string"}},"deny":{"description":"List of consumer group names denied access.","type":"array","items":{"type":"string"}}},"additionalProperties":false,"required":["allow","deny"]},"AIGatewayPolicyReference":{"description":"Lightweight object used to reference a policy instance, identified by its `ref`.","type":"object","properties":{"ref":{"description":"The user-defined unique identifier for a policy instance.","type":"string","example":"ai-pii-sanitizer-1234"}},"additionalProperties":false,"required":["ref"]},"CreateAIGatewayPolicyRequest":{"type":"object","properties":{"display_name":{"description":"The display name for this policy instance.","type":"string","example":"My Cool AI PII Sanitizer Policy"},"ref":{"description":"A user-defined unique identifier for this policy instance, used as a stable human-readable reference.","type":"string","example":"ai-pii-sanitizer-1234"},"type":{"description":"The type of the policy. Some examples are: 'ai-sanitizer', 'ai-prompt-guard',\nand 'openid-connect'.\n","type":"string","example":"ai-sanitizer"},"enabled":{"description":"Whether the policy is enabled.","type":"boolean","example":true},"config":{"description":"Configuration for the policy. The structure varies depending on the policy type.","type":"object","example":{"anonymize":["phone","creditcard"],"stop_on_error":true},"additionalProperties":true},"labels":{"$ref":"#/components/schemas/PublicLabels"},"managed_by":{"$ref":"#/components/schemas/AIGatewayManagedBy"}},"additionalProperties":false,"required":["display_name","ref","type","enabled","config"]},"UpdateAIGatewayPolicyRequest":{"type":"object","properties":{"display_name":{"description":"The display name for this policy instance.","type":"string","example":"My Cool AI PII Sanitizer Policy"},"ref":{"description":"A user-defined unique identifier for this policy instance, used as a stable human-readable reference.","type":"string","example":"ai-pii-sanitizer-1234"},"type":{"description":"The type of the policy. Some examples are: 'ai-sanitizer', 'ai-prompt-guard',\nand 'openid-connect'.\n","type":"string","example":"ai-sanitizer"},"enabled":{"description":"Whether the policy is enabled.","type":"boolean","example":true},"config":{"description":"Configuration for the policy. The structure varies depending on the policy type.","type":"object","example":{"anonymize":["phone","creditcard"],"stop_on_error":true},"additionalProperties":true},"labels":{"$ref":"#/components/schemas/PublicLabels"},"managed_by":{"$ref":"#/components/schemas/AIGatewayManagedBy"}},"additionalProperties":false,"required":["display_name","ref","type","enabled","config"]},"AIGatewayPolicy":{"type":"object","properties":{"display_name":{"description":"The display name for this policy instance.","type":"string","example":"My Cool AI PII Sanitizer Policy"},"ref":{"description":"A user-defined unique identifier for this policy instance, used as a stable human-readable reference.","type":"string","example":"ai-pii-sanitizer-1234"},"type":{"description":"The type of the policy. Some examples are: 'ai-sanitizer', 'ai-prompt-guard',\nand 'openid-connect'.\n","type":"string","example":"ai-sanitizer"},"enabled":{"description":"Whether the policy is enabled.","type":"boolean","example":true},"config":{"description":"Configuration for the policy. The structure varies depending on the policy type.","type":"object","example":{"anonymize":["phone","creditcard"],"stop_on_error":true},"additionalProperties":true},"labels":{"$ref":"#/components/schemas/PublicLabels"},"managed_by":{"$ref":"#/components/schemas/AIGatewayManagedBy"},"id":{"$ref":"#/components/schemas/UUID"},"created_at":{"$ref":"#/components/schemas/CreatedAt"},"updated_at":{"$ref":"#/components/schemas/UpdatedAt"}},"additionalProperties":false,"required":["display_name","ref","type","enabled","config","id","created_at","updated_at"]},"CreateAIGatewayAgentRequest":{"type":"object","properties":{"display_name":{"description":"The display name for this agent.","type":"string","example":"Kong Air Flight Booking Agent"},"ref":{"description":"A user-defined unique identifier for this agent, used as a stable human-readable reference.","type":"string","example":"kongair-flight-booking-agent"},"type":{"description":"The type of the agent.","type":"string","example":"a2a","enum":["a2a","http"]},"policies":{"type":"array","items":{"$ref":"#/components/schemas/AIGatewayPolicyReference"}},"acls":{"description":"Access control rules for allowing or denying consumer groups access to this agent.","allOf":[{"$ref":"#/components/schemas/AIGatewayACLS"}]},"config":{"description":"Configuration for the agent. The structure varies depending on the agent type.","type":"object","additionalProperties":false,"properties":{"url":{"description":"Helper field to set protocol, host, port and path of the upstream A2A Agent using a URL.\nThis is the same as a Kong Gateway Service URL: ${scheme}://${host}:${port}/${path}\n","type":"string","format":"uri","example":"https://booking-agent.internal.kongair.com"},"route":{"$ref":"#/components/schemas/AIGatewayRouteConfig"},"logging":{"$ref":"#/components/schemas/AIGatewayLoggingConfig"},"max_payload_size":{"description":"Max payload size in bytes.","type":"integer","example":524288}}},"labels":{"$ref":"#/components/schemas/PublicLabels"},"managed_by":{"$ref":"#/components/schemas/AIGatewayManagedBy"}},"additionalProperties":true,"required":["display_name","ref","type","policies","acls","config"]},"UpdateAIGatewayAgentRequest":{"type":"object","properties":{"display_name":{"description":"The display name for this agent.","type":"string","example":"Kong Air Flight Booking Agent"},"ref":{"description":"A user-defined unique identifier for this agent, used as a stable human-readable reference.","type":"string","example":"kongair-flight-booking-agent"},"type":{"description":"The type of the agent.","type":"string","example":"a2a","enum":["a2a","http"]},"policies":{"type":"array","items":{"$ref":"#/components/schemas/AIGatewayPolicyReference"}},"acls":{"description":"Access control rules for allowing or denying consumer groups access to this agent.","allOf":[{"$ref":"#/components/schemas/AIGatewayACLS"}]},"config":{"description":"Configuration for the agent. The structure varies depending on the agent type.","type":"object","additionalProperties":false,"properties":{"url":{"description":"Helper field to set protocol, host, port and path of the upstream A2A Agent using a URL.\nThis is the same as a Kong Gateway Service URL: ${scheme}://${host}:${port}/${path}\n","type":"string","format":"uri","example":"https://booking-agent.internal.kongair.com"},"route":{"$ref":"#/components/schemas/AIGatewayRouteConfig"},"logging":{"$ref":"#/components/schemas/AIGatewayLoggingConfig"},"max_payload_size":{"description":"Max payload size in bytes.","type":"integer","example":524288}}},"labels":{"$ref":"#/components/schemas/PublicLabels"},"managed_by":{"$ref":"#/components/schemas/AIGatewayManagedBy"}},"additionalProperties":true,"required":["display_name","ref","type","policies","acls","config"]},"AIGatewayAgent":{"type":"object","properties":{"display_name":{"description":"The display name for this agent.","type":"string","example":"Kong Air Flight Booking Agent"},"ref":{"description":"A user-defined unique identifier for this agent, used as a stable human-readable reference.","type":"string","example":"kongair-flight-booking-agent"},"type":{"description":"The type of the agent.","type":"string","example":"a2a","enum":["a2a","http"]},"policies":{"type":"array","items":{"$ref":"#/components/schemas/AIGatewayPolicyReference"}},"acls":{"description":"Access control rules for allowing or denying consumer groups access to this agent.","allOf":[{"$ref":"#/components/schemas/AIGatewayACLS"}]},"config":{"description":"Configuration for the agent. The structure varies depending on the agent type.","type":"object","additionalProperties":false,"properties":{"url":{"description":"Helper field to set protocol, host, port and path of the upstream A2A Agent using a URL.\nThis is the same as a Kong Gateway Service URL: ${scheme}://${host}:${port}/${path}\n","type":"string","format":"uri","example":"https://booking-agent.internal.kongair.com"},"route":{"$ref":"#/components/schemas/AIGatewayRouteConfig"},"logging":{"$ref":"#/components/schemas/AIGatewayLoggingConfig"},"max_payload_size":{"description":"Max payload size in bytes.","type":"integer","example":524288}}},"labels":{"$ref":"#/components/schemas/PublicLabels"},"managed_by":{"$ref":"#/components/schemas/AIGatewayManagedBy"},"id":{"$ref":"#/components/schemas/UUID"},"created_at":{"$ref":"#/components/schemas/CreatedAt"},"updated_at":{"$ref":"#/components/schemas/UpdatedAt"}},"additionalProperties":true,"required":["display_name","ref","type","policies","acls","config","id","created_at","updated_at"]},"CreateAIGatewayConsumerRequest":{"type":"object","properties":{"display_name":{"description":"The display name for this consumer instance.","type":"string","example":"Greg's Dev Key"},"ref":{"description":"A user-defined unique identifier for this consumer, used as a stable human-readable reference.","type":"string","example":"gregs-dev-key"},"type":{"description":"The type of the consumer.","type":"string","enum":["apikey","oauth"]},"consumer_groups":{"description":"List of AI Consumer Groups this consumer belongs to.","type":"array","items":{"$ref":"#/components/schemas/AIGatewayConsumerGroupReference"}},"policies":{"type":"array","items":{"$ref":"#/components/schemas/AIGatewayPolicyReference"}},"config":{"description":"Configuration for the consumer.","type":"object","additionalProperties":false,"properties":{"custom_id":{"description":"External mapping ID (e.g., OIDC Client ID).","type":"string","example":"0oatibf4t2PlDxqgR1d7","nullable":true},"credentials":{"description":"List of credentials for this consumer.","type":"array","items":{"type":"object","additionalProperties":false,"description":"Sensitive credential data (e.g., API key value).","required":["api_key"],"properties":{"api_key":{"type":"string","example":"sk-387788hd3xnej"},"ttl":{"description":"The API Key's time-to-live in seconds.","type":"integer","example":86400}}}}}},"labels":{"$ref":"#/components/schemas/PublicLabels"},"managed_by":{"$ref":"#/components/schemas/AIGatewayManagedBy"}},"additionalProperties":true,"required":["display_name","ref","type","config","consumer_groups","policies"]},"UpdateAIGatewayConsumerRequest":{"type":"object","properties":{"display_name":{"description":"The display name for this consumer instance.","type":"string","example":"Greg's Dev Key"},"ref":{"description":"A user-defined unique identifier for this consumer, used as a stable human-readable reference.","type":"string","example":"gregs-dev-key"},"type":{"description":"The type of the consumer.","type":"string","enum":["apikey","oauth"]},"consumer_groups":{"description":"List of AI Consumer Groups this consumer belongs to.","type":"array","items":{"$ref":"#/components/schemas/AIGatewayConsumerGroupReference"}},"policies":{"type":"array","items":{"$ref":"#/components/schemas/AIGatewayPolicyReference"}},"config":{"description":"Configuration for the consumer.","type":"object","additionalProperties":false,"properties":{"custom_id":{"description":"External mapping ID (e.g., OIDC Client ID).","type":"string","example":"0oatibf4t2PlDxqgR1d7","nullable":true},"credentials":{"description":"List of credentials for this consumer.","type":"array","items":{"type":"object","additionalProperties":false,"description":"Sensitive credential data (e.g., API key value).","required":["api_key"],"properties":{"api_key":{"type":"string","example":"sk-387788hd3xnej"},"ttl":{"description":"The API Key's time-to-live in seconds.","type":"integer","example":86400}}}}}},"labels":{"$ref":"#/components/schemas/PublicLabels"},"managed_by":{"$ref":"#/components/schemas/AIGatewayManagedBy"}},"additionalProperties":true,"required":["display_name","ref","type","config","consumer_groups","policies"]},"AIGatewayConsumer":{"type":"object","properties":{"display_name":{"description":"The display name for this consumer instance.","type":"string","example":"Greg's Dev Key"},"ref":{"description":"A user-defined unique identifier for this consumer, used as a stable human-readable reference.","type":"string","example":"gregs-dev-key"},"type":{"description":"The type of the consumer.","type":"string","enum":["apikey","oauth"]},"consumer_groups":{"description":"List of AI Consumer Groups this consumer belongs to.","type":"array","items":{"$ref":"#/components/schemas/AIGatewayConsumerGroupReference"}},"policies":{"type":"array","items":{"$ref":"#/components/schemas/AIGatewayPolicyReference"}},"config":{"description":"Configuration for the consumer.","type":"object","additionalProperties":false,"properties":{"custom_id":{"description":"External mapping ID (e.g., OIDC Client ID).","type":"string","example":"0oatibf4t2PlDxqgR1d7","nullable":true},"credentials":{"description":"List of credentials for this consumer.","type":"array","items":{"type":"object","additionalProperties":false,"description":"Sensitive credential data (e.g., API key value).","required":["api_key"],"properties":{"api_key":{"type":"string","example":"sk-387788hd3xnej"},"ttl":{"description":"The API Key's time-to-live in seconds.","type":"integer","example":86400}}}}}},"labels":{"$ref":"#/components/schemas/PublicLabels"},"managed_by":{"$ref":"#/components/schemas/AIGatewayManagedBy"},"id":{"$ref":"#/components/schemas/UUID"},"created_at":{"$ref":"#/components/schemas/CreatedAt"},"updated_at":{"$ref":"#/components/schemas/UpdatedAt"}},"additionalProperties":true,"required":["display_name","ref","type","config","consumer_groups","policies","id","created_at","updated_at"]},"CreateAIGatewayConsumerGroupRequest":{"type":"object","properties":{"display_name":{"description":"The display name for this consumer group instance.","type":"string","example":"Dev Users Group"},"ref":{"description":"A user-defined unique identifier for this consumer group, used as a stable human-readable reference.","type":"string","example":"dev-users"},"policies":{"type":"array","items":{"$ref":"#/components/schemas/AIGatewayPolicyReference"}},"labels":{"$ref":"#/components/schemas/PublicLabels"},"managed_by":{"$ref":"#/components/schemas/AIGatewayManagedBy"}},"additionalProperties":true,"required":["display_name","ref","policies"]},"UpdateAIGatewayConsumerGroupRequest":{"type":"object","properties":{"display_name":{"description":"The display name for this consumer group instance.","type":"string","example":"Dev Users Group"},"ref":{"description":"A user-defined unique identifier for this consumer group, used as a stable human-readable reference.","type":"string","example":"dev-users"},"policies":{"type":"array","items":{"$ref":"#/components/schemas/AIGatewayPolicyReference"}},"labels":{"$ref":"#/components/schemas/PublicLabels"},"managed_by":{"$ref":"#/components/schemas/AIGatewayManagedBy"}},"additionalProperties":true,"required":["display_name","ref","policies"]},"AIGatewayConsumerGroupReference":{"description":"Lightweight object used to reference a consumer group, identified by its `ref`.","type":"object","properties":{"ref":{"description":"The user-defined unique identifier for a consumer group.","type":"string","example":"dev-users"}},"additionalProperties":false,"required":["ref"]},"AIGatewayConsumerGroup":{"type":"object","properties":{"display_name":{"description":"The display name for this consumer group instance.","type":"string","example":"Dev Users Group"},"ref":{"description":"A user-defined unique identifier for this consumer group, used as a stable human-readable reference.","type":"string","example":"dev-users"},"policies":{"type":"array","items":{"$ref":"#/components/schemas/AIGatewayPolicyReference"}},"labels":{"$ref":"#/components/schemas/PublicLabels"},"managed_by":{"$ref":"#/components/schemas/AIGatewayManagedBy"},"id":{"$ref":"#/components/schemas/UUID"},"created_at":{"$ref":"#/components/schemas/CreatedAt"},"updated_at":{"$ref":"#/components/schemas/UpdatedAt"}},"additionalProperties":true,"required":["display_name","ref","policies","id","created_at","updated_at"]},"AIGatewayMCPServerConversionOnly":{"type":"object","properties":{"type":{"type":"string","enum":["conversion-only"]},"display_name":{"description":"The display name for the MCP Server.","type":"string","example":"Kong Air Flights"},"ref":{"description":"A user-defined unique identifier for this MCP server, used as a stable human-readable reference.","type":"string","example":"kongair-flights"},"config":{"$ref":"#/components/schemas/AIGatewayMCPServerConfig"},"tools":{"description":"List of tools exposed by this MCP Server.","type":"array","items":{"$ref":"#/components/schemas/AIGatewayMCPTool"}},"policies":{"type":"array","items":{"$ref":"#/components/schemas/AIGatewayPolicyReference"}},"labels":{"$ref":"#/components/schemas/PublicLabels"},"managed_by":{"$ref":"#/components/schemas/AIGatewayManagedBy"}},"additionalProperties":true,"required":["type","display_name","ref","config","tools","policies"]},"AIGatewayMCPServerConversionListener":{"type":"object","properties":{"type":{"type":"string","enum":["conversion-listener"]},"display_name":{"description":"The display name for the MCP Server.","type":"string","example":"Kong Air Flights"},"ref":{"description":"A user-defined unique identifier for this MCP server, used as a stable human-readable reference.","type":"string","example":"kongair-flights"},"config":{"$ref":"#/components/schemas/AIGatewayMCPServerConfig"},"tools":{"description":"List of tools exposed by this MCP Server.","type":"array","items":{"$ref":"#/components/schemas/AIGatewayMCPTool"}},"policies":{"type":"array","items":{"$ref":"#/components/schemas/AIGatewayPolicyReference"}},"labels":{"$ref":"#/components/schemas/PublicLabels"},"managed_by":{"$ref":"#/components/schemas/AIGatewayManagedBy"}},"additionalProperties":true,"discriminator":{"propertyName":"acl_attribute_type","mapping":{"consumer":"#/components/schemas/AIGatewayMCPServerBaseACLPropertiesConsumer","oauth_access_token":"#/components/schemas/AIGatewayMCPServerBaseACLPropertiesOauth"}},"oneOf":[{"$ref":"#/components/schemas/AIGatewayMCPServerBaseACLPropertiesConsumer"},{"$ref":"#/components/schemas/AIGatewayMCPServerBaseACLPropertiesOauth"}],"required":["type","display_name","ref","config","tools","policies"]},"AIGatewayMCPServerListener":{"type":"object","properties":{"type":{"type":"string","enum":["listener"]},"display_name":{"description":"The display name for the MCP Server.","type":"string","example":"Kong Air Flights"},"ref":{"description":"A user-defined unique identifier for this MCP server, used as a stable human-readable reference.","type":"string","example":"kongair-flights"},"config":{"$ref":"#/components/schemas/AIGatewayMCPServerConfig"},"tools":{"description":"List of tools exposed by this MCP Server.","type":"array","items":{"$ref":"#/components/schemas/AIGatewayMCPTool"}},"policies":{"type":"array","items":{"$ref":"#/components/schemas/AIGatewayPolicyReference"}},"labels":{"$ref":"#/components/schemas/PublicLabels"},"managed_by":{"$ref":"#/components/schemas/AIGatewayManagedBy"}},"additionalProperties":true,"discriminator":{"propertyName":"acl_attribute_type","mapping":{"consumer":"#/components/schemas/AIGatewayMCPServerBaseACLPropertiesConsumer","oauth_access_token":"#/components/schemas/AIGatewayMCPServerBaseACLPropertiesOauth"}},"oneOf":[{"$ref":"#/components/schemas/AIGatewayMCPServerBaseACLPropertiesConsumer"},{"$ref":"#/components/schemas/AIGatewayMCPServerBaseACLPropertiesOauth"}],"required":["type","display_name","ref","config","tools","policies"]},"AIGatewayMCPServerPassthroughListener":{"type":"object","properties":{"type":{"type":"string","enum":["passthrough-listener"]},"display_name":{"description":"The display name for the MCP Server.","type":"string","example":"Kong Air Flights"},"ref":{"description":"A user-defined unique identifier for this MCP server, used as a stable human-readable reference.","type":"string","example":"kongair-flights"},"config":{"$ref":"#/components/schemas/AIGatewayMCPServerConfig"},"tools":{"description":"List of tools exposed by this MCP Server.","type":"array","items":{"$ref":"#/components/schemas/AIGatewayMCPTool"}},"policies":{"type":"array","items":{"$ref":"#/components/schemas/AIGatewayPolicyReference"}},"labels":{"$ref":"#/components/schemas/PublicLabels"},"managed_by":{"$ref":"#/components/schemas/AIGatewayManagedBy"}},"additionalProperties":true,"discriminator":{"propertyName":"acl_attribute_type","mapping":{"consumer":"#/components/schemas/AIGatewayMCPServerBaseACLPropertiesConsumer","oauth_access_token":"#/components/schemas/AIGatewayMCPServerBaseACLPropertiesOauth"}},"oneOf":[{"$ref":"#/components/schemas/AIGatewayMCPServerBaseACLPropertiesConsumer"},{"$ref":"#/components/schemas/AIGatewayMCPServerBaseACLPropertiesOauth"}],"required":["type","display_name","ref","config","tools","policies"]},"AIGatewayMCPServerBaseACLPropertiesConsumer":{"type":"object","properties":{"acl_attribute_type":{"description":"The type of attributes that ACL is evaluated with.","type":"string","default":"consumer","enum":["consumer"]},"acls":{"description":"Access control rules for allowing or denying consumer groups.","additionalProperties":false,"allOf":[{"$ref":"#/components/schemas/AIGatewayACLS"}]},"default_tool_acls":{"description":"Default access control rules for allowing or denying consumer groups to tools.","allOf":[{"$ref":"#/components/schemas/AIGatewayACLS"}]}},"additionalProperties":false,"required":["acl_attribute_type","acls","default_tool_acls"]},"AIGatewayMCPServerBaseACLPropertiesOauth":{"type":"object","properties":{"acl_attribute_type":{"description":"The type of attributes that ACL is evaluated with.","type":"string","enum":["oauth_access_token"]},"access_token_claim_field":{"description":"The claim in the OAuth2 access token to use as the subject for ACL evaluation when `acl_attribute_type` is set to `oauth_access_token`.\nNested claim can be fetched by using a jq filter starts with dot, e.g., “.user.email”: https://jqlang.org/manual/#object-identifier-index\n","type":"string"},"acls":{"description":"Access control rules for allowing or denying consumer groups.","allOf":[{"$ref":"#/components/schemas/AIGatewayACLS"}]},"default_tool_acls":{"description":"Default access control rules for allowing or denying consumer groups to tools.","allOf":[{"$ref":"#/components/schemas/AIGatewayACLS"}]}},"additionalProperties":false,"required":["acl_attribute_type","acls","default_tool_acls","access_token_claim_field"]},"AIGatewayRedisAWSAuthentication":{"description":"AWS specific configs for connecting to a Cloud Provider's redis instance.","type":"object","properties":{"type":{"type":"string","enum":["aws"]},"access_key_id":{"description":"AWS Access Key ID to be used for authentication. \nThis field is [referenceable](/gateway/entities/vault/#how-do-i-reference-secrets-stored-in-a-vault). \nThis field is [encrypted](/gateway/keyring/).","type":"string","x-encrypted":true,"x-referenceable":true},"assume_role_arn":{"description":"The ARN of the IAM role to assume for generating ElastiCache IAM authentication tokens. \nThis field is [referenceable](/gateway/entities/vault/#how-do-i-reference-secrets-stored-in-a-vault). \nThis field is [encrypted](/gateway/keyring/).","type":"string","x-encrypted":true,"x-referenceable":true},"cache_name":{"description":"The name of the AWS Elasticache cluster. \nThis field is [referenceable](/gateway/entities/vault/#how-do-i-reference-secrets-stored-in-a-vault).","type":"string","x-referenceable":true},"is_serverless":{"description":"This flag specifies whether the cluster is serverless.","type":"boolean","default":true},"region":{"description":"The region of the AWS ElastiCache cluster. \nThis field is [referenceable](/gateway/entities/vault/#how-do-i-reference-secrets-stored-in-a-vault).","type":"string","x-referenceable":true},"role_session_name":{"description":"The session name for the temporary credentials when assuming the IAM role. \nThis field is [referenceable](/gateway/entities/vault/#how-do-i-reference-secrets-stored-in-a-vault). \nThis field is [encrypted](/gateway/keyring/).","type":"string","x-encrypted":true,"x-referenceable":true},"secret_access_key":{"description":"AWS Secret Access Key. \nThis field is [referenceable](/gateway/entities/vault/#how-do-i-reference-secrets-stored-in-a-vault). \nThis field is [encrypted](/gateway/keyring/).","type":"string","x-encrypted":true,"x-referenceable":true}},"additionalProperties":false,"required":["type"]},"AIGatewayRedisAzureAuthentication":{"description":"Azure specific configs for connecting to a Cloud Provider's redis instance.","type":"object","properties":{"type":{"type":"string","enum":["azure"]},"client_id":{"description":"Azure Client ID. \nThis field is [referenceable](/gateway/entities/vault/#how-do-i-reference-secrets-stored-in-a-vault). \nThis field is [encrypted](/gateway/keyring/).","type":"string","x-encrypted":true,"x-referenceable":true},"secret":{"description":"Azure Client Secret. \nThis field is [referenceable](/gateway/entities/vault/#how-do-i-reference-secrets-stored-in-a-vault). \nThis field is [encrypted](/gateway/keyring/).","type":"string","x-encrypted":true,"x-referenceable":true},"tenant_id":{"description":"Azure Tenant ID. \nThis field is [referenceable](/gateway/entities/vault/#how-do-i-reference-secrets-stored-in-a-vault). \nThis field is [encrypted](/gateway/keyring/).","type":"string","x-encrypted":true,"x-referenceable":true}},"additionalProperties":false,"required":["type"]},"AIGatewayRedisGCPAuthentication":{"description":"GCP specific configs for connecting to a Cloud Provider's redis instance.","type":"object","properties":{"type":{"type":"string","enum":["gcp"]},"service_account_json":{"description":"GCP Service Account JSON. \nThis field is [referenceable](/gateway/entities/vault/#how-do-i-reference-secrets-stored-in-a-vault). \nThis field is [encrypted](/gateway/keyring/).","type":"string","x-encrypted":true,"x-referenceable":true}},"additionalProperties":false,"required":["type"]},"AIGatewayRedisCloudConfiguration":{"description":"Config for connecting to a Cloud Provider's Redis instance.","type":"object","properties":{"cloud_authentication":{"description":"Auth related config for connecting to a Cloud Provider's Redis instance.","discriminator":{"propertyName":"type","mapping":{"aws":"#/components/schemas/AIGatewayRedisAWSAuthentication","azure":"#/components/schemas/AIGatewayRedisAzureAuthentication","gcp":"#/components/schemas/AIGatewayRedisGCPAuthentication"}},"oneOf":[{"$ref":"#/components/schemas/AIGatewayRedisAWSAuthentication"},{"$ref":"#/components/schemas/AIGatewayRedisAzureAuthentication"},{"$ref":"#/components/schemas/AIGatewayRedisGCPAuthentication"}]},"cluster":{"description":"Cluster configuration for the Redis connection.","type":"object","additionalProperties":false,"properties":{"max_redirections":{"description":"Maximum retry attempts for redirection.","type":"integer","default":5},"nodes":{"description":"Cluster addresses to use for Redis connections when the `redis` strategy is defined. Defining this field implies using a Redis Cluster. The minimum length of the array is 1 element.","type":"array","items":{"type":"object","properties":{"ip":{"description":"A string representing a host name, such as example.com.","type":"string","default":"127.0.0.1"},"port":{"description":"An integer representing a port number between 0 and 65535, inclusive.","type":"integer","default":6379,"maximum":65535,"minimum":0}}},"minItems":1}}},"connect_timeout":{"description":"An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2.","type":"integer","default":2000,"maximum":2147483646,"minimum":0},"connection_is_proxied":{"description":"If the connection to Redis is proxied (e.g. Envoy), set it `true`. Set the `host` and `port` to point to the proxy address.","type":"boolean","default":false},"database":{"description":"Database to use for the Redis connection when using the `redis` strategy","type":"integer","default":0},"host":{"description":"A string representing a host name, such as example.com. \nThis field is [referenceable](/gateway/entities/vault/#how-do-i-reference-secrets-stored-in-a-vault).","type":"string","default":"127.0.0.1","x-referenceable":true},"keepalive":{"description":"Keepalive configuration for the Redis connection.","type":"object","additionalProperties":false,"properties":{"backlog":{"description":"Limits the total number of opened connections for a pool. If the connection pool is full, connection queues above the limit go into the backlog queue. If the backlog queue is full, subsequent connect operations fail and return `nil`. Queued operations (subject to set timeouts) resume once the number of connections in the pool is less than `pool_size`. If latency is high or throughput is low, try increasing this value. Empirically, this value is larger than `pool_size`.","type":"integer","maximum":2147483646,"minimum":0},"pool_size":{"description":"The size limit for every cosocket connection pool associated with every remote server, per worker process. If neither `pool_size` nor `backlog` is specified, no pool is created. If `pool_size` isn't specified but `backlog` is specified, then the pool uses the default value. Try to increase (e.g. 512) this value if latency is high or throughput is low.","type":"integer","default":256,"maximum":2147483646,"minimum":1}}},"password":{"description":"Password to use for Redis connections. If undefined, no AUTH commands are sent to Redis. \nThis field is [referenceable](/gateway/entities/vault/#how-do-i-reference-secrets-stored-in-a-vault). \nThis field is [encrypted](/gateway/keyring/).","type":"string","x-encrypted":true,"x-referenceable":true},"port":{"description":"An integer representing a port number between 0 and 65535, inclusive. \nThis field is [referenceable](/gateway/entities/vault/#how-do-i-reference-secrets-stored-in-a-vault).","type":"integer","default":6379,"maximum":65535,"minimum":0,"x-referenceable":true},"read_timeout":{"description":"An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2.","type":"integer","default":2000,"maximum":2147483646,"minimum":0},"send_timeout":{"description":"An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2.","type":"integer","default":2000,"maximum":2147483646,"minimum":0},"sentinel":{"description":"Configuration for Redis Sentinel.","type":"object","additionalProperties":false,"properties":{"master":{"description":"Sentinel master to use for Redis connections. Defining this value implies using Redis Sentinel.","type":"string"},"nodes":{"description":"Sentinel node addresses to use for Redis connections when the `redis` strategy is defined. Defining this field implies using a Redis Sentinel. The minimum length of the array is 1 element.","type":"array","items":{"type":"object","properties":{"host":{"description":"A string representing a host name, such as example.com.","type":"string","default":"127.0.0.1"},"port":{"description":"An integer representing a port number between 0 and 65535, inclusive.","type":"integer","default":6379,"maximum":65535,"minimum":0}}},"minItems":1},"password":{"description":"Sentinel password to authenticate with a Redis Sentinel instance. If undefined, no AUTH commands are sent to Redis Sentinels. \nThis field is [referenceable](/gateway/entities/vault/#how-do-i-reference-secrets-stored-in-a-vault). \nThis field is [encrypted](/gateway/keyring/).","type":"string","x-encrypted":true,"x-referenceable":true},"role":{"description":"Sentinel role to use for Redis connections when the `redis` strategy is defined. Defining this value implies using Redis Sentinel.","type":"string","enum":["any","master","slave"]},"username":{"description":"Sentinel username to authenticate with a Redis Sentinel instance. If undefined, ACL authentication won't be performed. This requires Redis v6.2.0+. \nThis field is [referenceable](/gateway/entities/vault/#how-do-i-reference-secrets-stored-in-a-vault).","type":"string","x-referenceable":true}}},"server_name":{"description":"A string representing an SNI (server name indication) value for TLS. \nThis field is [referenceable](/gateway/entities/vault/#how-do-i-reference-secrets-stored-in-a-vault).","type":"string","x-referenceable":true},"ssl":{"description":"If set to true, uses SSL to connect to Redis.","type":"boolean","default":false},"ssl_verify":{"description":"If set to true, verifies the validity of the server SSL certificate. If setting this parameter, also configure `lua_ssl_trusted_certificate` in `kong.conf` to specify the CA (or server) certificate used by your Redis server. You may also need to configure `lua_ssl_verify_depth` accordingly.","type":"boolean","default":true},"username":{"description":"Username to use for Redis connections. If undefined, ACL authentication won't be performed. This requires Redis v6.0.0+. To be compatible with Redis v5.x.y, you can set it to `default`. \nThis field is [referenceable](/gateway/entities/vault/#how-do-i-reference-secrets-stored-in-a-vault).","type":"string","x-referenceable":true}},"additionalProperties":false},"AIGatewayRouteConfig":{"description":"Configuration for an AI Gateway route.","type":"object","properties":{"destinations":{"description":"A list of IP destinations of incoming connections that match this route when using stream routing. Each entry is an object with fields ip (optionally in CIDR range notation) and/or port.","type":"array","items":{"type":"object","properties":{"ip":{"type":"string"},"port":{"type":"integer"}},"example":{"ip":"10.1.0.0/16","port":1234}}},"headers":{"description":"One or more lists of values indexed by header name that will cause this route to match if present in the request. The `Host` header cannot be used with this attribute: hosts should be specified using the `hosts` attribute. When `headers` contains only one value and that value starts with the special prefix `~*`, the value is interpreted as a regular expression.","type":"object","example":{"version":["v1","v2"]},"additionalProperties":true},"hosts":{"description":"A list of domain names that match this route. Note that the hosts value is case sensitive.","type":"array","items":{"type":"string","example":"foo.example.com"}},"https_redirect_status_code":{"description":"The status code Kong responds with when all properties of a route match except the protocol i.e. if the protocol of the request is `HTTP` instead of `HTTPS`. `Location` header is injected by Kong if the field is set to 301, 302, 307 or 308. Note: This config applies only if the route is configured to only accept the `https` protocol.","type":"integer","default":426},"id":{"type":"string","example":"56c4566c-14cc-4132-9011-4139fcbbe50a"},"methods":{"description":"A list of HTTP methods that match this route.","type":"array","items":{"type":"string"}},"name":{"description":"The name of the route. Route names must be unique, and they are case sensitive. For example, there can be two different routes named test and Test.","type":"string"},"path_handling":{"description":"Controls how the service path, route path and requested path are combined when sending a request to the upstream. See above for a detailed description of each behavior.","type":"string","default":"v0"},"paths":{"description":"A list of paths that match this route.","type":"array","items":{"type":"string"}},"preserve_host":{"description":"When matching a route via one of the `hosts` domain names, use the request `Host` header in the upstream request headers. If set to `false`, the upstream `Host` header will be that of the service's `host`.","type":"boolean","default":false},"protocols":{"description":"An array of the protocols this route should allow. See the [route Object](#route-object) section for a list of accepted protocols. When set to only `https`, HTTP requests are answered with an upgrade error. When set to only `http`, HTTPS requests are answered with an error.","type":"array","items":{"type":"string"},"default":["http","https"]},"regex_priority":{"description":"A number used to choose which route resolves a given request when several routes match it using regexes simultaneously. When two routes match the path and have the same `regex_priority`, the older one (lowest `created_at`) is used. Note that the priority for non-regex routes is different (longer non-regex routes are matched before shorter ones).","type":"integer","default":0},"request_buffering":{"description":"Whether to enable request body buffering or not. With HTTP 1.1, it may make sense to turn this off on services that receive data with chunked transfer encoding.","type":"boolean","default":true},"response_buffering":{"description":"Whether to enable response body buffering or not. With HTTP 1.1, it may make sense to turn this off on services that send data with chunked transfer encoding.","type":"boolean","default":true},"service":{"description":"The service this route is associated to. This is where the route proxies traffic to.","type":"object","additionalProperties":false,"properties":{"id":{"type":"string"}}},"snis":{"description":"A list of SNIs that match this route when using stream routing.","type":"array","items":{"type":"string"}},"sources":{"description":"A list of IP sources of incoming connections that match this route when using stream routing. Each entry is an object with fields ip (optionally in CIDR range notation) and/or port.","type":"array","items":{"type":"object","properties":{"ip":{"type":"string"},"port":{"type":"integer"}},"example":{"ip":"10.1.0.0/16","port":1234}}},"strip_path":{"description":"When matching a route via one of the `paths`, strip the matching prefix from the upstream request URL.","type":"boolean","default":true},"tags":{"description":"An optional set of strings associated with the route for grouping and filtering.","type":"array","items":{"type":"string"}}},"additionalProperties":false},"AIGatewayLoggingConfig":{"description":"Configuration for AI Gateway logging.","type":"object","properties":{"payloads":{"type":"boolean","default":false},"statistics":{"type":"boolean","default":false}},"additionalProperties":false,"required":["payloads","statistics"]},"AIGatewayMCPServerConfig":{"description":"Routing, logging, and server configuration for the MCP Server.","type":"object","properties":{"route":{"$ref":"#/components/schemas/AIGatewayRouteConfig"},"logging":{"description":"Configuration for AI Gateway logging.","type":"object","additionalProperties":false,"properties":{"payloads":{"type":"boolean","default":false},"statistics":{"type":"boolean","default":false},"audits":{"type":"boolean","default":false}},"required":["payloads","statistics","audits"]},"max_request_body_size":{"type":"integer","default":1048576},"server":{"type":"object","additionalProperties":false,"properties":{"forward_client_headers":{"description":"Whether to forward the client request headers to the upstream server when calling the tools.","type":"boolean","default":true},"session":{"description":"Enable managed session when Kong responds as MCP server in listener or conversion-listener modes. This doesn't affect the passthrough-listener mode as the state in that mode is maintained by the upstream MCP servers.","type":"object","additionalProperties":false,"properties":{"client":{"description":"The configuration for client-side session storage.","type":"object","additionalProperties":false,"properties":{"secrets":{"description":"The secrets that are used in session encryption. Required when the strategy is 'client'. The first secret is used for encryption, while all secrets are used for decryption to support key rotation.","type":"array","items":{"type":"string","minLength":8,"x-encrypted":true,"x-referenceable":true,"description":"\nThis field is [referenceable](/gateway/entities/vault/#how-do-i-reference-secrets-stored-in-a-vault). \nThis field is [encrypted](/gateway/keyring/)."},"minItems":1}}},"managed":{"description":"If enabled, Kong will maintain managed sessions with the MCP server.","type":"boolean","default":true},"redis":{"$ref":"#/components/schemas/AIGatewayRedisCloudConfiguration"},"session_ttl":{"description":"The time-to-live (TTL) for each session in seconds.","type":"integer","default":86400},"strategy":{"description":"The strategy for the session. If the value is 'client', the session is encrypted into MCP session id assigned to the client. If the value is not 'client', the session is stored in the configured database.","type":"string","enum":["client","redis"]}}},"tag":{"description":"The tag of the MCP server. This is used to filter the exported MCP tools. The field should contain exactly one tag.","type":"string"},"timeout":{"description":"The timeout for calling the tools in milliseconds.","type":"integer","default":10000}}}},"additionalProperties":false},"CreateAIGatewayMCPServerRequest":{"discriminator":{"propertyName":"type","mapping":{"conversion-only":"#/components/schemas/AIGatewayMCPServerConversionOnly","conversion-listener":"#/components/schemas/AIGatewayMCPServerConversionListener","listener":"#/components/schemas/AIGatewayMCPServerListener","passthrough-listener":"#/components/schemas/AIGatewayMCPServerPassthroughListener"}},"oneOf":[{"$ref":"#/components/schemas/AIGatewayMCPServerConversionOnly"},{"$ref":"#/components/schemas/AIGatewayMCPServerConversionListener"},{"$ref":"#/components/schemas/AIGatewayMCPServerListener"},{"$ref":"#/components/schemas/AIGatewayMCPServerPassthroughListener"}]},"UpdateAIGatewayMCPServerRequest":{"discriminator":{"propertyName":"type","mapping":{"conversion-only":"#/components/schemas/AIGatewayMCPServerConversionOnly","conversion-listener":"#/components/schemas/AIGatewayMCPServerConversionListener","listener":"#/components/schemas/AIGatewayMCPServerListener","passthrough-listener":"#/components/schemas/AIGatewayMCPServerPassthroughListener"}},"oneOf":[{"$ref":"#/components/schemas/AIGatewayMCPServerConversionOnly"},{"$ref":"#/components/schemas/AIGatewayMCPServerConversionListener"},{"$ref":"#/components/schemas/AIGatewayMCPServerListener"},{"$ref":"#/components/schemas/AIGatewayMCPServerPassthroughListener"}]},"AIGatewayMCPServer":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/UUID"},"created_at":{"$ref":"#/components/schemas/CreatedAt"},"updated_at":{"$ref":"#/components/schemas/UpdatedAt"}},"discriminator":{"propertyName":"type","mapping":{"conversion-only":"#/components/schemas/AIGatewayMCPServerConversionOnly","conversion-listener":"#/components/schemas/AIGatewayMCPServerConversionListener","listener":"#/components/schemas/AIGatewayMCPServerListener","passthrough-listener":"#/components/schemas/AIGatewayMCPServerPassthroughListener"}},"oneOf":[{"$ref":"#/components/schemas/AIGatewayMCPServerConversionOnly"},{"$ref":"#/components/schemas/AIGatewayMCPServerConversionListener"},{"$ref":"#/components/schemas/AIGatewayMCPServerListener"},{"$ref":"#/components/schemas/AIGatewayMCPServerPassthroughListener"}],"required":["id","created_at","updated_at"]},"AIGatewayMCPTool":{"description":"A tool exposed by the MCP Server, mapped to a backend HTTP endpoint.","type":"object","properties":{"acls":{"description":"Access control rules for allowing or denying consumer groups access to this tool. \nWhen configured, these will override the default access control rules defined on the MCP Server.\n","allOf":[{"$ref":"#/components/schemas/AIGatewayACLS"}]},"annotations":{"$ref":"#/components/schemas/AIGatewayMCPToolAnnotations"},"description":{"description":"A description of what the tool does.","type":"string","example":"Search for available flights"},"headers":{"$ref":"#/components/schemas/AIGatewayMCPToolHeaders"},"host":{"description":"The host of the exported API, which must match the route's hosts. It should be the route's host. By default, Kong will extract the host from API configuration. If the configured host is wildcard, this field is required.","type":"string"},"name":{"description":"Tool identifier. In passthrough-listener mode, used to match remote MCP Server tools for ACL enforcement. In other modes, it is also used as the tool name (overrides annotations.title if present).","type":"string"},"method":{"description":"The method of the exported API, which must match the route's methods.","type":"string","enum":["DELETE","GET","PATCH","POST","PUT"]},"path":{"description":"The path of the exported API, which must match the route's paths. Path not starting with '/' are treated as relative path and the route path will be added as the prefix. By default, Kong will extract the path from API configuration.","type":"string"},"query":{"$ref":"#/components/schemas/AIGatewayMCPToolQuery"},"request_body":{"$ref":"#/components/schemas/AIGatewayMCPToolRequestBody"},"responses":{"$ref":"#/components/schemas/AIGatewayMCPToolResponses"},"scheme":{"description":"The scheme of the exported API. By default, Kong will extract the scheme from API configuration. If the configured scheme is not expected, this field can be used to override it.","type":"string","enum":["http","https"]},"parameters":{"$ref":"#/components/schemas/AIGatewayMCPToolParameters"}},"additionalProperties":false,"required":["description","method"]},"AIGatewayMCPToolAnnotations":{"type":"object","properties":{"destructive_hint":{"description":"If true, the tool may perform destructive updates","type":"boolean"},"idempotent_hint":{"description":"If true, repeated calls with same args have no additional effect","type":"boolean"},"open_world_hint":{"description":"If true, tool interacts with external entities","type":"boolean"},"read_only_hint":{"description":"If true, the tool does not modify its environment","type":"boolean"},"title":{"description":"Human-readable title for the tool","type":"string"}},"additionalProperties":false},"AIGatewayMCPToolHeaders":{"description":"The headers of the exported API. By default, Kong will extract the headers from API configuration. If the configured headers are not exactly matched, this field is required.","type":"object","additionalProperties":true},"AIGatewayMCPToolQuery":{"description":"The query arguments of the exported API. If the generated query arguments are not exactly matched, this field is required.","type":"object","additionalProperties":true},"AIGatewayMCPToolRequestBody":{"description":"The API requestBody specification defined in OpenAPI JSON format. For example, '{\"content\":{\"application/x-www-form-urlencoded\":{\"schema\":{\"type\":\"object\",\"properties\":{\"color\":{\"type\":\"array\",\"items\":{\"type\":\"string\"}}}}}}}'. See https://swagger.io/docs/specification/v3_0/describing-request-body/describing-request-body/ for more details. Note that `$ref` is not supported.","type":"object","additionalProperties":true},"AIGatewayMCPToolResponses":{"description":"The API responses specification defined in OpenAPI JSON format. This specification will be used to validate the upstream response and map it back to the structuredOutput. For example, '{\"200\":{\"content\":{\"application/json\":{\"schema\":{\"type\":\"object\",\"properties\":{\"result\":{\"type\":\"string\"}}}}}}}}'. See https://swagger.io/docs/specification/v3_0/describing-responses/ for more details. Only one non-error (status code < 400) response is supported. Note that `$ref` is not supported.","type":"object","additionalProperties":true},"AIGatewayMCPToolParameters":{"type":"array","items":{"$ref":"#/components/schemas/AIGatewayMCPToolParameter"}},"AIGatewayMCPToolParameter":{"description":"An API parameter specification defined in OpenAPI JSON format. For example, '[{\"name\": \"city\", \"in\": \"query\", \"description\": \"Name of the city to get the weather for\", \"required\": true, \"schema\": {\"type\": \"string\"}}]'. See https://swagger.io/docs/specification/v3_0/describing-parameters/ for more details.","type":"object","properties":{"name":{"description":"The name of the parameter.","type":"string","example":"origin"},"in":{"description":"The location of the parameter in the request.","type":"string","example":"query","enum":["query","path","header","body"]},"description":{"description":"A description of the parameter.","type":"string","example":"The origin airport code."},"required":{"description":"Whether this parameter is required.","type":"boolean","example":true},"schema":{"description":"JSON Schema definition for the parameter value.","type":"object","additionalProperties":true}},"additionalProperties":false,"required":["name","in"]},"AIGatewayProviderReference":{"description":"Lightweight object used to reference a provider instance, identified by its `ref`.","type":"object","properties":{"ref":{"description":"The user-defined unique identifier for a provider instance.","type":"string","example":"azure-ai-se"}},"additionalProperties":false,"required":["ref"]},"AIGatewayProviderAnthropic":{"description":"Configuration for an upstream LLM provider.\n","type":"object","properties":{"type":{"type":"string","enum":["anthropic"]},"display_name":{"description":"The display name for this provider instance.","type":"string","example":"Azure AI SE"},"ref":{"description":"A user-defined unique identifier for this provider instance, used as a stable human-readable reference.","type":"string","example":"azure-ai-se"},"labels":{"$ref":"#/components/schemas/PublicLabels"},"managed_by":{"$ref":"#/components/schemas/AIGatewayManagedBy"},"config":{"description":"Configuration for the provider.","type":"object","additionalProperties":false,"properties":{"auth":{"$ref":"#/components/schemas/AIGatewayProviderConfigAuthBasic"}},"required":["auth"]}},"additionalProperties":false,"required":["type","display_name","ref","config"]},"AIGatewayProviderCerebras":{"description":"Configuration for an upstream LLM provider.\n","type":"object","properties":{"type":{"type":"string","enum":["cerebras"]},"display_name":{"description":"The display name for this provider instance.","type":"string","example":"Azure AI SE"},"ref":{"description":"A user-defined unique identifier for this provider instance, used as a stable human-readable reference.","type":"string","example":"azure-ai-se"},"labels":{"$ref":"#/components/schemas/PublicLabels"},"managed_by":{"$ref":"#/components/schemas/AIGatewayManagedBy"},"config":{"description":"Configuration for the provider.","type":"object","additionalProperties":false,"properties":{"auth":{"$ref":"#/components/schemas/AIGatewayProviderConfigAuthBasic"}},"required":["auth"]}},"additionalProperties":false,"required":["type","display_name","ref","config"]},"AIGatewayProviderCohere":{"description":"Configuration for an upstream LLM provider.\n","type":"object","properties":{"type":{"type":"string","enum":["cohere"]},"display_name":{"description":"The display name for this provider instance.","type":"string","example":"Azure AI SE"},"ref":{"description":"A user-defined unique identifier for this provider instance, used as a stable human-readable reference.","type":"string","example":"azure-ai-se"},"labels":{"$ref":"#/components/schemas/PublicLabels"},"managed_by":{"$ref":"#/components/schemas/AIGatewayManagedBy"},"config":{"description":"Configuration for the provider.","type":"object","additionalProperties":false,"properties":{"auth":{"$ref":"#/components/schemas/AIGatewayProviderConfigAuthBasic"}},"required":["auth"]}},"additionalProperties":false,"required":["type","display_name","ref","config"]},"AIGatewayProviderDashscope":{"description":"Configuration for an upstream LLM provider.\n","type":"object","properties":{"type":{"type":"string","enum":["dashscope"]},"display_name":{"description":"The display name for this provider instance.","type":"string","example":"Azure AI SE"},"ref":{"description":"A user-defined unique identifier for this provider instance, used as a stable human-readable reference.","type":"string","example":"azure-ai-se"},"labels":{"$ref":"#/components/schemas/PublicLabels"},"managed_by":{"$ref":"#/components/schemas/AIGatewayManagedBy"},"config":{"description":"Configuration for the provider.","type":"object","additionalProperties":false,"properties":{"auth":{"$ref":"#/components/schemas/AIGatewayProviderConfigAuthBasic"}},"required":["auth"]}},"additionalProperties":false,"required":["type","display_name","ref","config"]},"AIGatewayProviderDatabricks":{"description":"Configuration for an upstream LLM provider.\n","type":"object","properties":{"type":{"type":"string","enum":["databricks"]},"display_name":{"description":"The display name for this provider instance.","type":"string","example":"Azure AI SE"},"ref":{"description":"A user-defined unique identifier for this provider instance, used as a stable human-readable reference.","type":"string","example":"azure-ai-se"},"labels":{"$ref":"#/components/schemas/PublicLabels"},"managed_by":{"$ref":"#/components/schemas/AIGatewayManagedBy"},"config":{"description":"Configuration for the provider.","type":"object","additionalProperties":false,"properties":{"auth":{"$ref":"#/components/schemas/AIGatewayProviderConfigAuthBasic"}},"required":["auth"]}},"additionalProperties":false,"required":["type","display_name","ref","config"]},"AIGatewayProviderDeepseek":{"description":"Configuration for an upstream LLM provider.\n","type":"object","properties":{"type":{"type":"string","enum":["deepseek"]},"display_name":{"description":"The display name for this provider instance.","type":"string","example":"Azure AI SE"},"ref":{"description":"A user-defined unique identifier for this provider instance, used as a stable human-readable reference.","type":"string","example":"azure-ai-se"},"labels":{"$ref":"#/components/schemas/PublicLabels"},"managed_by":{"$ref":"#/components/schemas/AIGatewayManagedBy"},"config":{"description":"Configuration for the provider.","type":"object","additionalProperties":false,"properties":{"auth":{"$ref":"#/components/schemas/AIGatewayProviderConfigAuthBasic"}},"required":["auth"]}},"additionalProperties":false,"required":["type","display_name","ref","config"]},"AIGatewayProviderHuggingface":{"description":"Configuration for an upstream LLM provider.\n","type":"object","properties":{"type":{"type":"string","enum":["huggingface"]},"display_name":{"description":"The display name for this provider instance.","type":"string","example":"Azure AI SE"},"ref":{"description":"A user-defined unique identifier for this provider instance, used as a stable human-readable reference.","type":"string","example":"azure-ai-se"},"labels":{"$ref":"#/components/schemas/PublicLabels"},"managed_by":{"$ref":"#/components/schemas/AIGatewayManagedBy"},"config":{"description":"Configuration for the provider.","type":"object","additionalProperties":false,"properties":{"auth":{"$ref":"#/components/schemas/AIGatewayProviderConfigAuthBasic"}},"required":["auth"]}},"additionalProperties":false,"required":["type","display_name","ref","config"]},"AIGatewayProviderLlama2":{"description":"Configuration for an upstream LLM provider.\n","type":"object","properties":{"type":{"type":"string","enum":["llama2"]},"display_name":{"description":"The display name for this provider instance.","type":"string","example":"Azure AI SE"},"ref":{"description":"A user-defined unique identifier for this provider instance, used as a stable human-readable reference.","type":"string","example":"azure-ai-se"},"labels":{"$ref":"#/components/schemas/PublicLabels"},"managed_by":{"$ref":"#/components/schemas/AIGatewayManagedBy"},"config":{"description":"Configuration for the provider.","type":"object","additionalProperties":false,"properties":{"auth":{"$ref":"#/components/schemas/AIGatewayProviderConfigAuthBasic"}},"required":["auth"]}},"additionalProperties":false,"required":["type","display_name","ref","config"]},"AIGatewayProviderMistral":{"description":"Configuration for an upstream LLM provider.\n","type":"object","properties":{"type":{"type":"string","enum":["mistral"]},"display_name":{"description":"The display name for this provider instance.","type":"string","example":"Azure AI SE"},"ref":{"description":"A user-defined unique identifier for this provider instance, used as a stable human-readable reference.","type":"string","example":"azure-ai-se"},"labels":{"$ref":"#/components/schemas/PublicLabels"},"managed_by":{"$ref":"#/components/schemas/AIGatewayManagedBy"},"config":{"description":"Configuration for the provider.","type":"object","additionalProperties":false,"properties":{"auth":{"$ref":"#/components/schemas/AIGatewayProviderConfigAuthBasic"}},"required":["auth"]}},"additionalProperties":false,"required":["type","display_name","ref","config"]},"AIGatewayProviderOllama":{"description":"Configuration for an upstream LLM provider.\n","type":"object","properties":{"type":{"type":"string","enum":["ollama"]},"display_name":{"description":"The display name for this provider instance.","type":"string","example":"Azure AI SE"},"ref":{"description":"A user-defined unique identifier for this provider instance, used as a stable human-readable reference.","type":"string","example":"azure-ai-se"},"labels":{"$ref":"#/components/schemas/PublicLabels"},"managed_by":{"$ref":"#/components/schemas/AIGatewayManagedBy"},"config":{"description":"Configuration for the provider.","type":"object","additionalProperties":false,"properties":{"auth":{"$ref":"#/components/schemas/AIGatewayProviderConfigAuthBasic"}},"required":["auth"]}},"additionalProperties":false,"required":["type","display_name","ref","config"]},"AIGatewayProviderOpenai":{"description":"Configuration for an upstream LLM provider.\n","type":"object","properties":{"type":{"type":"string","enum":["openai"]},"display_name":{"description":"The display name for this provider instance.","type":"string","example":"Azure AI SE"},"ref":{"description":"A user-defined unique identifier for this provider instance, used as a stable human-readable reference.","type":"string","example":"azure-ai-se"},"labels":{"$ref":"#/components/schemas/PublicLabels"},"managed_by":{"$ref":"#/components/schemas/AIGatewayManagedBy"},"config":{"description":"Configuration for the provider.","type":"object","additionalProperties":false,"properties":{"auth":{"$ref":"#/components/schemas/AIGatewayProviderConfigAuthBasic"}},"required":["auth"]}},"additionalProperties":false,"required":["type","display_name","ref","config"]},"AIGatewayProviderVllm":{"description":"Configuration for an upstream LLM provider.\n","type":"object","properties":{"type":{"type":"string","enum":["vllm"]},"display_name":{"description":"The display name for this provider instance.","type":"string","example":"Azure AI SE"},"ref":{"description":"A user-defined unique identifier for this provider instance, used as a stable human-readable reference.","type":"string","example":"azure-ai-se"},"labels":{"$ref":"#/components/schemas/PublicLabels"},"managed_by":{"$ref":"#/components/schemas/AIGatewayManagedBy"},"config":{"description":"Configuration for the provider.","type":"object","additionalProperties":false,"properties":{"auth":{"$ref":"#/components/schemas/AIGatewayProviderConfigAuthBasic"}},"required":["auth"]}},"additionalProperties":false,"required":["type","display_name","ref","config"]},"AIGatewayProviderXai":{"description":"Configuration for an upstream LLM provider.\n","type":"object","properties":{"type":{"type":"string","enum":["xai"]},"display_name":{"description":"The display name for this provider instance.","type":"string","example":"Azure AI SE"},"ref":{"description":"A user-defined unique identifier for this provider instance, used as a stable human-readable reference.","type":"string","example":"azure-ai-se"},"labels":{"$ref":"#/components/schemas/PublicLabels"},"managed_by":{"$ref":"#/components/schemas/AIGatewayManagedBy"},"config":{"description":"Configuration for the provider.","type":"object","additionalProperties":false,"properties":{"auth":{"$ref":"#/components/schemas/AIGatewayProviderConfigAuthBasic"}},"required":["auth"]}},"additionalProperties":false,"required":["type","display_name","ref","config"]},"AIGatewayProviderConfigAuthBasic":{"description":"Basic auth config for an upstream LLM provider.\n","type":"object","properties":{"type":{"type":"string","enum":["basic"]},"headers":{"type":"array","items":{"type":"object","additionalProperties":false,"properties":{"name":{"type":"string"},"value":{"type":"string","writeOnly":true}}},"maxItems":1},"params":{"type":"array","items":{"type":"object","additionalProperties":false,"properties":{"name":{"type":"string"},"value":{"type":"string","writeOnly":true},"location":{"description":"Specify whether the param name and value options go in a query string, or the POST form/JSON body.","type":"string","enum":["body","query"]}}},"maxItems":1}},"additionalProperties":false,"required":["type"]},"AIGatewayProviderBedrock":{"description":"Config for AWS LLM provider.\n","type":"object","properties":{"type":{"type":"string","enum":["bedrock"]},"display_name":{"description":"The display name for this provider instance.","type":"string","example":"Azure AI SE"},"ref":{"description":"A user-defined unique identifier for this provider instance, used as a stable human-readable reference.","type":"string","example":"azure-ai-se"},"labels":{"$ref":"#/components/schemas/PublicLabels"},"managed_by":{"$ref":"#/components/schemas/AIGatewayManagedBy"},"config":{"type":"object","additionalProperties":false,"properties":{"auth":{"discriminator":{"propertyName":"type","mapping":{"basic":"#/components/schemas/AIGatewayProviderConfigAuthBasic","aws":"#/components/schemas/AIGatewayProviderConfigAuthAWS"}},"oneOf":[{"$ref":"#/components/schemas/AIGatewayProviderConfigAuthBasic"},{"$ref":"#/components/schemas/AIGatewayProviderConfigAuthAWS"}]}},"required":["auth"]}},"additionalProperties":false,"required":["type","display_name","ref","config"]},"AIGatewayProviderConfigAuthAWS":{"description":"Configuration for AWS LLM provider.\n","type":"object","properties":{"type":{"type":"string","enum":["aws"]},"access_key_id":{"type":"string"},"secret_access_key":{"type":"string","writeOnly":true},"assume_role_arn":{"type":"string"},"role_session_name":{"type":"string"},"sts_endpoint_url":{"type":"string"},"batch_role_arn":{"type":"string"}},"additionalProperties":false,"required":["type"]},"AIGatewayProviderAzure":{"description":"Config for Azure LLM provider.\n","type":"object","properties":{"type":{"type":"string","enum":["azure"]},"display_name":{"description":"The display name for this provider instance.","type":"string","example":"Azure AI SE"},"ref":{"description":"A user-defined unique identifier for this provider instance, used as a stable human-readable reference.","type":"string","example":"azure-ai-se"},"labels":{"$ref":"#/components/schemas/PublicLabels"},"managed_by":{"$ref":"#/components/schemas/AIGatewayManagedBy"},"config":{"type":"object","additionalProperties":false,"properties":{"auth":{"discriminator":{"propertyName":"type","mapping":{"basic":"#/components/schemas/AIGatewayProviderConfigAuthBasic","azure":"#/components/schemas/AIGatewayProviderConfigAuthAzure"}},"oneOf":[{"$ref":"#/components/schemas/AIGatewayProviderConfigAuthBasic"},{"$ref":"#/components/schemas/AIGatewayProviderConfigAuthAzure"}]},"instance":{"type":"string","example":"kong-az-east"}},"required":["auth"]}},"additionalProperties":false,"required":["type","display_name","ref","config"]},"AIGatewayProviderConfigAuthAzure":{"description":"Configuration for Azure LLM provider.\n","type":"object","properties":{"type":{"type":"string","enum":["azure"]},"client_id":{"type":"string"},"client_secret":{"type":"string","writeOnly":true},"tenant_id":{"type":"string"},"use_managed_identity":{"type":"boolean"}},"additionalProperties":false,"required":["type"]},"AIGatewayProviderGemini":{"description":"Config for GCP LLM provider.\n","type":"object","properties":{"type":{"type":"string","enum":["gemini"]},"display_name":{"description":"The display name for this provider instance.","type":"string","example":"Azure AI SE"},"ref":{"description":"A user-defined unique identifier for this provider instance, used as a stable human-readable reference.","type":"string","example":"azure-ai-se"},"labels":{"$ref":"#/components/schemas/PublicLabels"},"managed_by":{"$ref":"#/components/schemas/AIGatewayManagedBy"},"config":{"type":"object","additionalProperties":false,"properties":{"auth":{"discriminator":{"propertyName":"type","mapping":{"basic":"#/components/schemas/AIGatewayProviderConfigAuthBasic","gcp":"#/components/schemas/AIGatewayProviderConfigAuthGCP"}},"oneOf":[{"$ref":"#/components/schemas/AIGatewayProviderConfigAuthBasic"},{"$ref":"#/components/schemas/AIGatewayProviderConfigAuthGCP"}]},"project_id":{"type":"string"}},"required":["auth"]}},"additionalProperties":false,"required":["type","display_name","ref","config"]},"AIGatewayProviderConfigAuthGCP":{"description":"Configuration for GCP LLM provider.\n","type":"object","properties":{"type":{"type":"string","enum":["gcp"]},"service_account_json":{"type":"string","writeOnly":true},"metadata_url":{"type":"string"},"oauth_token_url":{"type":"string"},"use_gcp_service_account":{"type":"boolean"}},"additionalProperties":false,"required":["type"]},"CreateAIGatewayProviderRequest":{"discriminator":{"propertyName":"type","mapping":{"anthropic":"#/components/schemas/AIGatewayProviderAnthropic","azure":"#/components/schemas/AIGatewayProviderAzure","bedrock":"#/components/schemas/AIGatewayProviderBedrock","cerebras":"#/components/schemas/AIGatewayProviderCerebras","cohere":"#/components/schemas/AIGatewayProviderCohere","dashscope":"#/components/schemas/AIGatewayProviderDashscope","databricks":"#/components/schemas/AIGatewayProviderDatabricks","deepseek":"#/components/schemas/AIGatewayProviderDeepseek","gemini":"#/components/schemas/AIGatewayProviderGemini","huggingface":"#/components/schemas/AIGatewayProviderHuggingface","llama2":"#/components/schemas/AIGatewayProviderLlama2","mistral":"#/components/schemas/AIGatewayProviderMistral","ollama":"#/components/schemas/AIGatewayProviderOllama","openai":"#/components/schemas/AIGatewayProviderOpenai","vllm":"#/components/schemas/AIGatewayProviderVllm","xai":"#/components/schemas/AIGatewayProviderXai"}},"oneOf":[{"$ref":"#/components/schemas/AIGatewayProviderAnthropic"},{"$ref":"#/components/schemas/AIGatewayProviderAzure"},{"$ref":"#/components/schemas/AIGatewayProviderBedrock"},{"$ref":"#/components/schemas/AIGatewayProviderCerebras"},{"$ref":"#/components/schemas/AIGatewayProviderCohere"},{"$ref":"#/components/schemas/AIGatewayProviderDashscope"},{"$ref":"#/components/schemas/AIGatewayProviderDatabricks"},{"$ref":"#/components/schemas/AIGatewayProviderDeepseek"},{"$ref":"#/components/schemas/AIGatewayProviderGemini"},{"$ref":"#/components/schemas/AIGatewayProviderHuggingface"},{"$ref":"#/components/schemas/AIGatewayProviderLlama2"},{"$ref":"#/components/schemas/AIGatewayProviderMistral"},{"$ref":"#/components/schemas/AIGatewayProviderOllama"},{"$ref":"#/components/schemas/AIGatewayProviderOpenai"},{"$ref":"#/components/schemas/AIGatewayProviderVllm"},{"$ref":"#/components/schemas/AIGatewayProviderXai"}]},"UpdateAIGatewayProviderRequest":{"discriminator":{"propertyName":"type","mapping":{"anthropic":"#/components/schemas/AIGatewayProviderAnthropic","azure":"#/components/schemas/AIGatewayProviderAzure","bedrock":"#/components/schemas/AIGatewayProviderBedrock","cerebras":"#/components/schemas/AIGatewayProviderCerebras","cohere":"#/components/schemas/AIGatewayProviderCohere","dashscope":"#/components/schemas/AIGatewayProviderDashscope","databricks":"#/components/schemas/AIGatewayProviderDatabricks","deepseek":"#/components/schemas/AIGatewayProviderDeepseek","gemini":"#/components/schemas/AIGatewayProviderGemini","huggingface":"#/components/schemas/AIGatewayProviderHuggingface","llama2":"#/components/schemas/AIGatewayProviderLlama2","mistral":"#/components/schemas/AIGatewayProviderMistral","ollama":"#/components/schemas/AIGatewayProviderOllama","openai":"#/components/schemas/AIGatewayProviderOpenai","vllm":"#/components/schemas/AIGatewayProviderVllm","xai":"#/components/schemas/AIGatewayProviderXai"}},"oneOf":[{"$ref":"#/components/schemas/AIGatewayProviderAnthropic"},{"$ref":"#/components/schemas/AIGatewayProviderAzure"},{"$ref":"#/components/schemas/AIGatewayProviderBedrock"},{"$ref":"#/components/schemas/AIGatewayProviderCerebras"},{"$ref":"#/components/schemas/AIGatewayProviderCohere"},{"$ref":"#/components/schemas/AIGatewayProviderDashscope"},{"$ref":"#/components/schemas/AIGatewayProviderDatabricks"},{"$ref":"#/components/schemas/AIGatewayProviderDeepseek"},{"$ref":"#/components/schemas/AIGatewayProviderGemini"},{"$ref":"#/components/schemas/AIGatewayProviderHuggingface"},{"$ref":"#/components/schemas/AIGatewayProviderLlama2"},{"$ref":"#/components/schemas/AIGatewayProviderMistral"},{"$ref":"#/components/schemas/AIGatewayProviderOllama"},{"$ref":"#/components/schemas/AIGatewayProviderOpenai"},{"$ref":"#/components/schemas/AIGatewayProviderVllm"},{"$ref":"#/components/schemas/AIGatewayProviderXai"}]},"AIGatewayProvider":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/UUID"},"created_at":{"$ref":"#/components/schemas/CreatedAt"},"updated_at":{"$ref":"#/components/schemas/UpdatedAt"}},"discriminator":{"propertyName":"type","mapping":{"anthropic":"#/components/schemas/AIGatewayProviderAnthropic","azure":"#/components/schemas/AIGatewayProviderAzure","bedrock":"#/components/schemas/AIGatewayProviderBedrock","cerebras":"#/components/schemas/AIGatewayProviderCerebras","cohere":"#/components/schemas/AIGatewayProviderCohere","dashscope":"#/components/schemas/AIGatewayProviderDashscope","databricks":"#/components/schemas/AIGatewayProviderDatabricks","deepseek":"#/components/schemas/AIGatewayProviderDeepseek","gemini":"#/components/schemas/AIGatewayProviderGemini","huggingface":"#/components/schemas/AIGatewayProviderHuggingface","llama2":"#/components/schemas/AIGatewayProviderLlama2","mistral":"#/components/schemas/AIGatewayProviderMistral","ollama":"#/components/schemas/AIGatewayProviderOllama","openai":"#/components/schemas/AIGatewayProviderOpenai","vllm":"#/components/schemas/AIGatewayProviderVllm","xai":"#/components/schemas/AIGatewayProviderXai"}},"oneOf":[{"$ref":"#/components/schemas/AIGatewayProviderAnthropic"},{"$ref":"#/components/schemas/AIGatewayProviderAzure"},{"$ref":"#/components/schemas/AIGatewayProviderBedrock"},{"$ref":"#/components/schemas/AIGatewayProviderCerebras"},{"$ref":"#/components/schemas/AIGatewayProviderCohere"},{"$ref":"#/components/schemas/AIGatewayProviderDashscope"},{"$ref":"#/components/schemas/AIGatewayProviderDatabricks"},{"$ref":"#/components/schemas/AIGatewayProviderDeepseek"},{"$ref":"#/components/schemas/AIGatewayProviderGemini"},{"$ref":"#/components/schemas/AIGatewayProviderHuggingface"},{"$ref":"#/components/schemas/AIGatewayProviderLlama2"},{"$ref":"#/components/schemas/AIGatewayProviderMistral"},{"$ref":"#/components/schemas/AIGatewayProviderOllama"},{"$ref":"#/components/schemas/AIGatewayProviderOpenai"},{"$ref":"#/components/schemas/AIGatewayProviderVllm"},{"$ref":"#/components/schemas/AIGatewayProviderXai"}],"required":["id","created_at","updated_at"]},"PublicLabels":{"description":"Public labels store information about an entity that can be used for filtering a list of objects.\n\nPublic labels are intended to store **PUBLIC** metadata. \n\nKeys must be of length 1-63 characters, and cannot start with \"kong\", \"konnect\", \"mesh\", \"kic\", or \"_\".\n","type":"object","example":{"category":"finance"},"additionalProperties":{"type":"string","pattern":"^[a-z0-9A-Z]{1}([a-z0-9A-Z-._]*[a-z0-9A-Z]+)?$","minLength":1,"maxLength":63},"maxProperties":50,"title":"PublicLabels"},"UUID":{"description":"Contains a unique identifier used for this resource.","type":"string","format":"uuid","example":"5f9fd312-a987-4628-b4c5-bb4f4fddd5f7","readOnly":true},"CreatedAt":{"description":"An ISO-8601 timestamp representation of entity creation date.","type":"string","format":"date-time","example":"2022-11-04T20:10:06.927Z","readOnly":true},"UpdatedAt":{"description":"An ISO-8601 timestamp representation of entity update date.","type":"string","format":"date-time","example":"2022-11-04T20:10:06.927Z","readOnly":true},"PageMeta":{"description":"Contains pagination query parameters and the total number of objects returned.","type":"object","properties":{"number":{"type":"number","example":1},"size":{"type":"number","example":10},"total":{"type":"number","example":100}},"required":["number","size","total"]},"PaginatedMeta":{"description":"returns the pagination information","type":"object","properties":{"page":{"$ref":"#/components/schemas/PageMeta"}},"required":["page"],"title":"PaginatedMeta"},"BaseError":{"description":"standard error","type":"object","properties":{"status":{"description":"The HTTP status code of the error. Useful when passing the response\nbody to child properties in a frontend UI. Must be returned as an integer.\n","type":"integer","readOnly":true},"title":{"description":"A short, human-readable summary of the problem. It should not\nchange between occurences of a problem, except for localization.\nShould be provided as \"Sentence case\" for direct use in the UI.\n","type":"string","readOnly":true},"type":{"description":"The error type.","type":"string","readOnly":true},"instance":{"description":"Used to return the correlation ID back to the user, in the format\nkong:trace:<correlation_id>. This helps us find the relevant logs\nwhen a customer reports an issue.\n","type":"string","readOnly":true},"detail":{"description":"A human readable explanation specific to this occurence of the problem.\nThis field may contain request/entity data to help the user understand\nwhat went wrong. Enclose variable values in square brackets. Should be\nprovided as \"Sentence case\" for direct use in the UI.\n","type":"string","readOnly":true}},"required":["status","title","instance","detail"],"title":"Error"},"UnauthorizedError":{"allOf":[{"$ref":"#/components/schemas/BaseError"},{"type":"object","properties":{"status":{"example":401},"title":{"example":"Unauthorized"},"type":{"example":"https://httpstatuses.com/401"},"instance":{"example":"kong:trace:1234567890"},"detail":{"example":"Invalid credentials"}}}]},"ForbiddenError":{"allOf":[{"$ref":"#/components/schemas/BaseError"},{"type":"object","properties":{"status":{"example":403},"title":{"example":"Forbidden"},"type":{"example":"https://httpstatuses.com/403"},"instance":{"example":"kong:trace:1234567890"},"detail":{"example":"Forbidden"}}}]},"TooManyRequestsError":{"allOf":[{"$ref":"#/components/schemas/BaseError"},{"type":"object","properties":{"status":{"example":429},"title":{"example":"Too Many Requests"},"type":{"example":"https://httpstatuses.com/429"},"instance":{"example":"kong:trace:1234567890"},"detail":{"example":"Too Many Requests"}}}]},"InvalidRules":{"description":"invalid parameters rules","type":"string","enum":["required","is_array","is_base64","is_boolean","is_date_time","is_integer","is_null","is_number","is_object","is_string","is_uuid","is_fqdn","is_arn","unknown_property","missing_reference","is_label","matches_regex","invalid","is_supported_network_availability_zone_list","is_supported_network_cidr_block","is_supported_provider_region","type"],"nullable":true,"readOnly":true},"InvalidParameterStandard":{"type":"object","properties":{"field":{"type":"string","example":"name","readOnly":true},"rule":{"$ref":"#/components/schemas/InvalidRules"},"source":{"type":"string","example":"body"},"reason":{"type":"string","example":"is a required field","readOnly":true}},"additionalProperties":false,"required":["field","reason"]},"InvalidParameterMinimumLength":{"type":"object","properties":{"field":{"type":"string","example":"name","readOnly":true},"rule":{"description":"invalid parameters rules","type":"string","enum":["min_length","min_digits","min_lowercase","min_uppercase","min_symbols","min_items","min"],"nullable":false,"readOnly":true},"minimum":{"type":"integer","example":8},"source":{"type":"string","example":"body"},"reason":{"type":"string","example":"must have at least 8 characters","readOnly":true}},"additionalProperties":false,"required":["field","reason","rule","minimum"]},"InvalidParameterMaximumLength":{"type":"object","properties":{"field":{"type":"string","example":"name","readOnly":true},"rule":{"description":"invalid parameters rules","type":"string","enum":["max_length","max_items","max"],"nullable":false,"readOnly":true},"maximum":{"type":"integer","example":8},"source":{"type":"string","example":"body"},"reason":{"type":"string","example":"must not have more than 8 characters","readOnly":true}},"additionalProperties":false,"required":["field","reason","rule","maximum"]},"InvalidParameterChoiceItem":{"type":"object","properties":{"field":{"type":"string","example":"name","readOnly":true},"rule":{"description":"invalid parameters rules","type":"string","enum":["enum"],"nullable":false,"readOnly":true},"reason":{"type":"string","example":"is a required field","readOnly":true},"choices":{"type":"array","items":{},"minItems":1,"nullable":false,"readOnly":true,"uniqueItems":true},"source":{"type":"string","example":"body"}},"additionalProperties":false,"required":["field","reason","rule","choices"]},"InvalidParameterDependentItem":{"type":"object","properties":{"field":{"type":"string","example":"name","readOnly":true},"rule":{"description":"invalid parameters rules","type":"string","enum":["dependent_fields"],"nullable":true,"readOnly":true},"reason":{"type":"string","example":"is a required field","readOnly":true},"dependents":{"type":"array","items":{},"nullable":true,"readOnly":true,"uniqueItems":true},"source":{"type":"string","example":"body"}},"additionalProperties":false,"required":["field","rule","reason","dependents"]},"InvalidParameters":{"description":"invalid parameters","type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/InvalidParameterStandard"},{"$ref":"#/components/schemas/InvalidParameterMinimumLength"},{"$ref":"#/components/schemas/InvalidParameterMaximumLength"},{"$ref":"#/components/schemas/InvalidParameterChoiceItem"},{"$ref":"#/components/schemas/InvalidParameterDependentItem"}]},"minItems":1,"nullable":false,"uniqueItems":true},"BadRequestError":{"allOf":[{"$ref":"#/components/schemas/BaseError"},{"type":"object","required":["invalid_parameters"],"properties":{"invalid_parameters":{"$ref":"#/components/schemas/InvalidParameters"}}}]},"ConflictError":{"allOf":[{"$ref":"#/components/schemas/BaseError"},{"type":"object","properties":{"status":{"example":409},"title":{"example":"Conflict"},"type":{"example":"https://httpstatuses.com/409"},"instance":{"example":"kong:trace:1234567890"},"detail":{"example":"Conflict"}}}]},"NotFoundError":{"allOf":[{"$ref":"#/components/schemas/BaseError"},{"type":"object","properties":{"status":{"example":404},"title":{"example":"Not Found"},"type":{"example":"https://httpstatuses.com/404"},"instance":{"example":"kong:trace:1234567890"},"detail":{"example":"Not found"}}}]},"CursorMetaPage":{"type":"object","properties":{"first":{"description":"URI to the first page","type":"string","format":"path"},"last":{"description":"URI to the last page","type":"string","format":"path"},"next":{"description":"URI to the next page","type":"string","format":"path","nullable":true},"previous":{"description":"URI to the previous page","type":"string","format":"path","nullable":true},"size":{"description":"Requested page size","type":"number","example":10}},"required":["size","next","previous"]},"CursorMeta":{"description":"Pagination metadata.","type":"object","properties":{"page":{"$ref":"#/components/schemas/CursorMetaPage"}},"required":["page"]}},"examples":{"AIGatewayExample":{"value":{"id":"bf138ba2-c9b1-4229-b268-04d9d8a6410b","name":"My AI Gateway","description":"An AI Gateway for my organization.","labels":{"env":"production"},"endpoints":{"configuration":"https://acfe5f253f.cp.konghq.com","telemetry":"https://acfe5f253f.tp0.konghq.com"},"config_hash":"2cf24dba5fb0a30e26e83b2ac5b9e29e1b161e5c1fa7425e73043362938b9824","created_at":"2024-01-01T00:00:00.000Z","updated_at":"2024-01-01T00:00:00.000Z"}},"AIGatewayDataplaneCertificateExample":{"value":{"title":"My AI Gateway Data Plane Certificate","description":"My description","cert":"-----BEGIN CERTIFICATE-----\r\n*****\r\n-----END CERTIFICATE-----\r\n"}},"CreateAIGatewayRequestExample":{"value":{"name":"My AI Gateway","description":"An AI Gateway for my organization.","labels":{"env":"production"}}},"UpdateAIGatewayRequestExample":{"value":{"name":"My Updated AI Gateway","description":"An updated description.","labels":{"env":"staging"}}},"ListAIGatewaysResponseExample":{"value":{"meta":{"page":{"number":1,"size":10,"total":1}},"data":[{"id":"bf138ba2-c9b1-4229-b268-04d9d8a6410b","name":"My AI Gateway","description":"An AI Gateway for my organization.","labels":{"env":"production"},"endpoints":{"configuration":"https://acfe5f253f.cp.konghq.com","telemetry":"https://acfe5f253f.tp0.konghq.com"},"config_hash":"2cf24dba5fb0a30e26e83b2ac5b9e29e1b161e5c1fa7425e73043362938b9824","created_at":"2024-01-01T00:00:00.000Z","updated_at":"2024-01-01T00:00:00.000Z"}]}},"UnauthorizedExample":{"value":{"status":401,"title":"Unauthorized","instance":"kong:trace:8347343766220159418","detail":"Unauthorized"}},"ForbiddenExample":{"value":{"status":403,"title":"Forbidden","instance":"kong:trace:2723154947768991354","detail":"You do not have permission to perform this action"}},"NotFoundExample":{"value":{"status":404,"title":"Not Found","instance":"kong:trace:6816496025408232265","detail":"Not Found"}}},"responses":{"ListAIGatewaysResponse":{"description":"A paginated list of AI Gateways.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/AIGateway"}},"meta":{"$ref":"#/components/schemas/PaginatedMeta"}},"additionalProperties":false,"required":["data","meta"],"title":"ListAIGatewaysResponse"},"examples":{"List AI Gateways Response":{"$ref":"#/components/examples/ListAIGatewaysResponseExample"}}}}},"CreateAIGatewayResponse":{"description":"AI Gateway created successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AIGateway"},"examples":{"AI Gateway Response":{"$ref":"#/components/examples/AIGatewayExample"}}}}},"GetAIGatewayResponse":{"description":"A successful response returning an AI Gateway.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AIGateway"},"examples":{"AI Gateway Response":{"$ref":"#/components/examples/AIGatewayExample"}}}}},"UpdateAIGatewayResponse":{"description":"AI Gateway updated successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AIGateway"},"examples":{"AI Gateway Response":{"$ref":"#/components/examples/AIGatewayExample"}}}}},"CreateAIGatewayModelResponse":{"description":"Model created successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AIGatewayModel"}}}},"GetAIGatewayModelResponse":{"description":"A successful response returning the AI Gateway Model.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AIGatewayModel"}}}},"UpdateAIGatewayModelResponse":{"description":"Model updated successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AIGatewayModel"}}}},"ListAIGatewayModelsResponse":{"description":"A successful response listing AI Gateway Models.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/AIGatewayModel"}},"meta":{"$ref":"#/components/schemas/CursorMeta"}},"required":["data","meta"]}}}},"ListAIGatewayDataPlaneCertificatesResponse":{"description":"Example response","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/AIGatewayDataPlaneClientCertificate"}},"meta":{"$ref":"#/components/schemas/CursorMeta"}},"additionalProperties":false,"required":["data","meta"]}}}},"CreateAIGatewayDataPlaneCertificateResponse":{"description":"Response body for creating a DataPlane certificate.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AIGatewayDataPlaneClientCertificate"}}}},"GetAIGatewayDataPlaneCertificateResponse":{"description":"Response body for retrieving a DataPlane certificate.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AIGatewayDataPlaneClientCertificate"}}}},"ListAIGatewayDataPlaneNodesResponse":{"description":"A successful response listing AI Gateway Data Plane Nodes.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/AIGatewayDataPlaneNode"}},"meta":{"$ref":"#/components/schemas/CursorMeta"}},"required":["data","meta"]}}}},"GetAIGatewayDataPlaneNodeResponse":{"description":"A successful response containing the AI Gateway Data Plane Node.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AIGatewayDataPlaneNode"}}}},"CreateAIGatewayPolicyResponse":{"description":"Policy created successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AIGatewayPolicy"}}}},"GetAIGatewayPolicyResponse":{"description":"A successful response returning the AI Gateway Policy.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AIGatewayPolicy"}}}},"UpdateAIGatewayPolicyResponse":{"description":"Policy updated successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AIGatewayPolicy"}}}},"ListAIGatewayPoliciesResponse":{"description":"A successful response listing AI Gateway Policies.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/AIGatewayPolicy"}},"meta":{"$ref":"#/components/schemas/CursorMeta"}},"required":["data","meta"]}}}},"ListAIGatewayMCPServersResponse":{"description":"A paginated list of MCP Servers.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/AIGatewayMCPServer"}},"meta":{"$ref":"#/components/schemas/CursorMeta"}},"required":["data","meta"]}}}},"CreateAIGatewayMCPServerResponse":{"description":"MCP Server created successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AIGatewayMCPServer"}}}},"GetMCPServerResponse":{"description":"A successful response returning an MCP Server.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AIGatewayMCPServer"}}}},"UpdateAIGatewayMCPServerResponse":{"description":"MCP Server updated successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AIGatewayMCPServer"}}}},"ListAIGatewayProvidersResponse":{"description":"A paginated list of AI Gateway Providers.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/AIGatewayProvider"}},"meta":{"$ref":"#/components/schemas/CursorMeta"}},"required":["data","meta"]}}}},"ListAIGatewayAgentsResponse":{"description":"A paginated list of AI Agents.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/AIGatewayAgent"}},"meta":{"$ref":"#/components/schemas/CursorMeta"}},"required":["data","meta"]}}}},"CreateAIGatewayAgentResponse":{"description":"AI Agent created successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AIGatewayAgent"}}}},"GetAIGatewayAgentResponse":{"description":"A successful response returning an AI Gateway Agent.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AIGatewayAgent"}}}},"UpdateAIGatewayAgentResponse":{"description":"Agent updated successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AIGatewayAgent"}}}},"ListAIGatewayConsumersResponse":{"description":"A paginated list of AI Gateway Consumers.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/AIGatewayConsumer"}},"meta":{"$ref":"#/components/schemas/CursorMeta"}},"required":["data","meta"]}}}},"CreateAIGatewayConsumerResponse":{"description":"AI Gateway Consumer created successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AIGatewayConsumer"}}}},"GetAIGatewayConsumerResponse":{"description":"A successful response returning an AI Gateway Consumer.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AIGatewayConsumer"}}}},"UpdateAIGatewayConsumerResponse":{"description":"Consumer updated successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AIGatewayConsumer"}}}},"ListAIGatewayConsumerGroupsResponse":{"description":"A paginated list of AI Gateway Consumer Groups.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/AIGatewayConsumerGroup"}},"meta":{"$ref":"#/components/schemas/CursorMeta"}},"required":["data","meta"]}}}},"CreateAIGatewayConsumerGroupResponse":{"description":"AI Gateway Consumer Group created successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AIGatewayConsumerGroup"}}}},"GetAIGatewayConsumerGroupResponse":{"description":"A successful response returning an AI Gateway Consumer Group.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AIGatewayConsumerGroup"}}}},"UpdateAIGatewayConsumerGroupResponse":{"description":"Consumer Group updated successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AIGatewayConsumerGroup"}}}},"CreateAIGatewayProviderResponse":{"description":"Provider created successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AIGatewayProvider"}}}},"GetAIGatewayProviderResponse":{"description":"A successful response returning an AI Gateway Provider.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AIGatewayProvider"}}}},"UpdateAIGatewayProviderResponse":{"description":"Provider updated successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AIGatewayProvider"}}}},"Unauthorized":{"description":"Unauthorized","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"},"examples":{"UnauthorizedExample":{"$ref":"#/components/examples/UnauthorizedExample"}}}}},"Forbidden":{"description":"Forbidden","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"},"examples":{"UnauthorizedExample":{"$ref":"#/components/examples/ForbiddenExample"}}}}},"TooManyRequests":{"description":"Too Many Requests","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}},"BadRequest":{"description":"Bad Request","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/BadRequestError"}}}},"Conflict":{"description":"Conflict","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ConflictError"}}}},"NotFound":{"description":"Not Found","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/NotFoundError"},"examples":{"NotFoundExample":{"$ref":"#/components/examples/NotFoundExample"}}}}}},"securitySchemes":{"konnectAccessToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"The Konnect access token is meant to be used by the Konnect dashboard and the decK CLI authenticate with.\n"}}},"tags":[{"name":"AI Gateways","description":"API related to the management of Konnect AI Gateway resources."},{"name":"AI Gateway DataPlane Certificates","description":"API related to the management of AI Gateway DataPlane Certificates."},{"name":"AI Gateway Nodes","description":"API related to the management of AI Gateway nodes."},{"name":"AI Gateway Agents","description":"AI Agents registered with the AI Gateway."},{"name":"AI Gateway Consumers","description":"Individual consumers with credentials and group memberships for AI Gateway access control."},{"name":"AI Gateway Consumer Groups","description":"Consumer groups for applying rate-limiting and access policies to AI Gateway traffic."},{"name":"AI Gateway Models","description":"Models that define routing, capabilities, and backend targets for the AI Gateway."},{"name":"AI Gateway Policies","description":"Policies that control security, rate-limiting, and guardrail behavior for the AI Gateway."},{"name":"AI Gateway MCP Servers","description":"MCP Servers that expose tools for AI Gateway integrations."},{"name":"AI Gateway Providers","description":"Providers that define the backend AI service connections for the AI Gateway."}],"security":[{"konnectAccessToken":[]}]}
```
