Scene Query Webservice

Trigger prompt

Trigger scene query with a custom prompt

post/api/scenequery/triggerPrompt

Request

  • Base URL: https://api2.rhombussystems.com
  • URL: https://api2.rhombussystems.com/api/scenequery/triggerPrompt
  • Auth: API key in header x-auth-apikey

Headers

x-auth-scheme'api-token' | 'api' | 'partner-api-token' | 'partner-api' 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.

Request body

deviceFacetUuidstring DeviceFacetUuid nullable

RUUID with optional appended facet information

multiImageTimeDeltasSecondsinteger[] nullable

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.

promptstring nullable

Prompt text to trigger

promptType'COUNT' | 'PERCENT' | 'BOOLEAN' | 'TEXT'
timestampMsinteger nullable

Timestamp in milliseconds for the trigger

Example request

{
  "deviceFacetUuid": "AAAAAAAAAAAAAAAAAAAAAA.v0",
  "multiImageTimeDeltasSeconds": [
    -10,
    -5,
    5
  ],
  "prompt": "Count people in the scene",
  "timestampMs": 1640995200000
}

Response

OK

errorboolean nullable
errorCodestring nullable

Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.

errorMsgstring nullable
warningMsgstring nullable

Changes

No recorded changes to this operation across all 1 revision of this API.