Large Language Models

Get a large language model together with its credentials summary and Gateway Config Set status (EXPERIMENTAL)

Experimental and temporary. Introduced for the C26 unified LLM configuration page. The internal model is expected to change once all large language models are managed as Gateway Config Sets; this route may change or be removed without a major version bump.

Composes GET /v2.0/largelanguagemodels/{id} with a lookup of the large language model’s underlying credentials (Connection), so the frontend does not have to make two round-trips (and does not have to translate the large language model’s connectionId, a Connection referenceId, into the Mongo _id the plain GET /v2.0/connections/{id} route requires). Credential values are never returned, masked or otherwise — only {referenceId, name, type}. configSet reports whether a Gateway Config Set exists for this large language model, not its live sync health (staleness, retry count, last error are never returned).

Requires both largeLanguageModels.read and connections.read — a user with only one of the two gets 403 here, even though the plain GET /v2.0/largelanguagemodels/{id} would allow it, because this response discloses Connection metadata.

GET

v2.0

llmconfigurations

{largeLanguageModelId}

Get a large language model together with its credentials summary and Gateway Config Set status (EXPERIMENTAL)

curl --request GET \
  --url https://api-trial.cognigy.ai/new/v2.0/llmconfigurations/{largeLanguageModelId} \
  --header 'X-API-Key: <api-key>'

import requests

url = "https://api-trial.cognigy.ai/new/v2.0/llmconfigurations/{largeLanguageModelId}"

headers = {"X-API-Key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

fetch('https://api-trial.cognigy.ai/new/v2.0/llmconfigurations/{largeLanguageModelId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api-trial.cognigy.ai/new/v2.0/llmconfigurations/{largeLanguageModelId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-API-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api-trial.cognigy.ai/new/v2.0/llmconfigurations/{largeLanguageModelId}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api-trial.cognigy.ai/new/v2.0/llmconfigurations/{largeLanguageModelId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "largeLanguageModel": {
    "name": "Large language model for customer service",
    "modelType": "gpt-3.5-turbo",
    "provider": "azureOpenAI",
    "connectionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "description": "Large language model for customer-facing AI Agents.",
    "modelGroup": "chat",
    "apiType": "chatCompletion",
    "isCustomModel": true,
    "openAI": {
      "customModel": "gpt-4-32k-0613"
    },
    "anthropic": {
      "customModel": "claude-sonnet-4-6"
    },
    "azureOpenAI": {
      "resourceName": "<string>",
      "deploymentName": "<string>",
      "apiVersion": "<string>",
      "baseCustomUrl": [
        "https://<resourceName>.openai.azure.com/openai/deployments/<deploymentName>/chat/completions?api-version=<apiVersion>",
        "https://<resourceName>.openai.azure.com/openai/deployments/<deploymentName>/completions?api-version=<apiVersion>",
        "https://<resourceName>.openai.azure.com/openai/deployments/<deploymentName>/embeddings?api-version=<apiVersion>"
      ],
      "useDeploymentNameAsModel": true
    },
    "googleVertexAI": {
      "location": "<string>",
      "apiEndpoint": "<string>",
      "publisher": "<string>"
    },
    "googleGemini": {
      "location": "<string>"
    },
    "googleGenAI": {
      "location": "<string>"
    },
    "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"
    },
    "resourceLevel": "project",
    "isDefault": false,
    "fallbacks": [
      {
        "isFallbackEnabled": true,
        "fallbackLLMReferenceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "immediateFallBack": {
          "failedRequests": 123,
          "durationInMinutes": 123,
          "emailNotificationList": [
            "<string>"
          ]
        }
      }
    ],
    "isInPlatformLlm": false,
    "useCases": [
      "<string>"
    ],
    "referenceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "_id": "<string>",
    "createdAt": 1694518620,
    "lastChanged": 1694518620,
    "createdBy": "<string>",
    "lastChangedBy": "<string>"
  },
  "credentials": {
    "referenceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "type": "<string>"
  },
  "configSet": {
    "status": "synced",
    "configSetId": "<string>",
    "skippedReason": "providerUnsupported"
  }
}

{
  "type": "Bad Request",
  "title": "Bad Request Error",
  "status": 400,
  "detail": "Validation failed. Missing payload.",
  "instance": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432",
  "code": 1000,
  "traceId": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f",
  "details": {}
}

{
  "type": "Unauthorized",
  "title": "Unauthorized Error",
  "status": 401,
  "detail": "<string>",
  "instance": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432",
  "code": 401,
  "traceId": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f",
  "details": {}
}

{
  "type": "Payment Required",
  "title": "Payment Required Error",
  "status": 402,
  "detail": "Validation failed. Missing payload.",
  "instance": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432",
  "code": 402,
  "traceId": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f",
  "details": {}
}

