Sign in
Catalog AI Models

Create AI Model

Changed on

Creates a bare AI Model. No target_models are accepted here — create the version separately with POST /ai-models/{aiModelId}/versions.

post/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

Request body

namestring required

The machine name of the AI Model that uniquely identifies it within the catalog.

display_namestring required

The display name of the AI Model.

descriptionstring nullable

Optionally provide a description of the AI Model.

labelsLabels

Labels store metadata of an entity that can be used for filtering an entity list or for searching across entity types.

Keys must be of length 1-63 characters, and cannot start with "kong", "konnect", "mesh", "kic", or "_".

Example request

{
  "name": "my-ai-model",
  "display_name": "My AI Model",
  "description": "Customer support triage model",
  "labels": {
    "env": "test"
  }
}

Response

The created AI Model

idstring uuid required

The unique identifier of the AI Model.

namestring required

The machine name of the AI Model that uniquely identifies it within the catalog.

display_namestring required

The display name of the AI Model.

descriptionstring nullable required

A description of the AI Model.

labelsLabels required

Labels store metadata of an entity that can be used for filtering an entity list or for searching across entity types.

Keys must be of length 1-63 characters, and cannot start with "kong", "konnect", "mesh", "kic", or "_".

managed_byManagedBy required

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

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

created_atstring date-time required

An ISO-8601 timestamp representation of entity creation date.

updated_atstring date-time required

An ISO-8601 timestamp representation of entity update date.

Example response

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

Changes