Semantic Search

Execute a semantic similarity search using dense vector embeddings.

This endpoint retrieves items by meaning rather than exact keyword matching. It supports two modes:

Text Mode:

  • Provide a text string (minimum 5 characters)
  • The server generates a 768-dimensional embedding using the multilingual-e5-small model
  • Results are ranked by cosine similarity to the generated embedding

Vector Mode:

  • Provide a pre-computed 768-dimensional vector
  • Useful when you have embeddings from another source or want to cache/reuse them
  • Results are ranked by cosine similarity to your provided vector

You must provide either text OR vector, but not both.

Result Ordering: Results are ordered by similarity score (highest first). Scores represent cosine similarity between the query and document vectors, ranging from 0.0 to 1.0 where 1.0 is identical.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
enum
required

The Elasticsearch index to search

Allowed:
string
length ≥ 5

Text query for semantic search. Minimum 5 characters. Cannot be used together with vector.

vector
array of numbers
length between 768 and 768

Pre-computed embedding vector. Must be exactly 768 dimensions (matching multilingual-e5-small model output). Cannot be used together with text.

vector
integer
1 to 10000
Defaults to 100

Number of results to return

boolean
Defaults to false

Return only document IDs without source data. Mutually exclusive with select_fields and include_vector.

select_fields
array of strings

Specific fields to return in results. Mutually exclusive with only_ids and include_vector.

select_fields
boolean
Defaults to false

Include vector embeddings in the response. Mutually exclusive with only_ids and select_fields.

Responses

Language
Credentials
Bearer
API Key
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json