Skip to main content
POST
/
api
/
search
/
searchSimilarObjectEmbeddingsByText
Search similar object embeddings by text
curl --request POST \
  --url https://api2.rhombussystems.com/api/search/searchSimilarObjectEmbeddingsByText \
  --header 'Content-Type: application/json' \
  --header 'x-auth-apikey: <api-key>' \
  --header 'x-auth-scheme: <x-auth-scheme>' \
  --data '
{
  "queryEndTimeMs": 123,
  "queryStartTimeMs": 123,
  "searchText": "<string>"
}
'
{
  "error": true,
  "errorMsg": "<string>",
  "moderationReason": "<string>",
  "queryAllowed": true,
  "similarEmbeddings": [
    {
      "distance": 123,
      "embedding": {
        "b": 123,
        "deviceUuid": "AAAAAAAAAAAAAAAAAAAAAA.v0",
        "embedding": [
          123
        ],
        "embeddingId": "<string>",
        "l": 123,
        "locationUuid": "AAAAAAAAAAAAAAAAAAAAAA",
        "objectId": 123,
        "objectType": "<string>",
        "orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
        "r": 123,
        "stableTrackId": 123,
        "t": 123,
        "thumbnailLocation": "<string>",
        "thumbnailUri": "<string>",
        "timestamp": 123
      },
      "matchedEmbeddingId": "AAAAAAAAAAAAAAAAAAAAAA"
    }
  ],
  "warningMsg": "<string>"
}

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 by text.

model
enum<string>
required

Object search model to use for embeddings

Available options:
CLIP_512,
UNKNOWN,
REIDENTIFICATION_NET,
PERSON_VIT,
PERSON_VITS,
CLIP_REID,
DINOV3,
SWIN_BASE,
SWIN_SMALL,
PERSON_VIT_SHADOW,
CHARON
queryEndTimeMs
integer<int64> | null
required

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

queryStartTimeMs
integer<int64> | null
required

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

searchText
string | null
required

The search text to find similar objects to. Phrases like "red sedan", "person in yellow shirt", etc.

includeVector
boolean | null
default:false

Whether to include the embedding vector in the response.

maxNumResults
integer<int32> | null

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

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

Optional object type filter. Provide explicit type values to narrow results, or omit to search all object types. Pass the single value "AUTO" to have the server infer the object type (humans or vehicles) from the search text.

Available options:
MOTION_HUMAN,
MOTION_CAR,
AUTO
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

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 July 7, 2026