Sign in

v1

latestOpenAPI 3.0.0Cognigy Proprietary License2026-07-2239524.1 MB
Large Language Models

Create a large language model

Creates a large language model. The large language model can have the following scopes:

  • Project (resourceLevel: 'project')
  • Global (resourceLevel: 'organisation')

Depending on the scope, different fields are required or must be excluded:

  • Project-level resources: projectId is required.
  • Global resources: isDefault and fallback must be excluded.
post/v2.0/largelanguagemodels

Headers

Accept'application/json' | 'application/hal+json' | 'application/xml' | 'text/xml' | 'text/csv'

The Accept header specifies the media type that the client expects in the response. Available options: application/json, application/hal+json, application/xml, text/xml, text/csv. The default value is application/json.

Request body

OR

Example request

{
  "name": "Large language model for customer service",
  "description": "Large language model for customer-facing AI Agents.",
  "isCustomModel": true,
  "openAI": {
    "customModel": "gpt-4-32k-0613"
  },
  "anthropic": {
    "customModel": "claude-sonnet-4-6"
  },
  "alephAlpha": {
    "customModel": "luminous-003",
    "baseCustomUrl": "https://api.aleph-alpha.com"
  },
  "openAICompatible": {
    "customModel": "luminous-003",
    "baseCustomUrl": "https://own-llm-deployment.company.com/openai/v1",
    "customAuthHeader": "Ocp-Apim-Subscription-Key"
  },
  "assignedToProjects": [
    "68edf5dd4c931f68d31111",
    "690b02fc100e454245adde111",
    "68e6eda61ff68d2111"
  ]
}

Response

Returns large language model metadata object.

OR
OR

Example response

{
  "name": "Large language model for customer service",
  "description": "Large language model for customer-facing AI Agents.",
  "isCustomModel": true,
  "openAI": {
    "customModel": "gpt-4-32k-0613"
  },
  "anthropic": {
    "customModel": "claude-sonnet-4-6"
  },
  "alephAlpha": {
    "customModel": "luminous-003",
    "baseCustomUrl": "https://api.aleph-alpha.com"
  },
  "openAICompatible": {
    "customModel": "luminous-003",
    "baseCustomUrl": "https://own-llm-deployment.company.com/openai/v1",
    "customAuthHeader": "Ocp-Apim-Subscription-Key"
  },
  "assignedToProjects": [
    "68edf5dd4c931f68d31111",
    "690b02fc100e454245adde111",
    "68e6eda61ff68d2111"
  ],
  "createdAt": 1694518620,
  "lastChanged": 1694518620
}