v1

latestOpenAPI 3.0.0Cognigy Proprietary License2026-07-2239524.1 MB
Large Language Models

Test large language model connection

Tests the connection to the large language model provider by validating the credentials.

post/v2.0/largelanguagemodels/{largeLanguageModelId}/test

Path parameters

largeLanguageModelIdstring required

The unique identifier for the large language model.

Headers

Accept'application/json' | 'application/hal+json' | 'application/xml' | 'text/xml' | 'text/csv'

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.

Request body

projectIdstring required

The unique identifier for the Project.

Response

Credentials have been validated and the connection was successful.

voiceProviderstring
isCredentialsValidboolean
msgstring
msgErrstring