---
title: "List encoders"
method: GET
path: "/v2/encoders"
tags: ["Encoders"]
---

# List encoders

`GET /v2/encoders`

Lists the available encoders used to embed documents and queries.

## Query parameters

- `filter` string
- `limit` integer
- `page_key` string

## Headers

- `Request-Timeout` integer
- `Request-Timeout-Millis` integer

## Response `200`

List of encoders.

- ListEncodersResponse — Response containing a list of available encoders for converting text to vector embeddings.
  - `encoders` Encoder[]
    - `id` string, required — The Encoder ID.
    - `name` string, required — The encoder name, for example `boomerang-2023-q3`.
    - `type` string — The encoder type
    - `output_dimensions` integer — The number of dimensions in the output embedding. A high dimensionality consumes more storage space but can increase the quality of the embedding.
    - `description` string — The encoder description.
    - `default` boolean — Indicates whether this is the default encoder used when you create a corpus.
    - `enabled` boolean — Indicates whether the encoder is enabled.
    - `image_encoding` boolean — Whether this encoder can produce embeddings for images, either of an image alone or jointly with accompanying text.
  - `metadata` ListMetadata — The standard metadata in the response of a list operation.
    - `page_key` string — The page key for the next page of results. Pass it as a query parameter to request the next page.

## Other responses

- `403` — Permissions do not allow listing encoders.

---

[API](https://skmtc.net/vectara/apis/vectara-rest-api-v2.md) · [All operations](https://skmtc.net/vectara/apis/vectara-rest-api-v2/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/vectara/vectara-rest-api-v2/revisions/a95087fe3a20/schema)