Skip to main content
GET
/
v2.0
/
largelanguagemodels
Get large language models
curl --request GET \
  --url https://api-trial.cognigy.ai/new/v2.0/largelanguagemodels \
  --header 'X-API-Key: <api-key>'
{
  "items": [
    {
      "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",
      "isCustomModel": true,
      "openAI": {
        "customModel": "gpt-4-32k-0613"
      },
      "anthropic": {
        "customModel": "claude-opus-4-0"
      },
      "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>"
      },
      "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>"
}

Authorizations

ā€‹
X-API-Key
string
header
required

Supply the API Key in the HTTP-Header

Headers

ā€‹
Accept
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

Query Parameters

ā€‹
projectId
string

The unique identifier for the Project.

Required string length: 24
Pattern: ^[a-z0-9]{24}$
ā€‹
filter
string

Filter records by specific field eg:name.

ā€‹
limit
integer

The maximum number of items to return. Use this parameter to control page size. The default value is 25, and the maximum permitted value is 100.

Required range: 1 <= x <= 100
ā€‹
skip
integer

The number of items to skip before returning the results. Use this parameter with limit for offset-based pagination. The default value is 0.

Required range: x >= 0
ā€‹
sort
string

The order in which results are returned. Set a sorting rule in the format field:direction, where direction can be asc for ascending order or desc for descending order. For example, name:asc sorts by name in ascending order.

Minimum string length: 1
ā€‹
next
string

The cursor that points to the next page of results. Use the nextCursor value returned in a previous response to request the next set of items.

Required string length: 24
ā€‹
previous
string

The cursor that points to the previous page of results. Use the previousCursor value returned in a previous response to request the previous set of items.

Required string length: 24
ā€‹
resourceLevel
enum<string>
default:project

Scope of the resource (global "organisation" or project). General scope of the resource.

Available options:
organisation,
project

Response

Returns array of large language model metadata objects.

ā€‹
items
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.

ā€‹
total
integer
Example:

1

ā€‹
nextCursor
string | null
Required string length: 24
Pattern: ^[a-z0-9]{24}$
ā€‹
previousCursor
string | null
Required string length: 24
Pattern: ^[a-z0-9]{24}$