openrouter-python-sdk-retry-errors/docs/sdks/embeddings/README.md

Embeddings

Overview

Text embedding endpoints

Available Operations

• generate - Submit an embedding request
• list_models - List all embeddings models

generate

Submits an embedding request to the embeddings router

Example Usage

from openrouter import OpenRouter
import os


with OpenRouter(
    http_referer="<value>",
    x_open_router_title="<value>",
    x_open_router_categories="<value>",
    api_key=os.getenv("OPENROUTER_API_KEY", ""),
) as open_router:

    res = open_router.embeddings.generate(input="The quick brown fox jumps over the lazy dog", model="openai/text-embedding-3-small")

    # Handle response
    print(res)

Parameters

Parameter	Type	Required	Description	Example
input	operations.InputUnion	✔️	Text, token, or multimodal input(s) to embed	The quick brown fox jumps over the lazy dog
model	str	✔️	The model to use for embeddings	openai/text-embedding-3-small
http_referer	Optional[str]	➖	The app identifier should be your app's URL and is used as the primary identifier for rankings. This is used to track API usage per application.
x_open_router_title	Optional[str]	➖	The app display name allows you to customize how your app appears in OpenRouter's dashboard.
x_open_router_categories	Optional[str]	➖	Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
dimensions	Optional[int]	➖	The number of dimensions for the output embeddings	1536
encoding_format	Optional[operations.EncodingFormat]	➖	The format of the output embeddings	float
input_type	Optional[str]	➖	The type of input (e.g. search_query, search_document)	search_query
provider	OptionalNullable[components.ProviderPreferences]	➖	N/A	{ "allow_fallbacks": true }
user	Optional[str]	➖	A unique identifier for the end-user	user-1234
retries	Optional[utils.RetryConfig]	➖	Configuration to override the default retry behavior of the client.

Response

operations.CreateEmbeddingsResponse

Errors

Error Type	Status Code	Content Type
errors.BadRequestResponseError	400	application/json
errors.UnauthorizedResponseError	401	application/json
errors.PaymentRequiredResponseError	402	application/json
errors.NotFoundResponseError	404	application/json
errors.TooManyRequestsResponseError	429	application/json
errors.InternalServerResponseError	500	application/json
errors.BadGatewayResponseError	502	application/json
errors.ServiceUnavailableResponseError	503	application/json
errors.EdgeNetworkTimeoutResponseError	524	application/json
errors.ProviderOverloadedResponseError	529	application/json
errors.OpenRouterDefaultError	4XX, 5XX	*/*

list_models

Returns a list of all available embeddings models and their properties

Example Usage

from openrouter import OpenRouter
import os


with OpenRouter(
    http_referer="<value>",
    x_open_router_title="<value>",
    x_open_router_categories="<value>",
    api_key=os.getenv("OPENROUTER_API_KEY", ""),
) as open_router:

    res = open_router.embeddings.list_models()

    # Handle response
    print(res)

Parameters

Parameter	Type	Required	Description
http_referer	Optional[str]	➖	The app identifier should be your app's URL and is used as the primary identifier for rankings. This is used to track API usage per application.
x_open_router_title	Optional[str]	➖	The app display name allows you to customize how your app appears in OpenRouter's dashboard.
x_open_router_categories	Optional[str]	➖	Comma-separated list of app categories (e.g. "cli-agent,cloud-agent"). Used for marketplace rankings.
retries	Optional[utils.RetryConfig]	➖	Configuration to override the default retry behavior of the client.

Response

components.ModelsListResponse

Errors

Error Type	Status Code	Content Type
errors.BadRequestResponseError	400	application/json
errors.InternalServerResponseError	500	application/json
errors.OpenRouterDefaultError	4XX, 5XX	*/*