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:
projectIdis required. - Global resources:
isDefaultandfallbackmust be excluded.
curl --request POST \
--url https://api-trial.cognigy.ai/new/v2.0/largelanguagemodels \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"name": "Large language model for customer service",
"connectionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"resourceLevel": "organisation",
"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>"
],
"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"
},
"assignedToProjects": [
"68edf5dd4c931f68d31111",
"690b02fc100e454245adde111",
"68e6eda61ff68d2111"
]
}
'import requests
url = "https://api-trial.cognigy.ai/new/v2.0/largelanguagemodels"
payload = {
"name": "Large language model for customer service",
"connectionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"resourceLevel": "organisation",
"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>"],
"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"
},
"assignedToProjects": ["68edf5dd4c931f68d31111", "690b02fc100e454245adde111", "68e6eda61ff68d2111"]
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: 'Large language model for customer service',
connectionId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
resourceLevel: 'organisation',
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>'
],
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'
},
assignedToProjects: ['68edf5dd4c931f68d31111', '690b02fc100e454245adde111', '68e6eda61ff68d2111']
})
};
fetch('https://api-trial.cognigy.ai/new/v2.0/largelanguagemodels', 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",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => 'Large language model for customer service',
'connectionId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'resourceLevel' => 'organisation',
'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>'
],
'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'
],
'assignedToProjects' => [
'68edf5dd4c931f68d31111',
'690b02fc100e454245adde111',
'68e6eda61ff68d2111'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"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"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api-trial.cognigy.ai/new/v2.0/largelanguagemodels"
payload := strings.NewReader("{\n \"name\": \"Large language model for customer service\",\n \"connectionId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"resourceLevel\": \"organisation\",\n \"description\": \"Large language model for customer-facing AI Agents.\",\n \"isCustomModel\": true,\n \"openAI\": {\n \"customModel\": \"gpt-4-32k-0613\"\n },\n \"anthropic\": {\n \"customModel\": \"claude-sonnet-4-6\"\n },\n \"azureOpenAI\": {\n \"resourceName\": \"<string>\",\n \"deploymentName\": \"<string>\",\n \"apiVersion\": \"<string>\",\n \"baseCustomUrl\": [\n \"https://<resourceName>.openai.azure.com/openai/deployments/<deploymentName>/chat/completions?api-version=<apiVersion>\",\n \"https://<resourceName>.openai.azure.com/openai/deployments/<deploymentName>/completions?api-version=<apiVersion>\",\n \"https://<resourceName>.openai.azure.com/openai/deployments/<deploymentName>/embeddings?api-version=<apiVersion>\"\n ],\n \"useDeploymentNameAsModel\": true\n },\n \"googleVertexAI\": {\n \"location\": \"<string>\",\n \"apiEndpoint\": \"<string>\",\n \"publisher\": \"<string>\"\n },\n \"googleGemini\": {\n \"location\": \"<string>\"\n },\n \"googleGenAI\": {\n \"location\": \"<string>\"\n },\n \"alephAlpha\": {\n \"customModel\": \"luminous-003\",\n \"baseCustomUrl\": \"https://api.aleph-alpha.com\"\n },\n \"openAICompatible\": {\n \"customModel\": \"luminous-003\",\n \"baseCustomUrl\": \"https://own-llm-deployment.company.com/openai/v1\",\n \"customAuthHeader\": \"Ocp-Apim-Subscription-Key\"\n },\n \"assignedToProjects\": [\n \"68edf5dd4c931f68d31111\",\n \"690b02fc100e454245adde111\",\n \"68e6eda61ff68d2111\"\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api-trial.cognigy.ai/new/v2.0/largelanguagemodels")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"Large language model for customer service\",\n \"connectionId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"resourceLevel\": \"organisation\",\n \"description\": \"Large language model for customer-facing AI Agents.\",\n \"isCustomModel\": true,\n \"openAI\": {\n \"customModel\": \"gpt-4-32k-0613\"\n },\n \"anthropic\": {\n \"customModel\": \"claude-sonnet-4-6\"\n },\n \"azureOpenAI\": {\n \"resourceName\": \"<string>\",\n \"deploymentName\": \"<string>\",\n \"apiVersion\": \"<string>\",\n \"baseCustomUrl\": [\n \"https://<resourceName>.openai.azure.com/openai/deployments/<deploymentName>/chat/completions?api-version=<apiVersion>\",\n \"https://<resourceName>.openai.azure.com/openai/deployments/<deploymentName>/completions?api-version=<apiVersion>\",\n \"https://<resourceName>.openai.azure.com/openai/deployments/<deploymentName>/embeddings?api-version=<apiVersion>\"\n ],\n \"useDeploymentNameAsModel\": true\n },\n \"googleVertexAI\": {\n \"location\": \"<string>\",\n \"apiEndpoint\": \"<string>\",\n \"publisher\": \"<string>\"\n },\n \"googleGemini\": {\n \"location\": \"<string>\"\n },\n \"googleGenAI\": {\n \"location\": \"<string>\"\n },\n \"alephAlpha\": {\n \"customModel\": \"luminous-003\",\n \"baseCustomUrl\": \"https://api.aleph-alpha.com\"\n },\n \"openAICompatible\": {\n \"customModel\": \"luminous-003\",\n \"baseCustomUrl\": \"https://own-llm-deployment.company.com/openai/v1\",\n \"customAuthHeader\": \"Ocp-Apim-Subscription-Key\"\n },\n \"assignedToProjects\": [\n \"68edf5dd4c931f68d31111\",\n \"690b02fc100e454245adde111\",\n \"68e6eda61ff68d2111\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-trial.cognigy.ai/new/v2.0/largelanguagemodels")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"Large language model for customer service\",\n \"connectionId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"resourceLevel\": \"organisation\",\n \"description\": \"Large language model for customer-facing AI Agents.\",\n \"isCustomModel\": true,\n \"openAI\": {\n \"customModel\": \"gpt-4-32k-0613\"\n },\n \"anthropic\": {\n \"customModel\": \"claude-sonnet-4-6\"\n },\n \"azureOpenAI\": {\n \"resourceName\": \"<string>\",\n \"deploymentName\": \"<string>\",\n \"apiVersion\": \"<string>\",\n \"baseCustomUrl\": [\n \"https://<resourceName>.openai.azure.com/openai/deployments/<deploymentName>/chat/completions?api-version=<apiVersion>\",\n \"https://<resourceName>.openai.azure.com/openai/deployments/<deploymentName>/completions?api-version=<apiVersion>\",\n \"https://<resourceName>.openai.azure.com/openai/deployments/<deploymentName>/embeddings?api-version=<apiVersion>\"\n ],\n \"useDeploymentNameAsModel\": true\n },\n \"googleVertexAI\": {\n \"location\": \"<string>\",\n \"apiEndpoint\": \"<string>\",\n \"publisher\": \"<string>\"\n },\n \"googleGemini\": {\n \"location\": \"<string>\"\n },\n \"googleGenAI\": {\n \"location\": \"<string>\"\n },\n \"alephAlpha\": {\n \"customModel\": \"luminous-003\",\n \"baseCustomUrl\": \"https://api.aleph-alpha.com\"\n },\n \"openAICompatible\": {\n \"customModel\": \"luminous-003\",\n \"baseCustomUrl\": \"https://own-llm-deployment.company.com/openai/v1\",\n \"customAuthHeader\": \"Ocp-Apim-Subscription-Key\"\n },\n \"assignedToProjects\": [\n \"68edf5dd4c931f68d31111\",\n \"690b02fc100e454245adde111\",\n \"68e6eda61ff68d2111\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"name": "Large language model for customer service",
"connectionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"resourceLevel": "organisation",
"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>"
],
"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"
},
"assignedToProjects": [
"68edf5dd4c931f68d31111",
"690b02fc100e454245adde111",
"68e6eda61ff68d2111"
],
"referenceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"_id": "<string>",
"createdAt": 1694518620,
"lastChanged": 1694518620,
"createdBy": "<string>",
"lastChangedBy": "<string>"
}{
"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
Supply the API Key in the HTTP-Header
Headers
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.
application/json, application/hal+json, application/xml, text/xml, text/csv Body
- Global large language model resource
- Project level large language model resource
"Large language model for customer service"
gpt-3.5-turbo, gpt-3.5-turbo-instruct, gpt-4, gpt-4o, gpt-4o-mini, gpt-4.1, gpt-4.1-mini, gpt-4.1-nano, gpt-5, gpt-5-nano, gpt-5-mini, gpt-5.4-mini, gpt-5.4-nano, gpt-5.1, gpt-5.2, gpt-5.4, gpt-5.5, gpt-5.6-sol, gpt-5.6-terra, gpt-5.6-luna, text-embedding-ada-002, luminous-extended-control, luminous-embedding-128, Pharia-1-Embedding-4608, gemini-embedding-001, gemini-embedding-2, claude-3-opus-20240229, claude-sonnet-4-6, claude-sonnet-5, claude-opus-4-7, claude-opus-4-8, custom-model, custom-embedding-model, gemini-2.5-pro, gemini-2.5-flash, gemini-2.5-flash-lite, gemini-3.1-pro-preview, gemini-3-flash-preview, gemini-3.5-flash, gemini-3.6-flash, gemini-3.1-flash-lite-preview, gemini-3.1-flash-lite, gemini-3.5-flash-lite, mistral-large-2411, mistral-small-2503, pixtral-large-2411, pixtral-12b-2409 azureOpenAI, openAI, anthropic, googleVertexAI, googleGemini, googleGenAI, alephAlpha, awsBedrock, mistral The identifier for the large language model connection.
36Scope for globally scoped resources.
organisation "Large language model for customer-facing AI Agents."
chat, completion, embedding The API type for chat models. Defaults to chatCompletion when not specified. The responses API is only supported for OpenAI, Azure OpenAI, and OpenAI Compatible providers.
chatCompletion, responses true
Metadata for OpenAI large language models.
Show child attributes
Show child attributes
Metadata for Anthropic large language models.
Show child attributes
Show child attributes
Metadata for Azure OpenAI large language models.
Show child attributes
Show child attributes
Metadata for Google Vertex AI large language models.
Show child attributes
Show child attributes
Metadata for Google Gemini large language models.
Show child attributes
Show child attributes
Google GenAI specific meta data
Show child attributes
Show child attributes
Metadata for Aleph Alpha large language models.
Show child attributes
Show child attributes
Metadata for OpenAI-compatible large language models.
Show child attributes
Show child attributes
MongoDB ObjectId representing a project
[ "68edf5dd4c931f68d31111", "690b02fc100e454245adde111", "68e6eda61ff68d2111" ]
Response
Returns large language model metadata object.
- Option 1
- Option 2
- Option 3
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.
"Large language model for customer service"
gpt-3.5-turbo, gpt-3.5-turbo-instruct, gpt-4, gpt-4o, gpt-4o-mini, gpt-4.1, gpt-4.1-mini, gpt-4.1-nano, gpt-5, gpt-5-nano, gpt-5-mini, gpt-5.4-mini, gpt-5.4-nano, gpt-5.1, gpt-5.2, gpt-5.4, gpt-5.5, gpt-5.6-sol, gpt-5.6-terra, gpt-5.6-luna, text-embedding-ada-002, luminous-extended-control, luminous-embedding-128, Pharia-1-Embedding-4608, gemini-embedding-001, gemini-embedding-2, claude-3-opus-20240229, claude-sonnet-4-6, claude-sonnet-5, claude-opus-4-7, claude-opus-4-8, custom-model, custom-embedding-model, gemini-2.5-pro, gemini-2.5-flash, gemini-2.5-flash-lite, gemini-3.1-pro-preview, gemini-3-flash-preview, gemini-3.5-flash, gemini-3.6-flash, gemini-3.1-flash-lite-preview, gemini-3.1-flash-lite, gemini-3.5-flash-lite, mistral-large-2411, mistral-small-2503, pixtral-large-2411, pixtral-12b-2409 azureOpenAI, openAI, anthropic, googleVertexAI, googleGemini, googleGenAI, alephAlpha, awsBedrock, mistral The identifier for the large language model connection.
36Scope for globally scoped resources.
organisation "Large language model for customer-facing AI Agents."
chat, completion, embedding The API type for chat models. Defaults to chatCompletion when not specified. The responses API is only supported for OpenAI, Azure OpenAI, and OpenAI Compatible providers.
chatCompletion, responses true
Metadata for OpenAI large language models.
Show child attributes
Show child attributes
Metadata for Anthropic large language models.
Show child attributes
Show child attributes
Metadata for Azure OpenAI large language models.
Show child attributes
Show child attributes
Metadata for Google Vertex AI large language models.
Show child attributes
Show child attributes
Metadata for Google Gemini large language models.
Show child attributes
Show child attributes
Google GenAI specific meta data
Show child attributes
Show child attributes
Metadata for Aleph Alpha large language models.
Show child attributes
Show child attributes
Metadata for OpenAI-compatible large language models.
Show child attributes
Show child attributes
MongoDB ObjectId representing a project
[ "68edf5dd4c931f68d31111", "690b02fc100e454245adde111", "68e6eda61ff68d2111" ]
The reference ID of the large language model.
24^[a-z0-9]{24}$Unix-timestamp
0 <= x <= 21474836471694518620
Unix-timestamp
0 <= x <= 21474836471694518620
24^[a-z0-9]{24}$24^[a-z0-9]{24}$curl --request POST \
--url https://api-trial.cognigy.ai/new/v2.0/largelanguagemodels \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"name": "Large language model for customer service",
"connectionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"resourceLevel": "organisation",
"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>"
],
"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"
},
"assignedToProjects": [
"68edf5dd4c931f68d31111",
"690b02fc100e454245adde111",
"68e6eda61ff68d2111"
]
}
'import requests
url = "https://api-trial.cognigy.ai/new/v2.0/largelanguagemodels"
payload = {
"name": "Large language model for customer service",
"connectionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"resourceLevel": "organisation",
"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>"],
"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"
},
"assignedToProjects": ["68edf5dd4c931f68d31111", "690b02fc100e454245adde111", "68e6eda61ff68d2111"]
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: 'Large language model for customer service',
connectionId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
resourceLevel: 'organisation',
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>'
],
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'
},
assignedToProjects: ['68edf5dd4c931f68d31111', '690b02fc100e454245adde111', '68e6eda61ff68d2111']
})
};
fetch('https://api-trial.cognigy.ai/new/v2.0/largelanguagemodels', 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",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => 'Large language model for customer service',
'connectionId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'resourceLevel' => 'organisation',
'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>'
],
'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'
],
'assignedToProjects' => [
'68edf5dd4c931f68d31111',
'690b02fc100e454245adde111',
'68e6eda61ff68d2111'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"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"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api-trial.cognigy.ai/new/v2.0/largelanguagemodels"
payload := strings.NewReader("{\n \"name\": \"Large language model for customer service\",\n \"connectionId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"resourceLevel\": \"organisation\",\n \"description\": \"Large language model for customer-facing AI Agents.\",\n \"isCustomModel\": true,\n \"openAI\": {\n \"customModel\": \"gpt-4-32k-0613\"\n },\n \"anthropic\": {\n \"customModel\": \"claude-sonnet-4-6\"\n },\n \"azureOpenAI\": {\n \"resourceName\": \"<string>\",\n \"deploymentName\": \"<string>\",\n \"apiVersion\": \"<string>\",\n \"baseCustomUrl\": [\n \"https://<resourceName>.openai.azure.com/openai/deployments/<deploymentName>/chat/completions?api-version=<apiVersion>\",\n \"https://<resourceName>.openai.azure.com/openai/deployments/<deploymentName>/completions?api-version=<apiVersion>\",\n \"https://<resourceName>.openai.azure.com/openai/deployments/<deploymentName>/embeddings?api-version=<apiVersion>\"\n ],\n \"useDeploymentNameAsModel\": true\n },\n \"googleVertexAI\": {\n \"location\": \"<string>\",\n \"apiEndpoint\": \"<string>\",\n \"publisher\": \"<string>\"\n },\n \"googleGemini\": {\n \"location\": \"<string>\"\n },\n \"googleGenAI\": {\n \"location\": \"<string>\"\n },\n \"alephAlpha\": {\n \"customModel\": \"luminous-003\",\n \"baseCustomUrl\": \"https://api.aleph-alpha.com\"\n },\n \"openAICompatible\": {\n \"customModel\": \"luminous-003\",\n \"baseCustomUrl\": \"https://own-llm-deployment.company.com/openai/v1\",\n \"customAuthHeader\": \"Ocp-Apim-Subscription-Key\"\n },\n \"assignedToProjects\": [\n \"68edf5dd4c931f68d31111\",\n \"690b02fc100e454245adde111\",\n \"68e6eda61ff68d2111\"\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api-trial.cognigy.ai/new/v2.0/largelanguagemodels")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"Large language model for customer service\",\n \"connectionId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"resourceLevel\": \"organisation\",\n \"description\": \"Large language model for customer-facing AI Agents.\",\n \"isCustomModel\": true,\n \"openAI\": {\n \"customModel\": \"gpt-4-32k-0613\"\n },\n \"anthropic\": {\n \"customModel\": \"claude-sonnet-4-6\"\n },\n \"azureOpenAI\": {\n \"resourceName\": \"<string>\",\n \"deploymentName\": \"<string>\",\n \"apiVersion\": \"<string>\",\n \"baseCustomUrl\": [\n \"https://<resourceName>.openai.azure.com/openai/deployments/<deploymentName>/chat/completions?api-version=<apiVersion>\",\n \"https://<resourceName>.openai.azure.com/openai/deployments/<deploymentName>/completions?api-version=<apiVersion>\",\n \"https://<resourceName>.openai.azure.com/openai/deployments/<deploymentName>/embeddings?api-version=<apiVersion>\"\n ],\n \"useDeploymentNameAsModel\": true\n },\n \"googleVertexAI\": {\n \"location\": \"<string>\",\n \"apiEndpoint\": \"<string>\",\n \"publisher\": \"<string>\"\n },\n \"googleGemini\": {\n \"location\": \"<string>\"\n },\n \"googleGenAI\": {\n \"location\": \"<string>\"\n },\n \"alephAlpha\": {\n \"customModel\": \"luminous-003\",\n \"baseCustomUrl\": \"https://api.aleph-alpha.com\"\n },\n \"openAICompatible\": {\n \"customModel\": \"luminous-003\",\n \"baseCustomUrl\": \"https://own-llm-deployment.company.com/openai/v1\",\n \"customAuthHeader\": \"Ocp-Apim-Subscription-Key\"\n },\n \"assignedToProjects\": [\n \"68edf5dd4c931f68d31111\",\n \"690b02fc100e454245adde111\",\n \"68e6eda61ff68d2111\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-trial.cognigy.ai/new/v2.0/largelanguagemodels")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"Large language model for customer service\",\n \"connectionId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"resourceLevel\": \"organisation\",\n \"description\": \"Large language model for customer-facing AI Agents.\",\n \"isCustomModel\": true,\n \"openAI\": {\n \"customModel\": \"gpt-4-32k-0613\"\n },\n \"anthropic\": {\n \"customModel\": \"claude-sonnet-4-6\"\n },\n \"azureOpenAI\": {\n \"resourceName\": \"<string>\",\n \"deploymentName\": \"<string>\",\n \"apiVersion\": \"<string>\",\n \"baseCustomUrl\": [\n \"https://<resourceName>.openai.azure.com/openai/deployments/<deploymentName>/chat/completions?api-version=<apiVersion>\",\n \"https://<resourceName>.openai.azure.com/openai/deployments/<deploymentName>/completions?api-version=<apiVersion>\",\n \"https://<resourceName>.openai.azure.com/openai/deployments/<deploymentName>/embeddings?api-version=<apiVersion>\"\n ],\n \"useDeploymentNameAsModel\": true\n },\n \"googleVertexAI\": {\n \"location\": \"<string>\",\n \"apiEndpoint\": \"<string>\",\n \"publisher\": \"<string>\"\n },\n \"googleGemini\": {\n \"location\": \"<string>\"\n },\n \"googleGenAI\": {\n \"location\": \"<string>\"\n },\n \"alephAlpha\": {\n \"customModel\": \"luminous-003\",\n \"baseCustomUrl\": \"https://api.aleph-alpha.com\"\n },\n \"openAICompatible\": {\n \"customModel\": \"luminous-003\",\n \"baseCustomUrl\": \"https://own-llm-deployment.company.com/openai/v1\",\n \"customAuthHeader\": \"Ocp-Apim-Subscription-Key\"\n },\n \"assignedToProjects\": [\n \"68edf5dd4c931f68d31111\",\n \"690b02fc100e454245adde111\",\n \"68e6eda61ff68d2111\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"name": "Large language model for customer service",
"connectionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"resourceLevel": "organisation",
"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>"
],
"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"
},
"assignedToProjects": [
"68edf5dd4c931f68d31111",
"690b02fc100e454245adde111",
"68e6eda61ff68d2111"
],
"referenceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"_id": "<string>",
"createdAt": 1694518620,
"lastChanged": 1694518620,
"createdBy": "<string>",
"lastChangedBy": "<string>"
}{
"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": {}
}