GoodMemGet an embedder by ID
GET /v1/embedders/{id}: Retrieves the details of a specific embedder configuration by its unique identifier.
Retrieves the details of a specific embedder configuration by its unique identifier. Requires READ_EMBEDDER on the requested embedder. The service distinguishes a missing embedder from an existing embedder the caller cannot read. This is a read-only operation with no side effects.
ApiKeyAuthx-api-key<token>id*stringThe unique identifier of the embedder to retrieve
includeCredentials?booleanWhether to return stored credentials. Also accepts include_credentials. Requires READ_EMBEDDER_CREDENTIALS in addition to READ_EMBEDDER.
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 embedder; credentials are omitted unless explicitly requested and authorized
application/json- response
Embedder configuration information
embedderId*stringUnique identifier of the embedder
uuid"550e8400-e29b-41d4-a716-446655440000"displayName*stringUser-facing name of the embedder
"OpenAI Ada-2"description?|Description of the embedder
"OpenAI's text embedding model with 1536 dimensions"providerType*ProviderTypeType of embedding provider
"OPENAI""OPENAI""VLLM""TEI""LLAMA_CPP""VOYAGE""COHERE""JINA""DASHSCOPE""GEMINI"endpointUrl*stringCanonical base HTTP(S) endpoint used for provider requests.
"https://api.openai.com/v1"apiPath?|Configured provider-relative request path. For Gemini, this is the selected API version: /v1beta for Developer or /v1 for Google Cloud.
"/embeddings"modelIdentifier*stringModel identifier
"text-embedding-3-small"dimensionality*integerOutput vector dimensions
int321 <= value1536distributionType*DistributionTypeType of embedding distribution (DENSE or SPARSE)
"DENSE""DENSE""SPARSE"maxSequenceLength?|Maximum input sequence length
int321 <= value8192supportedModalities*array<>Supported content modalities
credentials?||Stored credentials; present only when GetEmbedder explicitly requests them and the caller has READ_EMBEDDER_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": "nlp"}version?|Version information
"1.0.0"monitoringEndpoint?|Monitoring endpoint URL
"https://monitoring.example.com/embedders/status"ownerId*stringOwner ID of the embedder
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 embedder
uuid"550e8400-e29b-41d4-a716-446655440000"updatedById*stringID of the user who last updated the embedder
uuid"550e8400-e29b-41d4-a716-446655440000"dashscopeApiDialect?|Configured DashScope request and response API dialect; present only for DashScope configurations with a persisted dialect.
"EMBEDDING_NATIVE_TEXT""EMBEDDING_NATIVE_TEXT""EMBEDDING_NATIVE_CONTENTS""OPENAI_COMPATIBLE"geminiEndpointConfig?|Persisted Gemini backend routing; present only for Gemini embedder resources.
{ "backend": "DEVELOPER", "projectId": "goodmem-production", "location": "us-central1"}curl -X GET 'https://your-goodmem-server.example.com/v1/embedders/550e8400-e29b-41d4-a716-446655440000?includeCredentials=true' \ -H 'GoodMem-Timeout-Ms: 30000'{ "embedderId": "550e8400-e29b-41d4-a716-446655440000", "displayName": "OpenAI Ada-2", "description": "OpenAI's text embedding model with 1536 dimensions", "providerType": "OPENAI", "endpointUrl": "https://api.openai.com/v1", "apiPath": "/embeddings", "modelIdentifier": "text-embedding-3-small", "dimensionality": 1536, "distributionType": "DENSE", "maxSequenceLength": 8192, "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": "nlp" }, "version": "1.0.0", "monitoringEndpoint": "https://monitoring.example.com/embedders/status", "ownerId": "550e8400-e29b-41d4-a716-446655440000", "createdAt": 1617293472000, "updatedAt": 1617293472000, "createdById": "550e8400-e29b-41d4-a716-446655440000", "updatedById": "550e8400-e29b-41d4-a716-446655440000", "dashscopeApiDialect": "EMBEDDING_NATIVE_TEXT", "geminiEndpointConfig": { "backend": "DEVELOPER", "projectId": "goodmem-production", "location": "us-central1" }}