openrouter/router/openai/v1/embeddings

Generate text embeddings using OpenAI-compatible API. Access embedding models like text-embedding-3-small, text-embedding-3-large (OpenAI), and other embedding models available through OpenRouter. Drop-in replacement for the OpenAI embeddings API. Powered by OpenRouter.

Inference

Commercial use

Schema

LLMs

Playground API

About

Generate embeddings using any embedding model with fal, powered by OpenRouter. This endpoint is compatible with the OpenAI API. You can use this endpoint with any OpenAI compatible client.

1. Calling the API#

Install the client#

The client provides a convenient way to interact with the model API.

npm install --save @fal-ai/client

Migrate to @fal-ai/client

The @fal-ai/serverless-client package has been deprecated in favor of @fal-ai/client. Install the new package and update your imports — see client setup.

Setup your API Key#

Set FAL_KEY as an environment variable in your runtime.

export FAL_KEY="YOUR_API_KEY"

Submit a request#

The client API handles the API submit protocol. It will handle the request status updates and return the result when the request is completed.

import { fal } from "@fal-ai/client";

const result = await fal.subscribe("openrouter/router/openai/v1/embeddings", {
  input: {},
  logs: true,
  onQueueUpdate: (update) => {
    if (update.status === "IN_PROGRESS") {
      update.logs.map((log) => log.message).forEach(console.log);
    }
  },
});
console.log(result.data);
console.log(result.requestId);

2. Authentication#

The API uses an API Key for authentication. It is recommended you set the FAL_KEY environment variable in your runtime when possible.

API Key#

In case your app is running in an environment where you cannot set environment variables, you can set the API Key manually as a client configuration.

import { fal } from "@fal-ai/client";

fal.config({
  credentials: "YOUR_FAL_KEY"
});

Protect your API Key

When running code on the client-side (e.g. in a browser, mobile app or GUI applications), make sure to not expose your FAL_KEY. Instead, use a server-side proxy to make requests to the API. For more information, check out our server-side integration guide.

3. Queue#

Long-running requests

For long-running requests, such as training jobs or models with slower inference times, it is recommended to check the Queue status and rely on Webhooks instead of blocking while waiting for the result.

Submit a request#

The client API provides a convenient way to submit requests to the model.

import { fal } from "@fal-ai/client";

const { request_id } = await fal.queue.submit("openrouter/router/openai/v1/embeddings", {
  input: {},
  webhookUrl: "https://optional.webhook.url/for/results",
});

Fetch request status#

You can fetch the status of a request to check if it is completed or still in progress.

import { fal } from "@fal-ai/client";

const status = await fal.queue.status("openrouter/router/openai/v1/embeddings", {
  requestId: "764cabcf-b745-4b3e-ae38-1200304cf45b",
  logs: true,
});

Get the result#

Once the request is completed, you can fetch the result. See the Output Schema for the expected result format.

import { fal } from "@fal-ai/client";

const result = await fal.queue.result("openrouter/router/openai/v1/embeddings", {
  requestId: "764cabcf-b745-4b3e-ae38-1200304cf45b"
});
console.log(result.data);
console.log(result.requestId);

4. Files#

Some attributes in the API accept file URLs as input. Whenever that's the case you can pass your own URL or a Base64 data URI.

Data URI (base64)#

You can pass a Base64 data URI as a file input. The API will handle the file decoding for you. Keep in mind that for large files, this alternative although convenient can impact the request performance.

Hosted files (URL)#

You can also pass your own URLs as long as they are publicly accessible. Be aware that some hosts might block cross-site requests, rate-limit, or consider the request as a bot.

Uploading files#

We provide a convenient file storage that allows you to upload files and use them in your requests. You can upload files using the client API and use the returned URL in your requests.

import { fal } from "@fal-ai/client";

const file = new File(["Hello, World!"], "hello.txt", { type: "text/plain" });
const url = await fal.storage.upload(file);

Auto uploads

The client will auto-upload the file for you if you pass a binary object (e.g. File, Data).

Read more about file handling in our file upload guide.

5. Schema#

Input#

{}

Output#

{}

Other types#

WebSearchUserLocation#

type string

Location type. Only 'approximate' is supported. Default value: "approximate"

city string

City name, e.g. 'San Francisco'.

region string

Region or state, e.g. 'California'.

country string

Two-letter country code, e.g. 'US'.

timezone string

IANA timezone, e.g. 'America/Los_Angeles'.

UsageInfo#

prompt_tokens integer

completion_tokens integer

total_tokens integer

cost float* required

prompt_tokens_details PromptTokensDetails

OpenAIResponsesResponse#

WebSearchOptions#

engine EngineEnum

Search engine to use. 'auto' uses native provider search when available and falls back to Exa. 'native' prefers the provider's built-in web search (OpenAI, Anthropic, Google, xAI, Perplexity), falling back to Exa for models without native support. 'exa' always uses Exa's search API. Default value: "auto"

Possible enum values: auto, native, exa

max_results integer

Maximum results per search call (1-25). Applies to the Exa engine; ignored with native provider search. Defaults to 5.

max_uses integer

Maximum number of searches the model may perform in a single request. Once reached, further search calls return an error result instead of executing. With native provider search, forwarded only to Anthropic; other native providers ignore it.

max_total_results integer

Maximum total results across all search calls in a single request. Useful for controlling cost and context size in agentic loops.

search_context_size Enum

How much content to retrieve per result. For Exa: low=5K, medium=15K, high=30K characters per result; when omitted, Exa picks adaptively (~2-4K per result). Ignored with native provider search. Overridden by max_characters when both are set.

Possible enum values: low, medium, high

max_characters integer

Exact maximum characters of content per result (1-100,000). Applies to the Exa engine; ignored with native provider search. Takes precedence over search_context_size when both are set.

allowed_domains list<string>

Limit results to these domains. Supported by Exa and most native providers (not Google native search).

excluded_domains list<string>

Exclude results from these domains. Supported by Exa and some native providers (not OpenAI or Google native search).

user_location WebSearchUserLocation

Approximate user location for location-biased results. Only supported by native provider search; ignored by Exa.

OpenAIResponsesRequest#

PromptTokensDetails#

cached_tokens integer

cache_write_tokens integer

openrouter/router/openai/v1/embeddings

Table of contents

1. Calling the API

2. Authentication

3. Queue

4. Files

5. Schema

About

1. Calling the API#

Install the client#

Migrate to @fal-ai/client

Setup your API Key#

Submit a request#

2. Authentication#

API Key#

Protect your API Key

3. Queue#

Long-running requests

Submit a request#

Fetch request status#

Get the result#

4. Files#

Data URI (base64)#

Hosted files (URL)#

Uploading files#

Auto uploads

5. Schema#

Input#

Output#

Other types#

WebSearchUserLocation#

UsageInfo#

OpenAIResponsesResponse#

WebSearchOptions#

OpenAIResponsesRequest#

PromptTokensDetails#

OpenAIChatCompletionsResponse#

OpenAIChatCompletionsRequest#

Related Models