{
  "type": "Forbidden",
  "title": "Forbidden Error",
  "status": 403,
  "detail": "<string>",
  "instance": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432",
  "code": 1000,
  "traceId": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f",
  "details": {}
}

{
  "type": "Not Found",
  "title": "Not Found Error",
  "status": 404,
  "detail": "<string>",
  "instance": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432",
  "code": 1000,
  "traceId": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f",
  "details": {},
  "logLevel": "error"
}

{
  "type": "Method Not Allowed",
  "title": "Method Not Allowed Error",
  "status": 405,
  "detail": "<string>",
  "instance": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432",
  "code": 1000,
  "traceId": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f",
  "details": {}
}

{
  "type": "Conflict",
  "title": "Conflict Error",
  "status": 409,
  "detail": "<string>",
  "instance": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432",
  "code": 1004,
  "traceId": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f",
  "details": {}
}

{
  "type": "Payload Too Large",
  "title": "Payload Too Large Error",
  "status": 413,
  "detail": "<string>",
  "instance": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432",
  "code": 1000,
  "traceId": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f",
  "details": {}
}

{
  "type": "Internal Server Error",
  "title": "Internal Server Error",
  "status": 500,
  "detail": "<string>",
  "instance": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432",
  "code": 1000,
  "traceId": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f",
  "details": {}
}

{
  "type": "Not Implemented",
  "title": "Not Implemented Error",
  "status": 501,
  "detail": "<string>",
  "instance": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432",
  "code": 1009,
  "traceId": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f",
  "details": {}
}

{
  "type": "Bad Gateway",
  "title": "Bad Gateway Error",
  "status": 502,
  "detail": "<string>",
  "instance": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432",
  "code": 1000,
  "traceId": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f",
  "details": {}
}

{
  "type": "Service Unavailable",
  "title": "Service Unavailable Error",
  "status": 503,
  "detail": "<string>",
  "instance": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432",
  "code": 503,
  "traceId": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f",
  "details": {}
}

{
  "type": "Gateway Timeout",
  "title": "Gateway Timeout Error",
  "status": 504,
  "detail": "<string>",
  "instance": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432",
  "code": 1000,
  "traceId": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f",
  "details": {}
}

Authorizations

X-API-Key

string

header

required

Supply the API Key in the HTTP-Header

Headers

enum<string>

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.

Available options:

application/json,

application/hal+json,

application/xml,

text/xml,

text/csv

Path Parameters

largeLanguageModelId

string

required

The unique identifier for the large language model.

Required string length: 24

Pattern: ^[a-z0-9]{24}$

Response

Returns the large language model, its credentials summary (if resolvable), and the Config Set existence status.

largeLanguageModel

object

The IEntityMeta defines meta information every entity within the system has. These are dates when a resource was created and modified as well as information about the user who initially created a resource and who modified it the last time.

Option 1
Option 2

Show child attributes

credentials

object

Never includes _id or credential values (masked or otherwise) — identical in shape to ILlmConfigurationCredentialsSummary_2_0. Masked-field viewing is out of scope for this route; use GET /v2.0/connections/{id} for that.

Show child attributes

configSet

object

Whether a Gateway Config Set was created/updated for this large language model, or why it was skipped.

Show child attributes

Last modified on September 16, 2026

Get a large language model together with its credentials summary and Gateway Config Set status (EXPERIMENTAL)

curl --request GET \
  --url https://api-trial.cognigy.ai/new/v2.0/llmconfigurations/{largeLanguageModelId} \
  --header 'X-API-Key: <api-key>'

import requests

url = "https://api-trial.cognigy.ai/new/v2.0/llmconfigurations/{largeLanguageModelId}"

