---
title: "Add Rerank Provider"
url: "/docs/adding_provider/new_rerank_provider"
canonical_url: "https://docs.litellm.ai/docs/adding_provider/new_rerank_provider"
type: "docs"
last_updated: "2026-10-10"
summary: "LiteLLM follows the Cohere Rerank API format for all rerank providers. Here's how to add a new rerank provider:"
related:
  - "/docs/adding_provider/directory_structure"
  - "/docs/extras/contributing"
---
# Add Rerank Provider

> Index of all LiteLLM docs: https://docs.litellm.ai/llms.txt


LiteLLM **follows the Cohere Rerank API format** for all rerank providers. Here's how to add a new rerank provider:

## 1. Create a transformation.py file

Create a config class named `<Provider><Endpoint>Config` that inherits from [`BaseRerankConfig`](https://github.com/BerriAI/litellm/blob/main/litellm/llms/base_llm/rerank/transformation.py):

Every method below is abstract on `BaseRerankConfig`, so the class cannot be instantiated until all six are implemented:

```python
from typing import Any

import httpx

from litellm.litellm_core_utils.litellm_logging import Logging as LiteLLMLoggingObj
from litellm.llms.base_llm.rerank.transformation import BaseRerankConfig
from litellm.secret_managers.main import get_secret_str
from litellm.types.rerank import OptionalRerankParams, RerankRequest, RerankResponse

class YourProviderRerankConfig(BaseRerankConfig):
    def validate_environment(
        self,
        headers: dict,
        model: str,
        api_key: str | None = None,
        optional_params: dict | None = None,
        litellm_params: dict | None = None,
    ) -> dict:
        # Return the request headers, including auth
        api_key = api_key or get_secret_str("YOUR_PROVIDER_API_KEY")
        return {"Authorization": f"Bearer {api_key}", "Content-Type": "application/json", **headers}

    def get_complete_url(
        self,
        api_base: str | None,
        model: str,
        optional_params: dict | None = None,
    ) -> str:
        # Return the full URL the request is POSTed to
        return f"{api_base or 'https://api.your-provider.com'}/v1/rerank"

    def get_supported_cohere_rerank_params(self, model: str) -> list:
        return [
            "query",
            "documents",
            "top_n",
            # ... other supported params
        ]

    def map_cohere_rerank_params(
        self,
        non_default_params: dict,
        model: str,
        drop_params: bool,
        query: str,
        documents: list[str | dict[str, Any]],
        custom_llm_provider: str | None = None,
        top_n: int | None = None,
        rank_fields: list[str] | None = None,
        return_documents: bool | None = True,
        max_chunks_per_doc: int | None = None,
        max_tokens_per_doc: int | None = None,
        instruction: str | None = None,
    ) -> dict:
        # Map the Cohere-style params to the ones your provider accepts
        return dict(OptionalRerankParams(query=query, documents=documents, top_n=top_n))

    def transform_rerank_request(
        self,
        model: str,
        optional_rerank_params: dict,
        headers: dict,
        litellm_params: dict | None = None,
    ) -> dict:
        # Transform request to RerankRequest spec
        rerank_request = RerankRequest(model=model, **optional_rerank_params)
        return rerank_request.model_dump(exclude_none=True)

    def transform_rerank_response(
        self,
        model: str,
        raw_response: httpx.Response,
        model_response: RerankResponse,
        logging_obj: LiteLLMLoggingObj,
        api_key: str | None = None,
        request_data: dict = {},
        optional_params: dict = {},
        litellm_params: dict = {},
    ) -> RerankResponse:
        # Transform provider response to RerankResponse
        return RerankResponse(**raw_response.json())
```

## 2. Register Your Provider
Add your provider to `ProviderConfigManager.get_provider_rerank_config()` in [`litellm/utils.py`](https://github.com/BerriAI/litellm/blob/main/litellm/utils.py). Providers that are not listed there fall back to `CohereRerankConfig`, and `litellm.rerank()` then raises `Unsupported provider`:

```python nolint
elif litellm.LlmProviders.YOUR_PROVIDER == provider:
    return litellm.YourProviderRerankConfig()
```

## 3. Add Provider to `rerank_api/main.py`

Providers without a dedicated branch fall through to the generic `else` branch, which already calls `base_llm_http_handler.rerank` with the config returned in step 2. Add a dedicated branch only when your provider needs custom `api_key` or `api_base` resolution, and pass it `provider_config`

```python nolint
elif _custom_llm_provider == "your_provider":
    ...
    response = base_llm_http_handler.rerank(
        model=model,
        custom_llm_provider=_custom_llm_provider,
        provider_config=rerank_provider_config,
        optional_rerank_params=optional_rerank_params,
        logging_obj=litellm_logging_obj,
        timeout=optional_params.timeout,
        api_key=dynamic_api_key or optional_params.api_key,
        api_base=api_base,
        _is_async=_is_async,
        headers=headers or litellm.headers or {},
        client=client,
        model_response=model_response,
        litellm_params=rerank_litellm_params,
    )
    ...
```

## 4. Add Tests

Add a test file to [`tests/llm_translation`](https://github.com/BerriAI/litellm/tree/main/tests/llm_translation)

```python
def test_basic_rerank_cohere():
    response = litellm.rerank(
        model="cohere/rerank-english-v3.0",
        query="hello",
        documents=["hello", "world"],
        top_n=3,
    )

    print("re rank response: ", response)

    assert response.id is not None
    assert response.results is not None
```

## Reference PRs
- [Add Infinity Rerank](https://github.com/BerriAI/litellm/pull/7321)

## Related pages

- [Directory Structure](https://docs.litellm.ai/docs/adding_provider/directory_structure.md)
- [Contributing to Documentation](https://docs.litellm.ai/docs/extras/contributing.md)