> ## Documentation index
> Fetch the complete documentation index at: https://developer.rhombus.com/llms.txt
> Use it to discover all available pages before exploring further.

# Update prompt configuration

> Update scene query configuration

```http
POST https://api2.rhombussystems.com/api/scenequery/updatePromptConfiguration
```

EU organizations send the same request to `https://api2.eu.rhombussystems.com`.

## Authentication and parameters

- `x-auth-apikey` (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).
- `Authorization` (header): instead of an API key, an OAuth access token (`Bearer <token>`) with the `write` scope.
- `x-auth-scheme` (header, string, default: `api-token`): Authentication scheme identifier. Use `api-token` or `partner-api-token` with the `x-auth-apikey` header, `api` or `partner-api` with `x-auth-apikey` plus a client certificate, `api-oauth-token` or `partner-api-oauth-token` with `x-auth-access-token`, and `federated-token` with `x-auth-ft`. A request with `Authorization: Bearer <token>` and no `x-auth-scheme` is treated as OAuth, and `federated-token` may also be sent as the `x-auth-scheme` and `x-auth-ft` query parameters. One of: `api-token`, `api`, `api-oauth-token`, `federated-token`, `partner-api-token`, `partner-api`, `partner-api-oauth-token`.
- `x-auth-org` (header, string<RUUID>): Client organization UUID (22-character RUUID), for partner credentials only. With it the call runs in that client organization with the partner support authority's role. Without it a partner credential runs as the partner organization, which outside the partner endpoints is deprecated (responses carry `Deprecation` and `Sunset: Tue, 05 Jan 2027 00:00:00 GMT`). A malformed value returns 400 `INVALID_AUTH_ORG`; a client organization the partner cannot access returns 403 `PARTNER_CLIENT_ACCESS_DENIED`.

## Request body

Content type: `application/json`. Request object for updating a prompt configuration.

- `promptConfiguration` (object): Updated prompt configuration

## Response 200

OK. Content type: `application/json`

- `error` (boolean | null)
- `errorCode` (string | null): Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.
- `errorMsg` (string | null)
- `promptConfiguration` (object): Updated prompt configuration
- `warningMsg` (string | null)

## Errors

Also 400, 401, 403, 429, 500, 503 with the standard error body (`errorCode`, `errorMsg`): https://developer.rhombus.com/errors

## OpenAPI

````yaml
openapi: 3.0.1
info:
  title: Rhombus API
  version: "1.0"
servers:
  - description: Production Server
    url: https://api2.rhombussystems.com
security:
  - ApiKeyAuth: []
paths:
  /api/scenequery/updatePromptConfiguration:
    post:
      description: Update scene query configuration
      operationId: updatePromptConfiguration
      parameters:
        - description: "Authentication scheme identifier. Use `api-token` or `partner-api-token` with the `x-auth-apikey` header, `api` or `partner-api` with `x-auth-apikey` plus a client certificate, `api-oauth-token` or `partner-api-oauth-token` with `x-auth-access-token`, and `federated-token` with `x-auth-ft`. A request with `Authorization: Bearer <token>` and no `x-auth-scheme` is treated as OAuth, and `federated-token` may also be sent as the `x-auth-scheme` and `x-auth-ft` query parameters."
          example: api-token
          in: header
          name: x-auth-scheme
          required: false
          schema:
            default: api-token
            enum:
              - api-token
              - api
              - api-oauth-token
              - federated-token
              - partner-api-token
              - partner-api
              - partner-api-oauth-token
            type: string
        - description: "Client organization UUID (22-character RUUID), for partner credentials only. With it the call runs in that client organization with the partner support authority's role. Without it a partner credential runs as the partner organization, which outside the partner endpoints is deprecated (responses carry `Deprecation` and `Sunset: Tue, 05 Jan 2027 00:00:00 GMT`). A malformed value returns 400 `INVALID_AUTH_ORG`; a client organization the partner cannot access returns 403 `PARTNER_CLIENT_ACCESS_DENIED`."
          in: header
          name: x-auth-org
          required: false
          schema:
            format: RUUID
            maxLength: 22
            minLength: 22
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/Scenequery_UpdatePromptConfigurationWSRequest"
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Scenequery_UpdatePromptConfigurationWSResponse"
          description: OK
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "403":
          $ref: "#/components/responses/Forbidden"
        "429":
          $ref: "#/components/responses/TooManyRequests"
        "500":
          $ref: "#/components/responses/InternalServerError"
        "503":
          $ref: "#/components/responses/ServiceUnavailable"
      security:
        - ApiKeyAuth: []
        - oauth2:
            - write
      summary: Update prompt configuration
      tags:
        - Scene Query Webservice
