Skip to main content
Version: 2.0

List Encoders API Definition

The List Encoders API retrieves a list of available encoders used for embedding documents and queries.

List Encoders Request and Response​

To list the available encoders, send a GET request to /v2/encoders. You can specify optional query parameters to filter the results.

  • filter - Specifies a regular expression to match against the names and descriptions of theencoders.
  • limit - Indicates the maximum number of encoders to return in a single request, with a default value of 10 and a maximum value of 100.
  • page_key - Indicates the next page of results when the previous request has reached the limit.

REST 2.0 URL​

List Encoders Endpoint Address​

Vectara exposes an HTTP endpoint at the following URL to list the available encoders:
https://api.vectara.io/v2/encoders

The API Reference shows the full List Encoders REST definition.