Skip to main content
POST
Trigger prompt

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 triggering a prompt.

deviceFacetUuid
string<DeviceFacetUuid> | null
DeviceFacetUuid

RUUID with optional appended facet information

Example:

"AAAAAAAAAAAAAAAAAAAAAA.v0"

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

Optional list of time deltas in seconds (relative to timestampMs) for multi-image mode. Max 5 entries, each in range [-30, 3600]. When non-empty, the prompt runs against a set of frames: the base image at timestampMs (always included) plus one frame per distinct non-zero delta. Duplicates and 0 are deduped. Omit or send null/empty for single-image mode.

Optional list of time deltas in seconds (relative to timestampMs) for multi-image mode. Max 5 entries, each in range [-30, 3600]. When non-empty, the prompt runs against a set of frames: the base image at timestampMs (always included) plus one frame per distinct non-zero delta. Duplicates and 0 are deduped. Omit or send null/empty for single-image mode.

Example:
prompt
string | null

Prompt text to trigger

Example:

"Count people in the scene"

promptType
enum<string>
Available options:
COUNT,
PERCENT,
BOOLEAN,
TEXT
region
object
timestampMs
integer<int64> | null
int64

Timestamp in milliseconds for the trigger

Example:

1640995200000

Response

200 - application/json

OK

Response object for triggering a prompt.

error
boolean | null
errorMsg
string | null
event
object

Scene query report event from the triggered prompt

warningMsg
string | null
Last modified on July 24, 2026