GoodMemGoodMem
ReferenceAPIREST APIRerankers

List rerankers

GET /v1/rerankers: Retrieves a list of reranker configurations accessible to the caller, with optional filtering.

GET
/v1/rerankers

Retrieves a list of reranker configurations accessible to the caller, with optional filtering.

IMPORTANT: Pagination is NOT supported - all matching results are returned. Results are ordered by created_at descending. Stored credentials are never included in list responses.

LABEL FILTERS: Label filters accept either label.<key>=<value> or label[key]=value (for example, label.environment=production or label[environment]=production).

AUTHORIZATION: Requires LIST_RERANKER on the GoodMem instance. Each returned reranker must also be visible through READ_RERANKER; unauthorized rerankers are filtered in PostgreSQL. The ownerId parameter filters that already-authorized result set and does not grant additional visibility.

Authorization

ApiKeyAuth
headerx-api-key<token>

Query Parameters

ownerId?string

Filter the already-authorized result set by owner principal UUID. Omitting this parameter does not bypass per-reranker READ_RERANKER filtering.

providerType?string

Filter rerankers by provider type. Allowed values match the ProviderType schema.

Value in"OPENAI""VLLM""TEI""LLAMA_CPP""VOYAGE""COHERE""JINA""DASHSCOPE""GEMINI"
label?

Filter by label key-value pairs. Label filters accept either label.<key>=<value> or label[key]=value (for example, label.environment=production or label[environment]=production).

Example
{  "environment": "production",  "team": "nlp"}

Header Parameters

GoodMem-Timeout-Ms?integer

Optional 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.

Formatint64
Range1 <= value <= 86400000

Response Body

Successfully retrieved rerankers

application/json
  1. response

Response containing a list of rerankers

rerankers*array<>

List of reranker configurations

Example Request
curl -X GET 'https://your-goodmem-server.example.com/v1/rerankers?ownerId=550e8400-e29b-41d4-a716-446655440000&providerType=TEI' \  -H 'GoodMem-Timeout-Ms: 30000'
Example Response
{  "rerankers": [    {      "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",      "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"        }      },      "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"    }  ]}

Get a reranker by ID

GET /v1/rerankers/{id}: Retrieves the details of a specific reranker configuration by its unique identifier.

Update a reranker

PUT /v1/rerankers/{id}: Updates an existing reranker configuration including display information, endpoint configuration, model parameters, credentials, and labels.