--- title: "Get a large language model" method: GET path: "/v2.0/largelanguagemodels/{largeLanguageModelId}" tags: ["Large Language Models"] --- # Get a large language model `GET /v2.0/largelanguagemodels/{largeLanguageModelId}` Gets data about a [large language model](https://docs.cognigy.com/ai/agents/develop/gen-ai-and-llms/llms). ## Path parameters - `largeLanguageModelId` string, required ## Headers - `Accept` 'application/json' | 'application/hal+json' | 'application/xml' | 'text/xml' | 'text/csv' ## Response `200` Returns large language model object. - union - object — 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. - `name` string, required - `description` string - `modelType` '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-chat-latest' | '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' | '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.1-flash-lite-preview' | 'gemini-3.1-flash-lite' | 'mistral-large-2411' | 'mistral-small-2503' | 'pixtral-large-2411' | 'pixtral-12b-2409', required - `modelGroup` 'chat' | 'completion' | 'embedding' - `apiType` 'chatCompletion' | 'responses' — 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. - `isCustomModel` boolean - `provider` 'azureOpenAI' | 'openAI' | 'anthropic' | 'googleVertexAI' | 'googleGemini' | 'googleGenAI' | 'alephAlpha' | 'awsBedrock' | 'mistral', required - `connectionId` string, uuid, required — The identifier for the large language model connection. - `openAI` object — Metadata for OpenAI large language models. - `customModel` string — The custom model name. - `anthropic` object — Metadata for Anthropic large language models. - `customModel` string — The custom model name. - `azureOpenAI` object — Metadata for Azure OpenAI large language models. - `resourceName` string — The Azure OpenAI resource name. For more information, read the [Microsoft Azure OpenAI resource](https://learn.microsoft.com/en-us/azure/cognitive-services/openai/how-to/create-resource?pivots=web-portal#create-a-resource) documentation. - `deploymentName` string — The model deployment name. For more information, read the [Microsoft Azure OpenAI resource](https://learn.microsoft.com/en-us/azure/cognitive-services/openai/how-to/create-resource?pivots=web-portal#deploy-a-model) documentation. - `apiVersion` string — The API version in `YYYY-MM-DD` format (for example, `YYYY-MM-DD-preview`). For more information, read the [Microsoft Azure OpenAI REST API versioning](https://learn.microsoft.com/en-us/azure/cognitive-services/openai/reference#rest-api-versioning) documentation. - `baseCustomUrl` string — The custom URL to route connections between your clusters and Microsoft Azure OpenAI through a dedicated proxy for enhanced security. When set, `resourceName`, `deploymentName`, and `apiVersion` are ignored. For API key connections on 2025.20 and earlier use `https://.openai.azure.com/openai/deployments//?api-version=`. - `googleVertexAI` object — Metadata for Google Vertex AI large language models. - `location` string - `apiEndpoint` string - `publisher` string - `googleGemini` object — Metadata for Google Gemini large language models. - `location` string - `googleGenAI` object — Google GenAI specific meta data - `location` string - `alephAlpha` object — Metadata for Aleph Alpha large language models. - `customModel` string — The custom model name. - `baseCustomUrl` string - `openAICompatible` object — Metadata for OpenAI-compatible large language models. - `customModel` string — The custom model name. - `baseCustomUrl` string - `customAuthHeader` string — The API key will be sent via this http header if specified. - `resourceLevel` 'project' — Scope for project-level resources. - `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. - `fallbacks` object[] — (Alpha) The list of fallback large language models used when the primary large language model stops working. - `isFallbackEnabled` boolean — If set to `true`, activates large language model fallback. - `fallbackLLMReferenceId` string, uuid — The identifier for the fallback large language model. - `immediateFallBack` object - `failedRequests` number — The number of failed requests until the fallback large language model is used instead of the primary large language model. - `durationInMinutes` number — The duration in minutes for which the fallback large language model is used instead of the primary large language model. - `emailNotificationList` string[] — The list of email addresses to notify when the large language model fallback is triggered. - `referenceId` string, uuid — The reference ID of the large language model. - `_id` string - `createdAt` integer — Unix-timestamp - `lastChanged` integer — Unix-timestamp - `createdBy` string - `lastChangedBy` string - object — 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. - `name` string, required - `description` string - `modelType` '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-chat-latest' | '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' | '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.1-flash-lite-preview' | 'gemini-3.1-flash-lite' | 'mistral-large-2411' | 'mistral-small-2503' | 'pixtral-large-2411' | 'pixtral-12b-2409', required - `modelGroup` 'chat' | 'completion' | 'embedding' - `apiType` 'chatCompletion' | 'responses' — 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. - `isCustomModel` boolean - `provider` 'azureOpenAI' | 'openAI' | 'anthropic' | 'googleVertexAI' | 'googleGemini' | 'googleGenAI' | 'alephAlpha' | 'awsBedrock' | 'mistral', required - `connectionId` string, uuid, required — The identifier for the large language model connection. - `openAI` object — Metadata for OpenAI large language models. - `customModel` string — The custom model name. - `anthropic` object — Metadata for Anthropic large language models. - `customModel` string — The custom model name. - `azureOpenAI` object — Metadata for Azure OpenAI large language models. - `resourceName` string — The Azure OpenAI resource name. For more information, read the [Microsoft Azure OpenAI resource](https://learn.microsoft.com/en-us/azure/cognitive-services/openai/how-to/create-resource?pivots=web-portal#create-a-resource) documentation. - `deploymentName` string — The model deployment name. For more information, read the [Microsoft Azure OpenAI resource](https://learn.microsoft.com/en-us/azure/cognitive-services/openai/how-to/create-resource?pivots=web-portal#deploy-a-model) documentation. - `apiVersion` string — The API version in `YYYY-MM-DD` format (for example, `YYYY-MM-DD-preview`). For more information, read the [Microsoft Azure OpenAI REST API versioning](https://learn.microsoft.com/en-us/azure/cognitive-services/openai/reference#rest-api-versioning) documentation. - `baseCustomUrl` string — The custom URL to route connections between your clusters and Microsoft Azure OpenAI through a dedicated proxy for enhanced security. When set, `resourceName`, `deploymentName`, and `apiVersion` are ignored. For API key connections on 2025.20 and earlier use `https://.openai.azure.com/openai/deployments//?api-version=`. - `googleVertexAI` object — Metadata for Google Vertex AI large language models. - `location` string - `apiEndpoint` string - `publisher` string - `googleGemini` object — Metadata for Google Gemini large language models. - `location` string - `googleGenAI` object — Google GenAI specific meta data - `location` string - `alephAlpha` object — Metadata for Aleph Alpha large language models. - `customModel` string — The custom model name. - `baseCustomUrl` string - `openAICompatible` object — Metadata for OpenAI-compatible large language models. - `customModel` string — The custom model name. - `baseCustomUrl` string - `customAuthHeader` string — The API key will be sent via this http header if specified. - `resourceLevel` 'organisation', required — Scope for globally scoped resources. - `assignedToProjects` string[] - `referenceId` string, uuid — The reference ID of the large language model. - `_id` string - `createdAt` integer — Unix-timestamp - `lastChanged` integer — Unix-timestamp - `createdBy` string - `lastChangedBy` string ## Other responses - `400` — The server cannot or will not process the request due to something that is perceived to be a client error (e.g., malformed request syntax, invalid request message framing, or deceptive request routing) - `401` — The request has not been applied because it lacks valid authentication credentials for the target resource. - `402` — Upgrade your Plan to increase your Quota. - `403` — The server understood the request but refuses to authorize it. - `404` — The origin server did not find a current representation for the target resource or is not willing to disclose that one exists. - `405` — The method received in the request-line is known by the origin server but not supported by the target resource. - `409` — The request conflicts with current state of the server. - `413` — The request entity is larger than limits defined by server. - `500` — The server encountered an unexpected condition that prevented it from fulfilling the request. - `501` — The server does not support the functionality required to fulfill the request. - `502` — The server, while acting as a gateway or proxy, received an invalid response from an inbound server it accessed while attempting to fulfill the request. - `503` — The server is not ready to handle the request. - `504` — The server, while acting as a gateway or proxy, did not receive a timely response from an upstream server it needed to access in order to complete the request. --- [API](https://skmtc.net/cognigy/apis/simulator-openapi-rest-ful-api-reference.md) · [All operations](https://skmtc.net/cognigy/apis/simulator-openapi-rest-ful-api-reference/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/cognigy/simulator-openapi-rest-ful-api-reference/versions/85b2872bdfb7/schema)