Skip to main content
POST
/
v2.0
/
largelanguagemodels
/
{largeLanguageModelId}
/
test
Test large language model connection
curl --request POST \
  --url https://api-trial.cognigy.ai/new/v2.0/largelanguagemodels/{largeLanguageModelId}/test \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "projectId": "<string>"
}
'
{
  "voiceProvider": "<string>",
  "isCredentialsValid": true,
  "msg": "<string>",
  "msgErr": "<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

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
ā€‹
projectId
string
required

The unique identifier for the Project.

Response

Credentials have been validated and the connection was successful.

ā€‹
voiceProvider
string
ā€‹
isCredentialsValid
boolean
ā€‹
msg
string
ā€‹
msgErr
string