GoodMem
ReferenceAPIREST APIRerankers

Get a reranker by ID

Retrieves the details of a specific reranker configuration by its unique identifier.

SECURITY NOTE: The credentials field is omitted from the response for security reasons. Requires READ_RERANKER_OWN permission for rerankers you own (or READ_RERANKER_ANY for admin users). This is a read-only operation with no side effects and is safe to retry.

GET
/v1/rerankers/{id}
x-api-key<token>

In: header

Path Parameters

idstring

The unique identifier of the reranker to retrieve

Response Body

curl -X GET "http://localhost:8080/v1/rerankers/550e8400-e29b-41d4-a716-446655440000"
{
  "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"
  ],
  "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