GoodMem
ReferenceAPIREST APIRerankers

List 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. Responses include stored credentials, matching gRPC response semantics.

LABEL FILTERS: Supply dynamic query parameters in the form label.<key>=<value> (for example, label.environment=production).

PERMISSION-BASED FILTERING: With LIST_RERANKER_OWN permission, only your own rerankers are shown. With LIST_RERANKER_ANY permission, you can see all rerankers or filter by any ownerId. Specifying ownerId without LIST_RERANKER_ANY permission returns PERMISSION_DENIED.

GET
/v1/rerankers
x-api-key<token>

In: header

Query Parameters

ownerId?string

Filter rerankers by owner ID. With LIST_RERANKER_ANY permission, omitting this shows all accessible rerankers; providing it filters by that owner. With LIST_RERANKER_OWN permission, only your own rerankers are shown regardless of this parameter (PERMISSION_DENIED if set to another user).

providerType?string

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

Value in"OPENAI" | "VLLM" | "TEI" | "LLAMA_CPP" | "VOYAGE" | "COHERE" | "JINA"

Response Body

curl -X GET "http://localhost:8080/v1/rerankers?ownerId=550e8400-e29b-41d4-a716-446655440000&providerType=TEI"
{
  "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"
    }
  ]
}
Empty
Empty
Empty