> ## Documentation Index
> Fetch the complete documentation index at: https://www.edenai.co/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# List Rerank Models

> List available rerank models.



## OpenAPI

````yaml https://api.edenai.run/v3/docs/openapi.json get /v3/rerank/models
openapi: 3.1.0
info:
  title: Eden AI API V3
  version: 3.0.0
servers:
  - url: https://api.edenai.run
    description: Production server
security: []
paths:
  /v3/rerank/models:
    get:
      tags:
        - Rerank
      summary: List Rerank Models
      description: List available rerank models.
      operationId: list_rerank_models_v3_rerank_models_get
      parameters:
        - name: view
          in: query
          required: false
          schema:
            enum:
              - endpoints
              - models
            type: string
            description: >-
              How to group the listing. 'endpoints' (default) is one entry per
              provider/model id, each callable as `model`. 'models' groups those
              entries under their model name; the name itself cannot be called
              on this endpoint, so send one of its `endpoints[].id`
              (provider/model) as `model`.
            default: endpoints
            title: View
          description: >-
            How to group the listing. 'endpoints' (default) is one entry per
            provider/model id, each callable as `model`. 'models' groups those
            entries under their model name; the name itself cannot be called on
            this endpoint, so send one of its `endpoints[].id` (provider/model)
            as `model`.
        - name: zero_data_retention
          in: query
          required: false
          schema:
            anyOf:
              - type: boolean
              - type: 'null'
            description: >-
              true keeps only models whose provider keeps no prompts or outputs
              after the response (Zero Data Retention); false keeps only those
              known to keep them. Models not verified yet (`zero_data_retention:
              null`) match neither.
            title: Zero Data Retention
          description: >-
            true keeps only models whose provider keeps no prompts or outputs
            after the response (Zero Data Retention); false keeps only those
            known to keep them. Models not verified yet (`zero_data_retention:
            null`) match neither.
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                anyOf:
                  - $ref: '#/components/schemas/ListModelsResponse'
                  - $ref: '#/components/schemas/ListModelsWithEndpointsResponse'
                title: Response List Rerank Models V3 Rerank Models Get
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    ListModelsResponse:
      properties:
        object:
          type: string
          const: list
          title: Object
          description: Object type
          default: list
        data:
          items:
            $ref: '#/components/schemas/ModelObject'
          type: array
          title: Data
          description: List of models
      type: object
      required:
        - data
      title: ListModelsResponse
      description: List models response.
    ListModelsWithEndpointsResponse:
      properties:
        object:
          type: string
          const: list
          title: Object
          description: Object type
          default: list
        data:
          items:
            $ref: '#/components/schemas/ModelWithEndpoints'
          type: array
          title: Data
          description: List of routable models
      type: object
      required:
        - data
      title: ListModelsWithEndpointsResponse
      description: >-
        `?view=models` response: routable names, each with its provider
        endpoints.


        Named for the public vocabulary rather than the internal one: Pydantic
        class names become

        OpenAPI schema titles and generated SDK classes, and a caller never
        needs the word

        "canonical" -- to them these are simply models, and the rows behind them
        endpoints.
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    ModelObject:
      properties:
        id:
          type: string
          title: Id
          description: Model identifier (e.g., 'openai/gpt-4')
        object:
          type: string
          const: model
          title: Object
          description: Object type
          default: model
        created:
          type: integer
          title: Created
          description: Unix timestamp of model creation/release
        owned_by:
          type: string
          title: Owned By
          description: Provider/organization that owns the model
        model_name:
          type: string
          title: Model Name
          description: Model name without provider prefix
        context_length:
          anyOf:
            - type: integer
            - type: 'null'
          title: Context Length
          description: Maximum context length in tokens
        description:
          anyOf:
            - type: string
            - type: 'null'
          title: Description
          description: Model description
        source:
          anyOf:
            - type: string
            - type: 'null'
          title: Source
          description: Model source URL
        capabilities:
          $ref: '#/components/schemas/Capabilities'
          description: Model capabilities
        pricing:
          additionalProperties: true
          type: object
          title: Pricing
          description: Pricing information after any applicable discounts have been applied
        list_pricing:
          additionalProperties: true
          type: object
          title: List Pricing
          description: Provider list pricing, before any discounts are applied
        discount:
          anyOf:
            - type: number
            - type: 'null'
          title: Discount
          description: Discount applied to the model (0-1 range)
        regions:
          items:
            $ref: '#/components/schemas/RegionObject'
          type: array
          title: Regions
          description: Regions where this model is available
        zero_data_retention:
          anyOf:
            - type: boolean
            - type: 'null'
          title: Zero Data Retention
          description: >-
            true when calls to this entry keep no prompts or outputs after the
            response (Zero Data Retention), under Eden AI's terms with its
            provider: the model's own terms when they differ, else the
            provider's; a customer-hosted model is always true. false when they
            are kept, null when not verified yet.
        alias_of:
          anyOf:
            - type: string
            - type: 'null'
          title: Alias Of
          description: >-
            Set when this entry is an alias (e.g. 'gemini-pro-latest'): the real
            model_id it currently resolves to. None for concrete models.
      type: object
      required:
        - id
        - created
        - owned_by
        - model_name
      title: ModelObject
      description: Extended model object with full metadata.
    ModelWithEndpoints:
      properties:
        id:
          type: string
          title: Id
          description: >-
            The routable model name, with no provider prefix (e.g.
            'gpt-oss-120b'), or a routing policy you can call (`policy/{name}`).
            Send this as `model` to let Eden AI choose which provider serves it.
        object:
          type: string
          const: model
          title: Object
          description: Object type
          default: model
        created:
          type: integer
          title: Created
          description: Unix timestamp of the newest endpoint serving this model
          default: 0
        owned_by:
          type: string
          title: Owned By
          description: Who authored the model, independent of who sells it
          default: ''
        mode:
          anyOf:
            - type: string
            - type: 'null'
          title: Mode
          description: >-
            What the model does: 'chat', 'embedding', 'stt', 'tts' or
            'image_generation'. Lets a caller tell an LLM from a voice.
        context_length:
          anyOf:
            - type: integer
            - type: 'null'
          title: Context Length
          description: >-
            The largest context window among the endpoints. A request is only
            routed to endpoints whose window fits it.
        capabilities:
          $ref: '#/components/schemas/Capabilities'
          description: >-
            What at least one endpoint supports: a flag is true, and a modality
            listed, when any endpoint has it. `endpoints` says which.
        pricing:
          anyOf:
            - additionalProperties: true
              type: object
            - type: 'null'
          title: Pricing
          description: >-
            The full price list of the cheapest endpoint a call without a
            provider can reach, named by `pricing_endpoint`. A call routed
            elsewhere, or to a fallback, is billed at that endpoint's prices.
            null when no endpoint is priced.
        pricing_endpoint:
          anyOf:
            - type: string
            - type: 'null'
          title: Pricing Endpoint
          description: The endpoint whose prices `pricing` shows.
        regions:
          items:
            $ref: '#/components/schemas/RegionObject'
          type: array
          title: Regions
          description: Every region at least one endpoint runs in.
        endpoints:
          items:
            $ref: '#/components/schemas/ModelObject'
          type: array
          title: Endpoints
          description: >-
            Every provider endpoint serving this model, each with its own
            pricing, context length, capabilities and regions. Empty for a
            routing policy: which of its targets serves a call is decided per
            request.
        endpoint_count:
          type: integer
          title: Endpoint Count
          description: How many provider endpoints serve this model
          readOnly: true
      type: object
      required:
        - id
        - endpoints
        - endpoint_count
      title: ModelWithEndpoints
      description: >-
        One routable model name and the provider endpoints behind it.


        The model-level values are derived from the endpoints by
        :meth:`from_endpoints`, the one way

        a catalogue entry is built, so a cached payload serves them as stored
        and the

        `zero_data_retention` filter rebuilds the entry from the endpoints it
        keeps. A routing

        policy's entry (`policies.listing`) carries its identity alone, with no
        endpoints. Sellers of one model differ on each,

        which is why each has its own rule, stated in its description, and each
        endpoint keeps its own

        values unchanged.


        ``endpoints`` entries are the same :class:`ModelObject` the flat listing
        returns, field for

        field: a caller reading ``data[].endpoints[]`` sees exactly what it
        reads from ``data[]``.
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
    Capabilities:
      properties:
        input_modalities:
          items:
            type: string
          type: array
          title: Input Modalities
        output_modalities:
          items:
            type: string
          type: array
          title: Output Modalities
        supports_reasoning:
          type: boolean
          title: Supports Reasoning
          default: false
        supports_web_search:
          type: boolean
          title: Supports Web Search
          default: false
        supports_tool_choice:
          type: boolean
          title: Supports Tool Choice
          default: false
        supports_computer_use:
          type: boolean
          title: Supports Computer Use
          default: false
        supports_prompt_caching:
          type: boolean
          title: Supports Prompt Caching
          default: false
        supports_response_schema:
          type: boolean
          title: Supports Response Schema
          default: false
        supports_system_messages:
          type: boolean
          title: Supports System Messages
          default: false
        supports_function_calling:
          type: boolean
          title: Supports Function Calling
          default: false
        supports_native_streaming:
          type: boolean
          title: Supports Native Streaming
          default: false
        supports_assistant_prefill:
          type: boolean
          title: Supports Assistant Prefill
          default: false
        supports_embedding_image_input:
          type: boolean
          title: Supports Embedding Image Input
          default: false
        supports_parallel_function_calling:
          type: boolean
          title: Supports Parallel Function Calling
          default: false
      additionalProperties: true
      type: object
      title: Capabilities
      description: >-
        Model capability flags. Unknown flags are preserved so consumers keep
        working when

        new capabilities are introduced without a coordinated release.
    RegionObject:
      properties:
        code:
          type: string
          title: Code
          description: Region code (e.g., 'us-east-1')
        name:
          type: string
          title: Name
          description: Region display name
      type: object
      required:
        - code
        - name
      title: RegionObject
      description: Region where a model is available.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.