headers = {"X-API-Key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

fetch('https://api-trial.cognigy.ai/new/v2.0/llmconfigurations/{largeLanguageModelId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api-trial.cognigy.ai/new/v2.0/llmconfigurations/{largeLanguageModelId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-API-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api-trial.cognigy.ai/new/v2.0/llmconfigurations/{largeLanguageModelId}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api-trial.cognigy.ai/new/v2.0/llmconfigurations/{largeLanguageModelId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "largeLanguageModel": {
    "name": "Large language model for customer service",
    "modelType": "gpt-3.5-turbo",
    "provider": "azureOpenAI",
    "connectionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "description": "Large language model for customer-facing AI Agents.",
    "modelGroup": "chat",
    "apiType": "chatCompletion",
    "isCustomModel": true,
    "openAI": {
      "customModel": "gpt-4-32k-0613"
    },
    "anthropic": {
      "customModel": "claude-sonnet-4-6"
    },
    "azureOpenAI": {
      "resourceName": "<string>",
      "deploymentName": "<string>",
      "apiVersion": "<string>",
      "baseCustomUrl": [
        "https://<resourceName>.openai.azure.com/openai/deployments/<deploymentName>/chat/completions?api-version=<apiVersion>",
        "https://<resourceName>.openai.azure.com/openai/deployments/<deploymentName>/completions?api-version=<apiVersion>",
        "https://<resourceName>.openai.azure.com/openai/deployments/<deploymentName>/embeddings?api-version=<apiVersion>"
      ],
      "useDeploymentNameAsModel": true
    },
    "googleVertexAI": {
      "location": "<string>",
      "apiEndpoint": "<string>",
      "publisher": "<string>"
    },
    "googleGemini": {
      "location": "<string>"
    },
    "googleGenAI": {
      "location": "<string>"
    },
    "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"
    },
    "resourceLevel": "project",
    "isDefault": false,
    "fallbacks": [
      {
        "isFallbackEnabled": true,
        "fallbackLLMReferenceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "immediateFallBack": {
          "failedRequests": 123,
          "durationInMinutes": 123,
          "emailNotificationList": [
            "<string>"
          ]
        }
      }
    ],
    "isInPlatformLlm": false,
    "useCases": [
      "<string>"
    ],
    "referenceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "_id": "<string>",
    "createdAt": 1694518620,
    "lastChanged": 1694518620,
    "createdBy": "<string>",
    "lastChangedBy": "<string>"
  },
  "credentials": {
    "referenceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "type": "<string>"
  },
  "configSet": {
    "status": "synced",
    "configSetId": "<string>",
    "skippedReason": "providerUnsupported"
  }
}

{
  "type": "Bad Request",
  "title": "Bad Request Error",
  "status": 400,
  "detail": "Validation failed. Missing payload.",
  "instance": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432",
  "code": 1000,
  "traceId": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f",
  "details": {}
}

{
  "type": "Unauthorized",
  "title": "Unauthorized Error",
  "status": 401,
  "detail": "<string>",
  "instance": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432",
  "code": 401,
  "traceId": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f",
  "details": {}
}

{
  "type": "Payment Required",
  "title": "Payment Required Error",
  "status": 402,
  "detail": "Validation failed. Missing payload.",
  "instance": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432",
  "code": 402,
  "traceId": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f",
  "details": {}
}

{
  "type": "Forbidden",
  "title": "Forbidden Error",
  "status": 403,
  "detail": "<string>",
  "instance": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432",
  "code": 1000,
  "traceId": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f",
  "details": {}
}

{
  "type": "Not Found",
  "title": "Not Found Error",
  "status": 404,
  "detail": "<string>",
  "instance": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432",
  "code": 1000,
  "traceId": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f",
  "details": {},
  "logLevel": "error"
}

{
  "type": "Method Not Allowed",
  "title": "Method Not Allowed Error",
  "status": 405,
  "detail": "<string>",
  "instance": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432",
  "code": 1000,
  "traceId": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f",
  "details": {}
}

{
  "type": "Conflict",
  "title": "Conflict Error",
  "status": 409,
  "detail": "<string>",
  "instance": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432",
  "code": 1004,
  "traceId": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f",
  "details": {}
}

{
  "type": "Payload Too Large",
  "title": "Payload Too Large Error",
  "status": 413,
  "detail": "<string>",
  "instance": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432",
  "code": 1000,
  "traceId": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f",
  "details": {}
}

{
  "type": "Internal Server Error",
  "title": "Internal Server Error",
  "status": 500,
  "detail": "<string>",
  "instance": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432",
  "code": 1000,
  "traceId": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f",
  "details": {}
}

{
  "type": "Not Implemented",
  "title": "Not Implemented Error",
  "status": 501,
  "detail": "<string>",
  "instance": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432",
  "code": 1009,
  "traceId": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f",
  "details": {}
}

{
  "type": "Bad Gateway",
  "title": "Bad Gateway Error",
  "status": 502,
  "detail": "<string>",
  "instance": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432",
  "code": 1000,
  "traceId": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f",
  "details": {}
}

{
  "type": "Service Unavailable",
  "title": "Service Unavailable Error",
  "status": 503,
  "detail": "<string>",
  "instance": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432",
  "code": 503,
  "traceId": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f",
  "details": {}
}

{
  "type": "Gateway Timeout",
  "title": "Gateway Timeout Error",
  "status": 504,
  "detail": "<string>",
  "instance": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432",
  "code": 1000,
  "traceId": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f",
  "details": {}
}

Overview

Core Resources

Simulator

Logs

Get a large language model together with its credentials summary and Gateway Config Set status (EXPERIMENTAL)

Authorizations

Headers

Path Parameters

Response