components:
  schemas:
    Scenequery_UpdatePromptConfigurationWSRequest:
      description: Request object for updating a prompt configuration.
      properties:
        promptConfiguration:
          $ref: "#/components/schemas/PromptConfigurationType"
      type: object
    PromptConfigurationType:
      description: Updated prompt configuration
      properties:
        active:
          nullable: true
          type: boolean
        cameraConfigurations:
          items:
            $ref: "#/components/schemas/CameraConfiguration"
          nullable: true
          type: array
        checkCondition:
          $ref: "#/components/schemas/CheckCondition"
        description:
          nullable: true
          type: string
        generateAlertForActionNewlyAddedCameras:
          nullable: true
          type: boolean
        multiImageTimeDeltasSeconds:
          items:
            format: int32
            nullable: true
            type: integer
          nullable: true
          type: array
        name:
          nullable: true
          type: string
        orgUuid:
          description: base 64 (url-safe) uuid string
          example: AAAAAAAAAAAAAAAAAAAAAA
          format: RUUID
          nullable: true
          type: string
        prompt:
          nullable: true
          type: string
        promptType:
          $ref: "#/components/schemas/PromptTypeEnum"
        reportsEnabled:
          nullable: true
          type: boolean
        scheduleUuid:
          description: base 64 (url-safe) uuid string
          example: AAAAAAAAAAAAAAAAAAAAAA
          format: RUUID
          nullable: true
          type: string
        shortName:
          nullable: true
          type: string
        trigger:
          $ref: "#/components/schemas/Trigger"
        uuid:
          description: base 64 (url-safe) uuid string
          example: AAAAAAAAAAAAAAAAAAAAAA
          format: RUUID
          nullable: true
          type: string
      type: object
    CameraConfiguration:
      properties:
        cameraUuid:
          description: RUUID with optional appended facet information
          example: AAAAAAAAAAAAAAAAAAAAAA.v0
          format: DeviceFacetUuid
          nullable: true
          type: string
        checkConditionOverride:
          $ref: "#/components/schemas/CheckCondition"
        exampleImages:
          items:
            $ref: "#/components/schemas/ExampleImage"
          nullable: true
          type: array
        promptExtension:
          nullable: true
          type: string
        promptOverride:
          nullable: true
          type: string
        region:
          $ref: "#/components/schemas/RegionPolygonType"
        scheduledActions:
          items:
            $ref: "#/components/schemas/ScheduledAction"
          nullable: true
          type: array
      type: object
    CheckCondition:
      nullable: true
      properties:
        operator:
          $ref: "#/components/schemas/OPERATOREnum"
        value:
          nullable: true
          type: string
      type: object
    OPERATOREnum:
      enum:
        - GT
        - LT
        - LTE
        - GTE
        - EQ
        - CONTAINS
      type: string
    ExampleImage:
      properties:
        image:
          nullable: true
          type: string
        imageUuid:
          description: base 64 (url-safe) uuid string
          example: AAAAAAAAAAAAAAAAAAAAAA
          format: RUUID
          nullable: true
          type: string
        label:
          nullable: true
          type: string
      type: object
    RegionPolygonType:
      properties:
        coordinates:
          items:
            $ref: "#/components/schemas/RegionCoordinateType"
          nullable: true
          type: array
      type: object
    RegionCoordinateType:
      properties:
        x:
          format: float
          nullable: true
          type: number
        y:
          format: float
          nullable: true
          type: number
      type: object
    ScheduledAction:
      properties:
        action:
          $ref: "#/components/schemas/RuleActionType"
        backoffMinutes:
          format: int32
          nullable: true
          type: integer
        backoffSeconds:
          format: int32
          nullable: true
          type: integer
        ruleUuid:
          description: base 64 (url-safe) uuid string
          example: AAAAAAAAAAAAAAAAAAAAAA
          format: RUUID
          nullable: true
          type: string
        scheduleUuid:
          description: base 64 (url-safe) uuid string
          example: AAAAAAAAAAAAAAAAAAAAAA
          format: RUUID
          nullable: true
          type: string
      type: object
    RuleActionType:
      description: The action to take when this lockdown rule is triggered.
      properties:
        activateLocationLockdown:
          $ref: "#/components/schemas/ActivateLocationLockdownActionType"
        alertAction:
          nullable: true
          type: boolean
        audioPlaybackActions:
          items:
            $ref: "#/components/schemas/AudioPlaybackActionType"
          nullable: true
          type: array
        cancelLoopingAudioPlaybackAction:
          $ref: "#/components/schemas/CancelLoopingAudioPlaybackActionType"
        changeComponentCompositeAccessStateActions:
          items:
            $ref: "#/components/schemas/ChangeComponentCompositeAccessStateActionType"
          nullable: true
          type: array
        connectAudioDeviceToMobileAppAction:
          $ref: "#/components/schemas/ConnectAudioDeviceToMobileAppActionType"
        connectAudioDeviceToPhoneNumberAction:
          $ref: "#/components/schemas/ConnectAudioDeviceToPhoneNumberActionType"
        createAlarmAction:
          $ref: "#/components/schemas/CreateAlarmActionType"
        customActions:
          items:
            $ref: "#/components/schemas/CustomRuleAction"
          nullable: true
          type: array
        customLLMActions:
          items:
            $ref: "#/components/schemas/CustomLLMActionType"
          nullable: true
          type: array
        emailAuditLogExportActions:
          items:
            $ref: "#/components/schemas/EmailAuditLogExportActionType"
          nullable: true
          type: array
        enableDisableAudioRecordActions:
          items:
            $ref: "#/components/schemas/EnableDisableAudioRecordActionType"
          nullable: true
          type: array
        integrationCommandActions:
          items:
            $ref: "#/components/schemas/IntegrationCommandActionType"
          nullable: true
          type: array
        integrationNotificationActions:
          items:
            $ref: "#/components/schemas/IntegrationNotificationActionType"
          nullable: true
          type: array
        liveNotificationAction:
          nullable: true
          type: boolean
        remoteDoorUnlockActions:
          items:
            $ref: "#/components/schemas/RemoteDoorUnlockActionType"
          nullable: true
          type: array
        robotActions:
          items:
            $ref: "#/components/schemas/RobotAction"
          nullable: true
          type: array
        thirdPartyAudioPlaybackAction:
          $ref: "#/components/schemas/ThirdPartyAudioPlaybackActionType"
        thirdPartyStrobeSirenAction:
          $ref: "#/components/schemas/ThirdPartyStrobeSirenActionType"
        triggerComponentRelayActions:
          items:
            $ref: "#/components/schemas/TriggerComponentRelayActionType"
          nullable: true
          type: array
        webhookActions:
          items:
            $ref: "#/components/schemas/WebhookActionType"
          nullable: true
          type: array
      type: object
    ActivateLocationLockdownActionType:
      properties:
        locationLockdownPlanUuid:
          description: base 64 (url-safe) uuid string
          example: AAAAAAAAAAAAAAAAAAAAAA
          format: RUUID
          nullable: true
          type: string
        locationUuid:
          description: base 64 (url-safe) uuid string
          example: AAAAAAAAAAAAAAAAAAAAAA
          format: RUUID
          nullable: true
          type: string
      type: object
    AudioPlaybackActionType:
      properties:
        audioClipUuid:
          description: base 64 (url-safe) uuid string
          example: AAAAAAAAAAAAAAAAAAAAAA
          format: RUUID
          nullable: true
          type: string
        audioGateways:
          items:
            description: base 64 (url-safe) uuid string
            example: AAAAAAAAAAAAAAAAAAAAAA
            format: RUUID
            nullable: true
            type: string
          nullable: true
          type: array
        loopDurationSec:
          format: int32
          nullable: true
          type: integer
        playCount:
          format: int32
          nullable: true
          type: integer
        source:
          $ref: "#/components/schemas/AudioPlaybackSourceEnum"
      type: object
    AudioPlaybackSourceEnum:
      enum:
        - ON_DEVICE
        - STREAM
      type: string
    CancelLoopingAudioPlaybackActionType:
      properties:
        _audioDevices:
          items:
            description: RUUID with optional appended facet information
            example: AAAAAAAAAAAAAAAAAAAAAA.v0
            format: DeviceFacetUuid
            nullable: true
            type: string
          nullable: true
          type: array
        audioDevices:
          items:
            description: RUUID with optional appended facet information
            example: AAAAAAAAAAAAAAAAAAAAAA.v0
            format: DeviceFacetUuid
            nullable: true
            type: string
          nullable: true
          type: array
      type: object
    ChangeComponentCompositeAccessStateActionType:
      properties:
        accessState:
          $ref: "#/components/schemas/AccessControlledDoorStateEnumType"
        alwaysCreateOverrideIfNoFirstIn:
          nullable: true
          type: boolean
        componentCompositeUuid:
          description: base 64 (url-safe) uuid string
          example: AAAAAAAAAAAAAAAAAAAAAA
          format: RUUID
          nullable: true
          type: string
        expirationStrategy:
          $ref: "#/components/schemas/AccessStateOverrideExpirationStrategyEnum"
        expireTimeDelaySeconds:
          format: int64
          nullable: true
          type: integer
        expireTimeOfDayLocalSeconds:
          format: int64
          nullable: true
          type: integer
        useFirstInRulesIfPossible:
          nullable: true
          type: boolean
        version:
          format: int32
          nullable: true
          readOnly: true
          type: integer
      type: object
    AccessControlledDoorStateEnumType:
      enum:
        - UNLOCKED
        - ACCESS_CONTROLLED
      type: string
    AccessStateOverrideExpirationStrategyEnum:
      enum:
        - TIME_DELAY
        - TIME_OF_DAY_LOCAL
        - NONE
      type: string
    ConnectAudioDeviceToMobileAppActionType:
      properties:
        audioDeviceUuid:
          description: base 64 (url-safe) uuid string
          example: AAAAAAAAAAAAAAAAAAAAAA
          format: RUUID
          nullable: true
          type: string
        deviceType:
          $ref: "#/components/schemas/DeviceTypeEnum"
        doorUuid:
          description: base 64 (url-safe) uuid string
          example: AAAAAAAAAAAAAAAAAAAAAA
          format: RUUID
          nullable: true
          type: string
        targetDoorStationUuids:
          items:
            description: base 64 (url-safe) uuid string
            example: AAAAAAAAAAAAAAAAAAAAAA
            format: RUUID
            nullable: true
            type: string
          nullable: true
          type: array
        targetUserUuids:
          items:
            description: base 64 (url-safe) uuid string
            example: AAAAAAAAAAAAAAAAAAAAAA
            format: RUUID
            nullable: true
            type: string
          nullable: true
          type: array
      type: object
    DeviceTypeEnum:
      enum:
        - BLE_TRACKER
        - CAMERA
        - DOOR_SENSOR
        - ENVIRONMENTAL_SENSOR
        - OCCUPANCY_SENSOR
        - AUDIO_GATEWAY
        - EXECUTABLE
        - BADGE_READER
        - DOOR_CONTROLLER
        - BLE_BUTTON
        - IO_BOARD
        - ENVIRONMENTAL_GATEWAY
        - NVR
        - ROBOT
        - UNKNOWN
      type: string
    ConnectAudioDeviceToPhoneNumberActionType:
      properties:
        audioDeviceUuid:
          description: base 64 (url-safe) uuid string
          example: AAAAAAAAAAAAAAAAAAAAAA
          format: RUUID
          nullable: true
          type: string
        deviceType:
          $ref: "#/components/schemas/DeviceTypeEnum"
        doorUuid:
          description: base 64 (url-safe) uuid string
          example: AAAAAAAAAAAAAAAAAAAAAA
          format: RUUID
          nullable: true
          type: string
        optionalGreeting:
          nullable: true
          type: string
        phoneNumber:
          nullable: true
          type: string
      type: object
    CreateAlarmActionType:
      properties:
        attachMediaToActiveAlarm:
          nullable: true
          type: boolean
        entryInstructions:
          nullable: true
          type: string
        exclusiveEmergencyContact:
          nullable: true
          type: boolean
        exclusiveEntryInstructions:
          nullable: true
          type: boolean
        locationUuid:
          description: base 64 (url-safe) uuid string
          example: AAAAAAAAAAAAAAAAAAAAAA
          format: RUUID
          nullable: true
          type: string
        mediaDeviceUuids:
          items:
            description: RUUID with optional appended facet information
            example: AAAAAAAAAAAAAAAAAAAAAA.v0
            format: DeviceFacetUuid
            nullable: true
            type: string
          nullable: true
          type: array
        onsiteEmergencyContact:
          $ref: "#/components/schemas/EmergencyContact"
        reason:
          nullable: true
          type: string
        sirenSettings:
          $ref: "#/components/schemas/AMSirenSettingsType"
        subLocationsHierarchyKey:
          description: |
            A sequence of one or more base 64 (url-safe) uuid substrings.
            These substrings are separated by dots (.).
          example: AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA
          format: SubLocationsHierarchyKey
          nullable: true
          pattern: ^([A-Za-z0-9\-_]{22})([.][A-Za-z0-9\-_]{22})*$
          type: string
        triggerType:
          $ref: "#/components/schemas/CreateAlarmTriggerTypeEnum"
      type: object
    EmergencyContact:
      properties:
        name:
          description: The name of the emergency contact.
          nullable: true
          type: string
        phoneNumber:
          description: The phone number for this emergency contact.
          nullable: true
          type: string
      required:
        - name
        - phoneNumber
      type: object
    AMSirenSettingsType:
      properties:
        audioGateways:
          description: UUIDs of audio gateways used to play this siren.
          items:
            description: base 64 (url-safe) uuid string
            example: AAAAAAAAAAAAAAAAAAAAAA
            format: RUUID
            nullable: true
            type: string
          nullable: true
          type: array
          uniqueItems: true
        clipUuid:
          description: base 64 (url-safe) uuid string
          example: AAAAAAAAAAAAAAAAAAAAAA
          format: RUUID
          nullable: true
          type: string
        durationSeconds:
          description: The duration (in seconds) to loop the clip audio for the siren.
          format: int32
          nullable: true
          type: integer
        playCount:
          description: The number of times to play the clip audio for the siren.
          format: int32
          nullable: true
          type: integer
      required:
        - audioGateways
        - clipUuid
      type: object
    CreateAlarmTriggerTypeEnum:
      enum:
        - PANIC_BUTTON
        - ALARM_INTEGRATION
      type: string
    CustomRuleAction:
      properties:
        headers:
          additionalProperties:
            nullable: true
            type: string
          nullable: true
          type: object
        path:
          nullable: true
          type: string
      type: object
    CustomLLMActionType:
      properties:
        deviceActivityEvents:
          additionalProperties:
            items:
              $ref: "#/components/schemas/ActivityEventData"
            nullable: true
            type: array
          nullable: true
          type: object
        deviceFacetUuids:
          items:
            description: RUUID with optional appended facet information
            example: AAAAAAAAAAAAAAAAAAAAAA.v0
            format: DeviceFacetUuid
            nullable: true
            type: string
          nullable: true
          type: array
        orgUuid:
          description: base 64 (url-safe) uuid string
          example: AAAAAAAAAAAAAAAAAAAAAA
          format: RUUID
          nullable: true
          type: string
        promptUuid:
          description: base 64 (url-safe) uuid string
          example: AAAAAAAAAAAAAAAAAAAAAA
          format: RUUID
          nullable: true
          type: string
        timestampMs:
          format: int64
          nullable: true
          type: integer
      type: object
    ActivityEventData:
      properties:
        activities:
          items:
            $ref: "#/components/schemas/ActivityEnum"
          nullable: true
          type: array
        boundingBoxes:
          items:
            $ref: "#/components/schemas/ClipBoundingBoxType"
          nullable: true
          type: array
        durationSec:
          format: int32
          nullable: true
          type: integer
        timestampMs:
          format: int64
          nullable: true
          type: integer
      type: object
    ActivityEnum:
      enum:
        - SOUND_LOUD
        - SOUND_GUN_SHOT
        - TAMPER
        - VISUAL_TAMPER
        - MOTION_TAMPER
        - MOTION
        - MOTION_HUMAN
        - MOTION_CAR
        - MOTION_ANIMAL
        - MOTION_PACKAGE
        - PACKAGE_ARRIVED
        - PACKAGE_DEPARTED
        - FACE
        - FACE_IDENTIFIED
        - FACE_UNIDENTIFIED
        - FACE_BLACKLISTED
        - FACE_ALERT
        - POSE_ANOMALOUS
        - POSE_FALL
        - LICENSEPLATE
        - LICENSEPLATE_IDENTIFIED
        - LICENSEPLATE_UNIDENTIFIED
        - LICENSEPLATE_ALERT
        - LICENSEPLATE_BLACKLISTED
        - LICENSEPLATE_TRUSTED
        - PEOPLECOUNT_HIGH
        - PEOPLECOUNT_HIGH_RESET
        - PEOPLECOUNT_LOW
        - PEOPLECOUNT_LOW_RESET
        - HUMAN_ENTER
        - HUMAN_EXIT
        - CAR_ENTER
        - CAR_EXIT
        - TEMPERATURE_EXCEEDED_HIGH
        - TEMPERATURE_EXCEEDED_LOW
        - HUMIDITY_EXCEEDED_HIGH
        - HUMIDITY_EXCEEDED_LOW
        - PM25_EXCEEDED_HIGH
        - TVOC_EXCEEDED_HIGH
        - ETOH_EXCEEDED_HIGH
        - IAQ_EXCEEDED_HIGH
        - CO2_EXCEEDED_HIGH
        - CO2_EXCEEDED_LOW
        - PROBE_TEMPERATURE_EXCEEDED_HIGH
        - PROBE_TEMPERATURE_EXCEEDED_LOW
        - PROBE_DISCONNECTED
        - PROBE_CONNECTED
        - HEAT_INDEX_EXCEEDED_HIGH
        - PRESSURE_EXCEEDED_HIGH
        - PRESSURE_EXCEEDED_LOW
        - PM10_EXCEEDED_HIGH
        - PM40_EXCEEDED_HIGH
        - PM100_EXCEEDED_HIGH
        - VOC_IDX_EXCEEDED_HIGH
        - NOX_IDX_EXCEEDED_HIGH
        - FORMALDEHYDE_EXCEEDED_HIGH
        - CARBON_MONOXIDE_EXCEEDED_HIGH
        - AQI_EXCEEDED_HIGH
        - DOOR_AJAR
        - DOOR_OPENED
        - DOOR_CLOSED
        - BUTTON_SINGLE_PRESSED
        - BUTTON_DOUBLE_PRESSED
        - BUTTON_LONG_PRESSED
        - TAG_ARRIVED
        - TAG_DEPARTED
        - TAG_MOVED
        - TAG_POSITIONING_CHANGED
        - TAG_BOUNDARY_INGRESS
        - TAG_BOUNDARY_EGRESS
        - TAG_PANIC
        - BADGE_AUTHORIZED
        - BADGE_UNAUTHORIZED
        - BADGE_UNAUTHORIZED_V2
        - BADGE_AJAR
        - BADGE_MANUAL
        - BADGE_FORCED_OPEN
        - BADGE_LOCKDOWN
        - BADGE_REQUEST_TO_EXIT
        - BADGE_DURESS
        - BADGE_SECURITY_BREACH
        - BADGE_TAMPER
        - BADGE_FACE_MISMATCH
        - POS_ORDER
        - GUN_DETECT_EVENT
        - IOT_SOUND_AGGRESSION
        - IOT_SOUND_HELP
        - IOT_AIR_CO
        - IOT_AIR_CO2
        - IOT_AIR_MASKING
        - IOT_AIR_THC
        - IOT_AIR_VAPE
        - IOT_AIR_VOC
        - IOT_AIR_TEMP
        - IOT_TAMPER
        - IOT_GUNSHOT
        - IOT_BUTTON_SINGLE_CLICK
        - IOT_BUTTON_DOUBLE_CLICK
        - IOT_BUTTON_HOLD
        - IOT_PANIC_BUTTON_TRIGGERED
        - AUDIO_SOUND_SIGNIFICANT
        - AUDIO_SOUND_LOUD
        - AUDIO_SOUND_ABUSIVE
        - AUDIO_SOUND_GREETING
        - AUDIO_SOUND_HELP
        - AUDIO_SOUND_GUN
        - AUDIO_SOUND_GLASS_BREAK
        - AUDIO_SOUND_ALARM_SMOKE_FIRE
        - AUDIO_SOUND_ALARM_CARBON_MONOXIDE
        - AUDIO_SOUND_SIREN
        - CLIMATE_VOC
        - CLIMATE_VAPE
        - CLIMATE_SMOKE
        - CLIMATE_THC
        - CLIMATE_CO2
        - CLIMATE_ETOH
        - CLIMATE_PM25
        - CLIMATE_IAQ
        - CLIMATE_LEAK
        - SOUND_AGGRESSION
        - SOUND_HELP
        - AIR_CO
        - AIR_CO2
        - AIR_MASKING
        - AIR_THC
        - AIR_VAPE
        - AIR_VOC
        - MASK_MISSING
        - HELMET_MISSING
        - GLOVES_MISSING
        - PIR_OCCUPIED
        - PIR_MOVEMENT
        - PIR_VACANT
        - CUSTOM
        - VISITOR_ARRIVED
        - VISITOR_DEPARTED
        - AC_DR_CONNECTED
        - AC_DR_DISCONNECTED
        - AC_DPI_DOOR_OPEN
        - AC_DPI_DOOR_CLOSED
        - AC_DPI_DOOR_AJAR
        - AC_DPI_DOOR_FORCED_OPEN
        - AC_DSR_UNLOCKED
        - AC_DSR_LOCKED
        - AC_DB_TRIGGERED
        - AC_PANIC_BUTTON_TRIGGERED
        - AC_REMOTE_UNLOCK
        - AC_BADGE_AUTHORIZED
        - AC_BADGE_UNAUTHORIZED
        - AC_BADGE_FACE_MISMATCH
        - AC_LOCKDOWN_ACTIVATED
        - AC_LOCKDOWN_DEACTIVATED
        - AC_LOCKDOWN_PLAN_SWITCHED
        - AC_TAMPER_PROX
        - AC_TAMPER_ACCEL
        - AC_TAMPER_SWITCH
        - AC_GR_ACTIVE
        - AC_GR_INACTIVE
        - AC_GI_ACTIVE
        - AC_GI_INACTIVE
        - AC_REX_ACTIVE
        - AC_REX_INACTIVE
        - AC_APERIO_DEVICE_DISCONNECTED
        - AC_APERIO_DEVICE_CONNECTED
        - AC_APERIO_DEVICE_REBOOT
        - AC_APERIO_DEVICE_TAMPER
        - AC_APERIO_LOW_BATTERY
        - AC_APERIO_FLAT_BATTERY
        - AC_APERIO_OK_BATTERY
        - AC_SCHLAGE_GW_DISCONNECTED
        - AC_SCHLAGE_GW_CONNECTED
        - AC_SCHLAGE_APM_DISCONNECTED
        - AC_SCHLAGE_APM_CONNECTED
        - AC_SCHLAGE_LOW_BATTERY
        - AC_SCHLAGE_CRITICAL_BATTERY
        - AC_SCHLAGE_OK_BATTERY
        - POWER_SWITCH_BATTERY
        - POWER_SWITCH_PRIMARY
        - AI_SEARCH_MATCH
        - AI_SEARCH_MATCH_PERSON_SMOKING
        - AI_SEARCH_MATCH_PERSON_ON_PHONE
        - AI_SEARCH_MATCH_PERSON_FALLING
        - CUSTOM_LLM_BOOLEAN_TRUE
        - CUSTOM_LLM_BOOLEAN_FALSE
        - CUSTOM_LLM_THRESHOLD_EXCEEDED_LOW
        - CUSTOM_LLM_THRESHOLD_EXCEEDED_HIGH
        - ALM_AUTHORITIES_CONTACTED
        - ALM_MONITORING_ENABLED
        - ALM_MONITORING_DISABLED
        - ALM_MONITORING_SETTINGS_CHANGE
        - ALM_THREAT_CASE_CLOSED
        - ALM_THREAT_DETECTED
        - ALM_MONITORING_EVENT_DETECTED
        - ROBOT_DOG_DETECTED
        - ROBOT_ARRIVED_AT_WAYPOINT
        - ROBOT_ARRIVED_AT_POSE
        - ROBOT_WAITING_AT_POSE
        - ROBOT_MANUAL_CMD_VEL
        - ROBOT_MANUAL_ACTION
        - ROBOT_MANUAL_POSTURE
        - ROBOT_NAVIGATE_TO_POSE_START
        - ROBOT_NAVIGATE_TO_POSE_END
        - ROBOT_NAVIGATE_TO_HOME_START
        - ROBOT_NAVIGATE_TO_HOME_END
        - ROBOT_NAVIGATE_TO_WAYPOINT_START
        - ROBOT_NAVIGATE_TO_WAYPOINT_END
        - ROBOT_ROUTE_RUN_START
        - ROBOT_ROUTE_RUN_END
        - ROBOT_LOW_BATTERY_DOCKING
        - ROBOT_IDLE_DOCKING
        - ROBOT_EMERGENCY
        - LOITER_HUMAN
        - INACTIVITY_HUMAN
        - INACTIVITY_CAR
        - GROUP_ENTRY
        - ONGUARD_BADGE_AUTHORIZED
        - ONGUARD_BADGE_ANOMALY
        - ONGUARD_NO_ENTRY_MADE
        - ELEMENTS_BADGE_AUTHORIZED
        - ELEMENTS_BADGE_ANOMALY
        - ELEMENTS_NO_ENTRY_MADE
        - NETBOX_BADGE_AUTHORIZED
        - NETBOX_BADGE_ANOMALY
        - NETBOX_NO_ENTRY_MADE
        - THERMAL_TEMPERATURE_ALARM
        - THERMAL_TEMPERATURE_WARNING
        - THERMAL_FIRE_DETECTED
        - THERMAL_SMOKING_DETECTED
        - THERMAL_FIRE_VERIFIED
        - THERMAL_HEAT_NO_THREAT
        - THERMAL_VISUAL_HOTSPOT
        - THERMAL_VISUAL_HEAT_RISE
        - THERMAL_VISUAL_WARM_BODY
        - UNKNOWN
      type: string
    ClipBoundingBoxType:
      properties:
        activity:
          $ref: "#/components/schemas/ActivityEnum"
        alert:
          nullable: true
          type: boolean
        bottom:
          format: int32
          nullable: true
          type: integer
        confidence:
          format: float
          nullable: true
          type: number
        croppedImageLocator:
          nullable: true
          type: string
        customActivityColor:
          $ref: "#/components/schemas/FootageSeekPointColorEnum"
        customActivityDescription:
          nullable: true
          type: string
        customActivityDisplayName:
          nullable: true
          type: string
        dwelling:
          nullable: true
          type: boolean
        faceName:
          nullable: true
          type: string
        inMotion:
          nullable: true
          type: boolean
        keypointsV2:
          additionalProperties:
            $ref: "#/components/schemas/PointType"
          nullable: true
          type: object
        left:
          format: int32
          nullable: true
          type: integer
        licensePlate:
          nullable: true
          type: string
        loudness:
          format: int32
          nullable: true
          type: integer
        objectId:
          format: int32
          nullable: true
          type: integer
        pose:
          nullable: true
          type: string
        relativeSecond:
          format: float
          nullable: true
          type: number
        right:
          format: int32
          nullable: true
          type: integer
        sensorValType:
          $ref: "#/components/schemas/SensorValType"
        stableTrackId:
          format: int32
          nullable: true
          type: integer
        toastOrderIdInfo:
          $ref: "#/components/schemas/ToastOrderIdType"
        top:
          format: int32
          nullable: true
          type: integer
        unidentifiedFaceId:
          nullable: true
          type: string
        vehicleName:
          nullable: true
          type: string
      type: object
    FootageSeekPointColorEnum:
      enum:
        - BLUE
        - RED
        - PURPLE
        - TAN
        - ORANGE
        - TEAL
        - GRAY
        - BLACK
      type: string
    PointType:
      properties:
        x:
          format: int32
          nullable: true
          type: integer
        y:
          format: int32
          nullable: true
          type: integer
      type: object
    SensorValType:
      properties:
        sensorBoolean:
          nullable: true
          type: boolean
        sensorDouble:
          format: double
          nullable: true
          type: number
        sensorLong:
          format: int64
          nullable: true
          type: integer
      type: object
    ToastOrderIdType:
      properties:
        employeeName:
          nullable: true
          type: string
        guid:
          nullable: true
          type: string
        locationName:
          nullable: true
          type: string
        restaurantName:
          nullable: true
          type: string
        toastCheckInfo:
          $ref: "#/components/schemas/ToastCheckInfo"
      type: object
    ToastCheckInfo:
      properties:
        totalAmount:
          format: double
          nullable: true
          type: number
      type: object
    EmailAuditLogExportActionType:
      properties:
        includeActions:
          items:
            nullable: true
            type: string
          nullable: true
          type: array
        includeApiInvocation:
          nullable: true
          type: boolean
        lookbackCount:
          format: int32
          nullable: true
          type: integer
        lookbackType:
          $ref: "#/components/schemas/ReportLookbackTypeEnum"
        lookbackUnit:
          $ref: "#/components/schemas/ReportLookbackUnitEnum"
        recipientEmails:
          items:
            nullable: true
            type: string
          nullable: true
          type: array
        timezoneId:
          nullable: true
          type: string
      type: object
    ReportLookbackTypeEnum:
      enum:
        - ROLLING
        - PREVIOUS_DAY
        - PREVIOUS_WEEK
        - PREVIOUS_MONTH
      type: string
    ReportLookbackUnitEnum:
      enum:
        - HOURS
        - DAYS
        - WEEKS
      type: string
    EnableDisableAudioRecordActionType:
      properties:
        audioDeviceUuid:
          description: base 64 (url-safe) uuid string
          example: AAAAAAAAAAAAAAAAAAAAAA
          format: RUUID
          nullable: true
          type: string
        enable:
          nullable: true
          type: boolean
      type: object
    IntegrationCommandActionType:
      properties:
        commandPayload:
          nullable: true
          type: string
        delaySecs:
          format: int32
          nullable: true
          type: integer
        integration:
          $ref: "#/components/schemas/IntegrationEnum"
      type: object
    IntegrationEnum:
      enum:
        - AVIGILON_ALTA
        - BOULEVARD
        - BRIVO
        - BUTTERFLY_MX
        - DEVICE_INTEGRATION
        - DICE
        - ENVOY
        - FLIC
        - GENEA
        - GOOGLE
        - HONEYWELL_ELEMENTS
        - GUEST_MANAGEMENT
        - INFORMACAST
        - INNER_RANGE
        - KISI
        - LUMEO
        - MICROSOFT_TEAMS
        - OMNIALERT
        - OPENAI
        - OPENTECH_ALLIANCE
        - PIMLOC
        - PLACE_OS
        - PRODATAKEY
        - SHELLY
        - TOAST
        - WEBHOOKS
        - ZAPIER
        - RAPTOR
        - NINEONEONE_CELLULAR
        - SLACK
        - APERIO
        - PAR_POS
        - HONEYWELL_ONGUARD
        - HONEYWELL_NETBOX
        - SIGNATURE_API
        - SCHLAGE
        - UNKNOWN
      type: string
    IntegrationNotificationActionType:
      properties:
        integration:
          $ref: "#/components/schemas/IntegrationEnum"
        notificationEntity:
          nullable: true
          type: string
        notificationTarget:
          nullable: true
          type: string
      type: object
    RemoteDoorUnlockActionType:
      properties:
        doorId:
          nullable: true
          type: string
        placeId:
          nullable: true
          type: string
        system:
          $ref: "#/components/schemas/RemoteDoorUnlockSystemEnum"
      type: object
    RemoteDoorUnlockSystemEnum:
      enum:
        - BRIVO
        - OPENPATH
        - KISI
        - PLACEOS
        - GENEA
        - PDK
        - INNER_RANGE
        - RHOMBUS
        - HONEYWELL_ELEMENTS
        - UNKNOWN
      type: string
    RobotAction:
      discriminator:
        mapping:
          DEPLOY: "#/components/schemas/DeployRobotAction"
          UNKNOWN: "#/components/schemas/NoOpAction"
        propertyName: type
      oneOf:
        - $ref: "#/components/schemas/DeployRobotAction"
        - $ref: "#/components/schemas/NoOpAction"
      properties:
        deviceUuid:
          description: base 64 (url-safe) uuid string
          example: AAAAAAAAAAAAAAAAAAAAAA
          format: RUUID
          nullable: true
          type: string
        type:
          $ref: "#/components/schemas/RobotActionTypeEnum"
      type: object
    DeployRobotAction:
      allOf:
        - properties:
            mapUuid:
              description: base 64 (url-safe) uuid string
              example: AAAAAAAAAAAAAAAAAAAAAA
              format: RUUID
              nullable: true
              type: string
            navType:
              $ref: "#/components/schemas/NavigationTypeEnum"
            patrolUuid:
              description: base 64 (url-safe) uuid string
              example: AAAAAAAAAAAAAAAAAAAAAA
              format: RUUID
              nullable: true
              type: string
            pose:
              $ref: "#/components/schemas/Pose"
            routeUuid:
              description: base 64 (url-safe) uuid string
              example: AAAAAAAAAAAAAAAAAAAAAA
              format: RUUID
              nullable: true
              type: string
            waypointUuid:
              description: base 64 (url-safe) uuid string
              example: AAAAAAAAAAAAAAAAAAAAAA
              format: RUUID
              nullable: true
              type: string
          type: object
      nullable: true
      properties:
        deviceUuid:
          description: base 64 (url-safe) uuid string
          example: AAAAAAAAAAAAAAAAAAAAAA
          format: RUUID
          nullable: true
          type: string
        type:
          $ref: "#/components/schemas/RobotActionTypeEnum"
      type: object
    NavigationTypeEnum:
      enum:
        - ROUTE
        - PATROL
        - WAYPOINT
        - POSE
      type: string
    Pose:
      properties:
        orientation:
          items:
            description: Serialized as [x, y, z, w]
            format: double
            type: number
          maxItems: 4
          minItems: 4
          nullable: true
          type: array
        position:
          items:
            description: Serialized as [x, y, z]
            format: double
            type: number
          maxItems: 3
          minItems: 3
          nullable: true
          type: array
      type: object
    RobotActionTypeEnum:
      enum:
        - DEPLOY
        - UNKNOWN
      type: string
    NoOpAction:
      allOf: []
      nullable: true
      properties:
        deviceUuid:
          description: base 64 (url-safe) uuid string
          example: AAAAAAAAAAAAAAAAAAAAAA
          format: RUUID
          nullable: true
          type: string
        type:
          $ref: "#/components/schemas/RobotActionTypeEnum"
      type: object
    ThirdPartyAudioPlaybackActionType:
      properties:
        audioFileName:
          nullable: true
          type: string
        ipAddress:
          nullable: true
          type: string
        loopDurationSec:
          format: int32
          nullable: true
          type: integer
        password:
          nullable: true
          type: string
        playCount:
          format: int32
          nullable: true
          type: integer
        proxyDeviceUuid:
          description: base 64 (url-safe) uuid string
          example: AAAAAAAAAAAAAAAAAAAAAA
          format: RUUID
          nullable: true
          type: string
        username:
          nullable: true
          type: string
      type: object
    ThirdPartyStrobeSirenActionType:
      properties:
        durationSec:
          format: int32
          nullable: true
          type: integer
        ipAddress:
          nullable: true
          type: string
        lightColors:
          items:
            nullable: true
            type: string
          nullable: true
          type: array
        lightIntensity:
          format: int32
          nullable: true
          type: integer
        lightPattern:
          nullable: true
          type: string
        lightSpeed:
          format: int32
          nullable: true
          type: integer
        password:
          nullable: true
          type: string
        profileName:
          nullable: true
          type: string
        proxyDeviceUuid:
          description: base 64 (url-safe) uuid string
          example: AAAAAAAAAAAAAAAAAAAAAA
          format: RUUID
          nullable: true
          type: string
        sirenIntensity:
          format: int32
          nullable: true
          type: integer
        sirenPattern:
          nullable: true
          type: string
        username:
          nullable: true
          type: string
      type: object
    TriggerComponentRelayActionType:
      properties:
        componentUuid:
          description: base 64 (url-safe) uuid string
          example: AAAAAAAAAAAAAAAAAAAAAA
          format: RUUID
          nullable: true
          type: string
        outputType:
          $ref: "#/components/schemas/ComponentRelayOutputTypeEnum"
        overrideRelayDurationMs:
          format: int32
          nullable: true
          type: integer
        overrideRelayDurationSec:
          format: int32
          nullable: true
          type: integer
        ownerDeviceUuid:
          description: base 64 (url-safe) uuid string
          example: AAAAAAAAAAAAAAAAAAAAAA
          format: RUUID
          nullable: true
          type: string
        state:
          $ref: "#/components/schemas/GenericRelayStateEnumType"
        version:
          format: int32
          nullable: true
          readOnly: true
          type: integer
      type: object
    ComponentRelayOutputTypeEnum:
      enum:
        - TRANSIENT
        - STEADY
      type: string
    GenericRelayStateEnumType:
      enum:
        - ACTIVE
        - INACTIVE
        - UNKNOWN
      type: string
    WebhookActionType:
      properties:
        headers:
          additionalProperties:
            nullable: true
            type: string
          nullable: true
          type: object
        oauthClientId:
          nullable: true
          type: string
        oauthClientSecret:
          nullable: true
          type: string
        oauthGrantType:
          nullable: true
          type: string
        oauthScope:
          nullable: true
          type: string
        oauthUrl:
          nullable: true
          type: string
        webhookSecret:
          nullable: true
          type: string
        webhookUrl:
          nullable: true
          type: string
      type: object
    PromptTypeEnum:
      enum:
        - COUNT
        - PERCENT
        - BOOLEAN
        - TEXT
      type: string
    Trigger:
      properties:
        activity:
          $ref: "#/components/schemas/TriggerActivityEnum"
        value:
          nullable: true
          type: string
      type: object
    TriggerActivityEnum:
      enum:
        - MOTION_HUMAN
        - VISUAL_TAMPER
        - MOTION
        - FACE_ALERT
        - POSE_ANOMALOUS
        - MOTION_CAR
        - LICENSEPLATE_ALERT
        - HELMET_MISSING
        - MASK_MISSING
        - TAMPER
        - PEOPLECOUNT_HIGH
        - GUN_DETECT_EVENT
        - HUMAN_ENTER
        - HUMAN_EXIT
        - CAR_ENTER
        - CAR_EXIT
        - AC_DB_TRIGGERED
        - LOITER_HUMAN
        - RECURRING_INTERVAL
      type: string
    Scenequery_UpdatePromptConfigurationWSResponse:
      description: Response object for updating a prompt configuration.
      properties:
        error:
          nullable: true
          type: boolean
        errorCode:
          description: Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.
          nullable: true
          type: string
        errorMsg:
          nullable: true
          type: string
        promptConfiguration:
          $ref: "#/components/schemas/PromptConfigurationType"
        warningMsg:
          nullable: true
          type: string
      type: object
  securitySchemes:
    ApiKeyAuth:
      description: Your Rhombus API key. Must be accompanied by the `x-auth-scheme` header set to `api-token` (or `partner-api-token` for partner endpoints).
      in: header
      name: x-auth-apikey
      type: apiKey
    oauth2:
      description: 'OAuth 2.0 authorization code flow with PKCE (`S256`). Send the access token as `Authorization: Bearer <token>`. Each operation lists the scopes it requires; a token without them is refused 403 with `WWW-Authenticate: Bearer error="insufficient_scope"`.'
      flows:
        authorizationCode:
          authorizationUrl: https://console.rhombus.com/oauth/authorize
          refreshUrl: https://auth-web.rhombussystems.com/oauth/token
          scopes:
            physical: Unlock doors and elevators, lockdown, alarms, speakers and robots
            read: View cameras, footage and settings
            write: Change settings and data
          tokenUrl: https://auth-web.rhombussystems.com/oauth/token
      type: oauth2
````