Validates the largeLanguageModel provider creedentials

POST

v2.0

largelanguagemodels

{largeLanguageModelId}

test

Validates the largeLanguageModel provider creedentials

curl --request POST \
  --url https://api-trial.cognigy.ai/new/v2.0/largelanguagemodels/{largeLanguageModelId}/test \
  --header 'Authorization: Bearer <token>' \
  --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

Authorization

string

header

required

The access token received from the authorization server in the OAuth 2.0 flow.

api_key

string

query

required

Supply the API Key in the Url-Query

Headers

enum<string>

The default media type is application/hal+json. Use application/json for pure data results.

Available options:

application/json,

application/hal+json,

application/xml,

text/xml,

text/csv

Path Parameters

largeLanguageModelId

string

required

Id for the LargeLanguageModel

Required string length: 24

Body

application/json

projectId

string

required

Response

Credentials have been validated and the connection was successful.

voiceProvider

string

isCredentialsValid

boolean

msg

string

msgErr

string

Get LexiconsGet 25 [Lexicons](https://docs.cognigy.com/ai/resources/build/lexicons/) in a project by default. To change the default value, use the `limit` query parameter. Additionally, you can filter, sort, and paginate the results.

⌘I

Validates the largeLanguageModel provider creedentials

curl --request POST \
  --url https://api-trial.cognigy.ai/new/v2.0/largelanguagemodels/{largeLanguageModelId}/test \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '{
  "projectId": "<string>"
}'

{
  "voiceProvider": "<string>",
  "isCredentialsValid": true,
  "msg": "<string>",
  "msgErr": "<string>"
}