Catalog AI Models

Returns a paginated list of AI Models for the current organization. Each row includes a managed_by object derived from whether the model is linked to an AI Gateway model.

get/v1/ai-models

Request

  • Base URL: https://global.api.konghq.com
  • URL: https://global.api.konghq.com/v1/ai-models
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer
    • HTTP bearer
    • HTTP bearer

Query parameters

page[size]integer
Example:10

The maximum number of items to include per page. The last page of a collection may include fewer items.

page[number]integer
Example:1

Determines which page of the entities to retrieve.

Filter AI Models returned in the response.

{
  "created_at": {
    "eq": "2022-03-30T07:20:50Z"
  },
  "updated_at": {
    "eq": "2022-03-30T07:20:50Z"
  }
}
sortstring

The asc suffix is optional as the default sort order is ascending. The desc suffix is used to specify a descending order. Multiple sort attributes may be provided via a comma separated list. JSONPath notation may be used to specify a sub-attribute (eg: 'foo.bar desc').

Example:created_at desc

Sort AI Models by specified fields. Supported sort attributes are:

  • display_name
  • name
  • created_at
  • updated_at

Default sort is display_name in ascending order.

Response

A paginated list of AI Models

Example response

{
  "data": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "my-ai-model",
      "display_name": "My AI Model",
      "description": "Customer support triage model",
      "labels": {
        "env": "test"
      },
      "managed_by": {
        "owner": "terraform"
      },
      "created_at": "2022-11-04T20:10:06.927Z",
      "updated_at": "2022-11-04T20:10:06.927Z"
    }
  ],
  "meta": {
    "page": {
      "number": 1,
      "size": 10,
      "total": 100
    }
  }
}

Changes