---
title: "Konnect AI Manager"
url: "https://nov18-dev.movespot.fyi/apis/konnect-ai-manager-dev-0/versions/5560b094-d9b3-497a-885f-5c08563528d7"
---

# Konnect AI Manager

OpenAPI specification document.

```json
{"openapi":"3.0.0","info":{"title":"Konnect AI Manager","version":"0.0.0","description":"Internal API for managing Kong AI Manager resources.","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-manager/models":{"get":{"operationId":"list-ai-manager-models","summary":"List AI Models","description":"Returns a list of composite objects containing a plugin and service that represent an LLM integration.. This represents an ai-manager-models for the organization ID represented in the JWT claim.","parameters":[{"$ref":"#/components/parameters/PageSize"},{"$ref":"#/components/parameters/PageAfter"}],"responses":{"200":{"description":"A successful response listing AI Manager Models","content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/AIManagerModel"}},"page":{"type":"object","properties":{"total_count":{"description":"The total number of items in the collection.","type":"integer","example":2},"next_cursor":{"description":"The cursor for the next page of items.","type":"string"},"has_next_page":{"description":"Indicates if there is a next page of items.","type":"boolean","example":true}}}},"required":["items","page"]}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/TooManyRequests"},"500":{"$ref":"#/components/responses/Internal"},"503":{"$ref":"#/components/responses/NotAvailable"}},"tags":["AI Manager Models"]}}},"components":{"parameters":{"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"}},"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":{"AIManagerModel":{"type":"object","properties":{"control_plane":{"type":"object","additionalProperties":false,"properties":{"id":{"description":"The control plane ID.","type":"string","format":"uuid","example":"7f9fd312-a987-4628-b4c5-bb4f4fddd5f7","readOnly":true},"type":{"description":"The ClusterType value of the cluster associated with the Control Plane.","type":"string","example":"CLUSTER_TYPE_CONTROL_PLANE","enum":["CLUSTER_TYPE_CONTROL_PLANE","CLUSTER_TYPE_K8S_INGRESS_CONTROLLER","CLUSTER_TYPE_CONTROL_PLANE_GROUP","CLUSTER_TYPE_SERVERLESS"],"readOnly":true},"is_cloud_gateway":{"description":"Whether the Control Plane can be used for cloud-gateways. Omitted when false.","type":"boolean","readOnly":true}},"required":["id","type"],"x-examples":{"Example 1":{"id":"7f9fd312-a987-4628-b4c5-bb4f4fddd5f7","type":"CLUSTER_TYPE_CONTROL_PLANE","is_cloud_gateway":true},"Example 2":{"id":"08926ef0-7169-42f6-926e-f0716982f6d9","type":"CLUSTER_TYPE_SERVERLESS"}}},"service":{"$ref":"#/components/schemas/Service"},"plugin":{"$ref":"#/components/schemas/Plugin"}},"additionalProperties":false},"Service":{"description":"Service entities, as the name implies, are abstractions of each of your own upstream services. Examples of Services would be a data transformation microservice, a billing API, etc. The main attribute of a Service is its URL (where Kong should proxy traffic to), which can be set as a single string or by specifying its `protocol`, `host`, `port` and `path` individually. Services are associated to Routes (a Service can have many Routes associated with it). Routes are entry-points in Kong and define rules to match client requests. Once a Route is matched, Kong proxies the request to its associated Service. See the [Proxy Reference][proxy-reference] for a detailed explanation of how Kong proxies traffic.","type":"object","properties":{"ca_certificates":{"description":"Array of `CA Certificate` object UUIDs that are used to build the trust store while verifying upstream server's TLS certificate. If set to `null` when Nginx default is respected. If default CA list in Nginx are not specified and TLS verification is enabled, then handshake with upstream server will always fail (because no CA are trusted).","type":"array","items":{"type":"string"},"nullable":true},"client_certificate":{"description":"Certificate to be used as client certificate while TLS handshaking to the upstream server.","type":"object","nullable":true,"properties":{"id":{"type":"string"}},"x-foreign":true},"connect_timeout":{"description":"The timeout in milliseconds for establishing a connection to the upstream server.","type":"integer","default":60000,"maximum":2147483646,"minimum":1,"nullable":true},"created_at":{"description":"Unix epoch when the resource was created.","type":"integer","nullable":true},"description":{"description":"User-defined entity description. Konnect only field, not synced to the Gateway.","type":"string","nullable":true},"enabled":{"description":"Whether the Service is active. If set to `false`, the proxy behavior will be as if any routes attached to it do not exist (404). Default: `true`.","type":"boolean","default":true,"nullable":true},"host":{"description":"The host of the upstream server. Note that the host value is case sensitive.","type":"string"},"id":{"description":"A string representing a UUID (universally unique identifier).","type":"string","minLength":1,"nullable":true},"managed_by":{"description":"Arbitrary JSON data for client responsible for managing the entity. Konnect only field, not synced to the Gateway.","type":"object","additionalProperties":true,"nullable":true},"name":{"description":"The Service name.","type":"string","nullable":true},"path":{"description":"The path to be used in requests to the upstream server.","type":"string","nullable":true},"port":{"description":"The upstream server port.","type":"integer","default":80,"maximum":65535,"minimum":0,"nullable":true},"protocol":{"description":"The protocol used to communicate with the upstream.","type":"string","default":"http","enum":["grpc","grpcs","http","https","tcp","tls","tls_passthrough","udp","ws","wss"],"nullable":true},"read_timeout":{"description":"The timeout in milliseconds between two successive read operations for transmitting a request to the upstream server.","type":"integer","default":60000,"maximum":2147483646,"minimum":1,"nullable":true},"retries":{"description":"The number of retries to execute upon failure to proxy.","type":"integer","default":5,"maximum":32767,"minimum":0,"nullable":true},"tags":{"description":"An optional set of strings associated with the Service for grouping and filtering.","type":"array","items":{"description":"A string representing a tag.","type":"string"},"nullable":true},"tls_sans":{"description":"Additional Subject Alternative Names that can be matched on Upstream server's TLS certificate (in addition to `host`).","type":"object","nullable":true,"properties":{"dnsnames":{"description":"A dnsName for TLS verification.","type":"array","items":{"description":"A string representing an SNI (server name indication) value for TLS.","type":"string"}},"uris":{"description":"An URI for TLS verification.","type":"array","items":{"description":"A string representing a URL, such as https://example.com/path/to/resource?q=search.","type":"string"}}}},"tls_verify":{"description":"Whether to enable verification of upstream server TLS certificate. If set to `null`, then the Nginx default is respected.","type":"boolean","nullable":true},"tls_verify_depth":{"description":"Maximum depth of chain while verifying Upstream server's TLS certificate. If set to `null`, then the Nginx default is respected.","type":"integer","maximum":64,"minimum":0,"nullable":true},"updated_at":{"description":"Unix epoch when the resource was last updated.","type":"integer","nullable":true},"url":{"description":"Helper field to set `protocol`, `host`, `port` and `path` using a URL. This field is write-only and is not returned in responses.","type":"string","writeOnly":true},"write_timeout":{"description":"The timeout in milliseconds between two successive write operations for transmitting a request to the upstream server.","type":"integer","default":60000,"maximum":2147483646,"minimum":1,"nullable":true}},"example":{"host":"example.internal","id":"49fd316e-c457-481c-9fc7-8079153e4f3c","name":"example-service","path":"/","port":80,"protocol":"http"},"additionalProperties":false,"required":["host"]},"Plugin":{"description":"A Plugin entity represents a plugin configuration that will be executed during the HTTP request/response lifecycle. It is how you can add functionalities to Services that run behind Kong, like Authentication or Rate Limiting for example. You can find more information about how to install and what values each plugin takes by visiting the [Kong Hub](https://docs.konghq.com/hub/). When adding a Plugin Configuration to a Service, every request made by a client to that Service will run said Plugin. If a Plugin needs to be tuned to different values for some specific Consumers, you can do so by creating a separate plugin instance that specifies both the Service and the Consumer, through the `service` and `consumer` fields.","type":"object","properties":{"__ui_data":{"description":"Arbitrary JSON data for UI configuration. Konnect only field, not synced to the Gateway.","type":"object","additionalProperties":true,"nullable":true,"x-go-name":"UIData"},"condition":{"description":"An expression used for conditional control over plugin execution. If the expression evaluates to `true` during the request flow, the plugin is executed; otherwise, it is skipped.","type":"string","maxLength":1024,"nullable":true},"config":{"description":"The configuration properties for the Plugin which can be found on the plugins documentation page in the [Kong Hub](https://docs.konghq.com/hub/).","type":"object","additionalProperties":true,"nullable":true},"consumer":{"description":"If set, the plugin will activate only for requests where the specified has been authenticated. (Note that some plugins can not be restricted to consumers this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer.","type":"object","nullable":true,"properties":{"id":{"type":"string"}},"x-foreign":true},"consumer_group":{"description":"If set, the plugin will activate only for requests where the specified group has been authenticated","type":"object","nullable":true,"properties":{"id":{"type":"string"}},"x-foreign":true},"created_at":{"description":"Unix epoch when the resource was created.","type":"integer","nullable":true},"description":{"description":"User-defined entity description. Konnect only field, not synced to the Gateway.","type":"string","nullable":true},"enabled":{"description":"Whether the plugin is applied.","type":"boolean","default":true,"nullable":true},"id":{"description":"A string representing a UUID (universally unique identifier).","type":"string","minLength":1,"nullable":true},"instance_name":{"description":"A unique string representing a UTF-8 encoded name.","type":"string","nullable":true},"managed_by":{"description":"Arbitrary JSON data for client responsible for managing the entity. Konnect only field, not synced to the Gateway.","type":"object","additionalProperties":true,"nullable":true},"name":{"description":"The name of the Plugin that's going to be added. Currently, the Plugin must be installed in every Kong instance separately.","type":"string","minLength":1},"ordering":{"type":"object","nullable":true,"properties":{"after":{"type":"object","properties":{"access":{"type":"array","items":{"type":"string"}}}},"before":{"type":"object","properties":{"access":{"type":"array","items":{"type":"string"}}}}}},"partials":{"description":"A list of partials to be used by the plugin.","type":"array","items":{"properties":{"id":{"description":"A string representing a UUID (universally unique identifier).","type":"string","minLength":1},"name":{"description":"A unique string representing a UTF-8 encoded name.","type":"string"},"path":{"type":"string"}},"type":"object"},"nullable":true},"protocols":{"description":"A list of the request protocols that will trigger this plugin. The default value, as well as the possible values allowed on this field, may change depending on the plugin type. For example, plugins that only work in stream mode will only support `\"tcp\"` and `\"tls\"`.","type":"array","items":{"description":"A string representing a protocol, such as HTTP or HTTPS.","enum":["grpc","grpcs","http","https","tcp","tls","tls_passthrough","udp","ws","wss"],"type":"string"},"default":["grpc","grpcs","http","https"],"nullable":true},"route":{"description":"If set, the plugin will only activate when receiving requests via the specified route. Leave unset for the plugin to activate regardless of the Route being used.","type":"object","nullable":true,"properties":{"id":{"type":"string"}},"x-foreign":true},"service":{"description":"If set, the plugin will only activate when receiving requests via one of the routes belonging to the specified Service. Leave unset for the plugin to activate regardless of the Service being matched.","type":"object","nullable":true,"properties":{"id":{"type":"string"}},"x-foreign":true},"tags":{"description":"An optional set of strings associated with the Plugin for grouping and filtering.","type":"array","items":{"description":"A string representing a tag.","type":"string"},"nullable":true},"updated_at":{"description":"Unix epoch when the resource was last updated.","type":"integer","nullable":true}},"example":{"config":{"anonymous":null,"hide_credentials":false,"key_in_body":false,"key_in_header":true,"key_in_query":true,"key_names":["apikey"],"run_on_preflight":true},"enabled":true,"id":"3fd1eea1-885a-4011-b986-289943ff8177","name":"key-auth","partials":[{"id":"cff1230a-00f7-4ae8-b376-c370f0eb4dae","name":"foo-partial","path":"config.redis"},{"id":"129ee345-cba8-4e55-9d6d-93c223ff91ae","name":"bar-partial","path":"config.redis"}],"protocols":["grpc","grpcs","http","https"]},"additionalProperties":false,"required":["name"]},"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"}}}]},"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"}}}]},"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"}}}]}},"examples":{"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":{"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"}}}}},"NotFound":{"description":"Not Found","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/NotFoundError"},"examples":{"NotFoundExample":{"$ref":"#/components/examples/NotFoundExample"}}}}},"TooManyRequests":{"description":"Too Many Requests","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}},"Internal":{"description":"Internal","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/BaseError"}}}},"NotAvailable":{"description":"Service not available","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/BaseError"}}}}},"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 Manager Models","description":"A composite object that conceptually represents the concept of an AI Model. The object contains a service object \nand a plugin object defined on that service. The service object represents the LLM endpoint and the plugin object \nrepresents the configuration of the LLM endpoint. The plugin will be one of: ai-proxy or ai-proxy-advanced."}],"security":[{"konnectAccessToken":[]}]}
```
