Get large language models - Cognigy Documentation

Documentation Index

Fetch the complete documentation index at: /llms.txt

Use this file to discover all available pages before exploring further.

GET

/ v2.0 /largelanguagemodels

Try it

Get large language models

cURL

curl --request GET \
  --url 'https://api-trial.cognigy.ai/new/v2.0/largelanguagemodels?resourceLevel=project' \
  --header 'X-API-Key: <api-key>'

import requests

url = "https://api-trial.cognigy.ai/new/v2.0/largelanguagemodels?resourceLevel=project"

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/largelanguagemodels?resourceLevel=project', 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/largelanguagemodels?resourceLevel=project",\
  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/largelanguagemodels?resourceLevel=project"

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))
}

HttpResponse<String> response = Unirest.get("https://api-trial.cognigy.ai/new/v2.0/largelanguagemodels?resourceLevel=project")
  .header("X-API-Key", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api-trial.cognigy.ai/new/v2.0/largelanguagemodels?resourceLevel=project")

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

Status Codes

• 200
• 400
• 401
• 402
• 403
• 404
• 405
• 409
• 413
• 500
• 501
• 502
• 503
• 504

Example Responses

Successful Response

{
  "items": [
    {
      "name": "Large language model for customer service",
      "connectionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "description": "Large language model for customer-facing AI Agents.",
      "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>"
        ]
      },
      "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>"
            ]
          }
        }
      ],
      "referenceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "_id": "<string>",
      "createdAt": 1694518620,
      "lastChanged": 1694518620,
      "createdBy": "<string>",
      "lastChangedBy": "<string>"
    }
  ],
  "total": 1,
  "nextCursor": "<string>",
  "previousCursor": "<string>"
}

Error Response

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