Embeddings

Submit an embedding request

Changed on

Submits an embedding request to the embeddings router

post/embeddings

Request

  • Base URL: https://openrouter.ai/api/v1
  • URL: https://openrouter.ai/api/v1/embeddings
  • Auth: HTTP bearer

Request body

dimensionsinteger

The number of dimensions for the output embeddings

encoding_format'float' | 'base64'

The format of the output embeddings

input_typestring

The type of input (e.g. search_query, search_document)

modelstring required

The model to use for embeddings

session_idstring

A unique identifier for grouping related requests (e.g., a conversation or agent workflow). Used for observability grouping in Broadcast and private logging; never sent to the provider. If provided in both the request body and the x-session-id header, the body value takes precedence. Maximum of 256 characters.

userstring

A unique identifier for the end-user

Example request

{
  "dimensions": 1536,
  "input": "The quick brown fox jumps over the lazy dog",
  "model": "openai/text-embedding-3-small"
}

Response

Embedding response

idstring

Unique identifier for the embeddings response

modelstring required

The model used for embeddings

object'list' required

Example response

{
  "data": [
    {
      "embedding": [
        0.0023064255,
        -0.009327292,
        0.015797347
      ],
      "index": 0,
      "object": "embedding"
    }
  ],
  "model": "openai/text-embedding-3-small",
  "object": "list",
  "usage": {
    "prompt_tokens": 8,
    "total_tokens": 8
  }
}

Changes

  • 44cbdb6e22e2Revision changes
    • info

      added the non-success response with the status

  • 68a12e66c7faRevision changes
    • info

      added the new optional request property //////

    • info

      added the new ElevenLabs enum value to the request property //////////

    • info

      added the new ElevenLabs enum value to the request property //////////

    • info

      added the new ElevenLabs enum value to the request property //////////