Skip to main content
PATCH
/
v2.0
/
largelanguagemodels
/
{largeLanguageModelId}
Update a large language model
curl --request PATCH \
  --url https://api-trial.cognigy.ai/new/v2.0/largelanguagemodels/{largeLanguageModelId} \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "name": "My large language model",
  "description": "Large language model to be used for customer-facing AI Agents.",
  "connectionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "isDefault": false
}
'
{
  "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": {}
}

Documentation Index

Fetch the complete documentation index at: https://docs.cognigy.com/llms.txt

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

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

Path Parameters

​
largeLanguageModelId
string
required

The unique identifier for the large language model.

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

Body

application/json
​
name
string

The display name of the large language model.

Example:

"My large language model"

​
description
string

A meaningful description of the large language model.

Example:

"Large language model to be used for customer-facing AI Agents."

​
provider
enum<string>
Available options:
azureOpenAI,
openAI,
anthropic,
googleVertexAI,
googleGemini,
googleGenAI,
alephAlpha,
awsBedrock,
mistral
​
connectionId
string<uuid>

The identifier for the large language model connection.

Required string length: 36
​
isDefault
boolean

If set to true, the large language model is used as the default large language model when no other large language model is set.

Example:

false

Response

Successfully updated large language model.