v2

OpenAPI 3.0.02026-08-051996591.2 MB
Encoders

List encoders

Lists the available encoders used to embed documents and queries.

get/v2/encoders

Query parameters

filterstring
Example:vectara.*

A regular expression against encoder names and descriptions.

limitinteger

The maximum number of results to return in the list.

page_keystring

The opaque cursor returned in metadata.page_key of the previous response. Omit it to fetch the first page.

Headers

Request-Timeoutinteger

The platform makes a best effort to complete the request in the specified seconds, or it times out.

Request-Timeout-Millisinteger

The platform makes a best effort to complete the request in the specified milliseconds, or it times out.

Response

List of encoders.

Example response

{
  "encoders": [
    {
      "id": "enc_1",
      "name": "openai-text-encoder",
      "type": "openai-compatible",
      "output_dimensions": 1536,
      "default": true,
      "enabled": true
    }
  ],
  "metadata": {
    "page_key": "eyJvZmZzZXQiOjF9"
  }
}