GoodMemGet a reranker by ID
GET /v1/rerankers/{id}: Retrieves the details of a specific reranker configuration by its unique identifier.
Retrieves the details of a specific reranker configuration by its unique identifier. Stored credentials are omitted unless includeCredentials is true and the caller also has READ_RERANKER_CREDENTIALS. Requires READ_RERANKER on the requested reranker. The service distinguishes a missing reranker from an existing reranker the caller cannot read. This is a read-only operation with no side effects and is safe to retry.
ApiKeyAuthx-api-key<token>id*stringThe unique identifier of the reranker to retrieve
includeCredentials?booleanWhether to return stored credentials. Also accepts include_credentials. Requires READ_RERANKER_CREDENTIALS in addition to READ_RERANKER.
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 reranker; credentials are omitted unless explicitly requested and authorized
application/json- response
Reranker configuration information
rerankerId*stringUnique identifier of the reranker
uuid"550e8400-e29b-41d4-a716-446655440000"displayName*stringUser-facing name of the reranker
"BGE Cross-Encoder Reranker"description?|Description of the reranker
"BAAI BGE reranker for cross-encoder semantic ranking"providerType*ProviderTypeType of reranking provider
"TEI""OPENAI""VLLM""TEI""LLAMA_CPP""VOYAGE""COHERE""JINA""DASHSCOPE""GEMINI"endpointUrl*stringAPI endpoint URL
"http://bge.reranker.goodmem.ai:8010"apiPath?|API path for reranking request
"/rerank"modelIdentifier*stringModel identifier
"BAAI/bge-reranker-base"supportedModalities*array<>Supported content modalities
credentials?||Stored credentials; present only when GetReranker explicitly requests them and the caller has READ_RERANKER_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": "search"}version?|Version information
"1.0.0"monitoringEndpoint?|Monitoring endpoint URL
"https://monitoring.example.com/rerankers/status"ownerId*stringOwner ID of the reranker
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 reranker
uuid"550e8400-e29b-41d4-a716-446655440000"updatedById*stringID of the user who last updated the reranker
uuid"550e8400-e29b-41d4-a716-446655440000"dashscopeApiDialect?|Configured DashScope request and response API dialect; present only for DashScope configurations with a persisted dialect.
"RERANK_NATIVE_NESTED""RERANK_NATIVE_NESTED""RERANK_COMPATIBLE_FLAT"curl -X GET 'https://your-goodmem-server.example.com/v1/rerankers/550e8400-e29b-41d4-a716-446655440000?includeCredentials=true' \ -H 'GoodMem-Timeout-Ms: 30000'{ "rerankerId": "550e8400-e29b-41d4-a716-446655440000", "displayName": "BGE Cross-Encoder Reranker", "description": "BAAI BGE reranker for cross-encoder semantic ranking", "providerType": "TEI", "endpointUrl": "http://bge.reranker.goodmem.ai:8010", "apiPath": "/rerank", "modelIdentifier": "BAAI/bge-reranker-base", "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": "search" }, "version": "1.0.0", "monitoringEndpoint": "https://monitoring.example.com/rerankers/status", "ownerId": "550e8400-e29b-41d4-a716-446655440000", "createdAt": 1617293472000, "updatedAt": 1617293472000, "createdById": "550e8400-e29b-41d4-a716-446655440000", "updatedById": "550e8400-e29b-41d4-a716-446655440000", "dashscopeApiDialect": "RERANK_NATIVE_NESTED"}