Get 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.
x-api-key<token>
In: header
Path Parameters
idstring
The unique identifier of the reranker to retrieve
Query Parameters
includeCredentials?boolean
Whether to return stored credentials. Also accepts include_credentials. Requires READ_RERANKER_CREDENTIALS in addition to READ_RERANKER.
Default
falseResponse Body
curl -X GET "https://your-goodmem-server.example.com/v1/rerankers/550e8400-e29b-41d4-a716-446655440000?includeCredentials=true"{
"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"
}Empty
Empty
Empty
Empty