Skip to main content
POST
Search similar object embeddings

Authorizations

x-auth-apikey
string
header
required

Your Rhombus API key. Must be accompanied by the x-auth-scheme header set to api-token (or partner-api-token for partner endpoints).

Headers

x-auth-scheme
enum<string>
default:api-token
required

Authentication scheme identifier. Use api-token for standard API key authentication, partner-api-token for partner API key authentication. Must be paired with the x-auth-apikey header containing your API key.

Available options:
api-token,
api,
partner-api-token,
partner-api

Body

application/json

Request object for searching similar object embeddings.

model
enum<string>
required

Model used for embeddings. The streaming variant of this search accepts only "CHARON".

Available options:
CLIP_512,
CHARON
queryEndTimeMs
integer<int64> | null
required
int64

End time in epoch milliseconds. Results returned will have occurred before this time.

queryStartTimeMs
integer<int64> | null
required
int64

Start time in epoch milliseconds. Results returned will have occurred after this time.

searchEmbeddingId
string | null
required

The id of the embedding event you want to find similar objects to. Typically this is obtained from a previous text search result.

includeVector
boolean | null
default:false

Whether to include the embedding vector in the response.

maxNumResults
integer<int32> | null
int32

Optional number of results to return. Setting to larger numbers will increase latency.

objectTypeFilter
(enum<string> | null)[] | null

Optional object type filter to narrow results to only vehicles or only humans.

Available options:
MOTION_HUMAN,
MOTION_CAR
queryDeviceUuids
(string<DeviceFacetUuid> | null)[] | null

Optional list of device uuids to filter result set on.

RUUID with optional appended facet information

Example:

"AAAAAAAAAAAAAAAAAAAAAA.v0"

regionFilter
((integer<int32> | null)[] | null)[] | null

Optional region filter to return results only if they overlap with the supplied region. This is a list of perymyriad points defining a polygon. The first and last elements must be the same to make a connected polygon. For example, a triangle should have 4 points defined in this list.

Permyriad point [x, y]

Permyriad point [x, y]

similarityThreshold
number<float> | null
float

Optional threshold applied to filter returned results, set as a float in [0.0, 1.0].

Response

200 - application/json

OK

Response object for searching similar object embeddings.

error
boolean | null
errorMsg
string | null
moderationReason
string | null

Reason for moderation if query is not allowed

queryAllowed
boolean | null

Whether the query is allowed

similarEmbeddings
object[] | null

List of similar object embedding matches

warningMsg
string | null
Last modified on August 22, 2026