Skip to main content
POST
/
api
/
scenequery
/
triggerPrompt
Trigger prompt
curl --request POST \
  --url https://api2.rhombussystems.com/api/scenequery/triggerPrompt \
  --header 'Content-Type: application/json' \
  --header 'x-auth-apikey: <api-key>' \
  --header 'x-auth-scheme: <x-auth-scheme>' \
  --data '
{
  "deviceFacetUuid": "AAAAAAAAAAAAAAAAAAAAAA.v0",
  "prompt": "Count people in the scene",
  "promptType": "COUNT",
  "region": {
    "coordinates": [
      {
        "x": 123,
        "y": 123
      }
    ]
  },
  "timestampMs": 1640995200000
}
'
{
  "error": true,
  "errorMsg": "<string>",
  "event": {
    "checkCondition": true,
    "image": "<string>",
    "imageOffsets": [
      123
    ],
    "prompt": "<string>",
    "timestampMs": 123,
    "value": "<string>"
  },
  "warningMsg": "<string>"
}

Authorizations

x-auth-apikey
string
header
required

Your API key for Rhombus.

Headers

x-auth-scheme
string
default:api-token
required

Authentication scheme indicator ("api-token").

Required string length: 9

Body

application/json

Request object for triggering a prompt.

deviceFacetUuid
string<DeviceFacetUuid> | null

RUUID with optional appended facet information

Example:

"AAAAAAAAAAAAAAAAAAAAAA.v0"

prompt
string | null

Prompt text to trigger

Example:

"Count people in the scene"

promptType
enum<string> | null

Type of prompt to trigger

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

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