Get an LLM by ID
GET /v1/llms/{id}: Retrieves the details of a specific LLM configuration by its unique identifier.
Retrieves the details of a specific LLM configuration by its unique identifier. Requires READ_LLM on the requested LLM. The service distinguishes a missing LLM from an existing LLM the caller cannot read. This is a read-only operation with no side effects.
ApiKeyAuthx-api-key<token>id*stringThe unique identifier of the LLM to retrieve
includeCredentials?booleanWhether to return stored credentials. Also accepts include_credentials. Requires READ_LLM_CREDENTIALS in addition to READ_LLM.
falseGoodMem-Timeout-Ms?integerOptional waiting budget in milliseconds, measured from REST servlet ingress and shared across all internal gRPC calls. Supply one decimal integer from 1 to 86400000. Omission adds no deadline. Existing shorter deadlines still apply. Expiry returns HTTP 504 before streaming starts; after streaming starts, no successful completion event is sent. Use SSE or opt into GoodMem-Stream-Terminal for an explicit terminal outcome. Retrieval work is cooperatively cancelled. An accepted mutation may still commit after timeout or disconnect; a failed response does not imply rollback.
int641 <= value <= 86400000Successfully retrieved LLM; credentials are omitted unless explicitly requested and authorized
application/json- response
LLM configuration information
llmId*stringUnique identifier of the LLM
uuid"550e8400-e29b-41d4-a716-446655440000"displayName*stringUser-facing name of the LLM
"GPT-4 Turbo"description?|Description of the LLM
"OpenAI's GPT-4 Turbo model for chat completions"providerType*LLMProviderTypeType of LLM provider
"OPENAI""OPENAI""LITELLM_PROXY""OPEN_ROUTER""DASHSCOPE""VLLM""OLLAMA""LLAMA_CPP""CUSTOM_OPENAI_COMPATIBLE"endpointUrl*stringAPI endpoint base URL
"https://api.openai.com/v1"apiPath?|API path for chat/completions request
"/chat/completions"modelIdentifier*stringModel identifier
"gpt-4-turbo-preview"supportedModalities*array<>Supported content modalities
credentials?||Stored credentials; present only when GetLLM explicitly requests them and the caller has READ_LLM_CREDENTIALS. Always omitted from create, update, and list responses.
{ "apiKey": { "inlineSecret": "sk-1234567890abcdef", "secretRef": { "uri": "vault://path/to/secret" }, "headerName": "Authorization", "prefix": "Bearer " }, "gcpAdc": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "quotaProjectId": "my-quota-project" }}labels*User-defined labels for categorization
{ "environment": "production", "team": "ai"}version?|Version information
"1.0.0"monitoringEndpoint?|Monitoring endpoint URL
"https://monitoring.example.com/llms/status"capabilities*LLM capabilities defining supported features and modes
defaultSamplingParams?|Default sampling parameters for generation requests
{ "maxTokens": 2048, "temperature": 0.7, "topP": 0.9, "topK": 50, "frequencyPenalty": 0, "presencePenalty": 0, "stopSequences": [ "\n\n", "END" ]}maxContextLength?|Maximum context window size in tokens
int321 <= value32768clientConfig?|Provider-specific client configuration
ownerId*stringOwner ID of the LLM
uuid"550e8400-e29b-41d4-a716-446655440000"createdAt*integerCreation timestamp (milliseconds since epoch)
int641617293472000updatedAt*integerLast update timestamp (milliseconds since epoch)
int641617293472000createdById*stringID of the user who created the LLM
uuid"550e8400-e29b-41d4-a716-446655440000"updatedById*stringID of the user who last updated the LLM
uuid"550e8400-e29b-41d4-a716-446655440000"dashscopeApiDialect?|Configured DashScope request and response API dialect; present only for DashScope configurations with a persisted dialect.
"LLM_NATIVE_TEXT""LLM_NATIVE_TEXT""LLM_NATIVE_MULTIMODAL""OPENAI_COMPATIBLE"curl -X GET 'https://your-goodmem-server.example.com/v1/llms/550e8400-e29b-41d4-a716-446655440000?includeCredentials=true' \ -H 'GoodMem-Timeout-Ms: 30000'{ "llmId": "550e8400-e29b-41d4-a716-446655440000", "displayName": "GPT-4 Turbo", "description": "OpenAI's GPT-4 Turbo model for chat completions", "providerType": "OPENAI", "endpointUrl": "https://api.openai.com/v1", "apiPath": "/chat/completions", "modelIdentifier": "gpt-4-turbo-preview", "supportedModalities": [ "TEXT" ], "credentials": { "apiKey": { "inlineSecret": "sk-1234567890abcdef", "secretRef": { "uri": "vault://path/to/secret" }, "headerName": "Authorization", "prefix": "Bearer " }, "gcpAdc": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "quotaProjectId": "my-quota-project" } }, "labels": { "environment": "production", "team": "ai" }, "version": "1.0.0", "monitoringEndpoint": "https://monitoring.example.com/llms/status", "capabilities": { "supportsChat": true, "supportsCompletion": true, "supportsFunctionCalling": true, "supportsSystemMessages": true, "supportsStreaming": true, "supportsSamplingParameters": true }, "defaultSamplingParams": { "maxTokens": 2048, "temperature": 0.7, "topP": 0.9, "topK": 50, "frequencyPenalty": 0, "presencePenalty": 0, "stopSequences": [ "\n\n", "END" ] }, "maxContextLength": 32768, "clientConfig": { "property1": {}, "property2": {} }, "ownerId": "550e8400-e29b-41d4-a716-446655440000", "createdAt": 1617293472000, "updatedAt": 1617293472000, "createdById": "550e8400-e29b-41d4-a716-446655440000", "updatedById": "550e8400-e29b-41d4-a716-446655440000", "dashscopeApiDialect": "LLM_NATIVE_TEXT"}