> ## Documentation index > Fetch the complete documentation index at: https://developer.rhombus.com/llms.txt > Use it to discover all available pages before exploring further. # Trigger prompt > Trigger scene query with a custom prompt ```http POST https://api2.rhombussystems.com/api/scenequery/triggerPrompt ``` 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 `) 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 ` 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): 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 triggering a prompt. - `deviceFacetUuid` (string | null): RUUID with optional appended facet information - `multiImageTimeDeltasSeconds` (array | 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. - `prompt` (string | null): Prompt text to trigger - `promptType` (string) One of: `COUNT`, `PERCENT`, `BOOLEAN`, `TEXT`. - `region` (object) - `timestampMs` (integer | null): Timestamp in milliseconds for the trigger ## 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) - `event` (object): Scene query report event from the triggered prompt - `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/triggerPrompt: post: description: Trigger scene query with a custom prompt operationId: triggerPrompt 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 ` 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_TriggerPromptWSRequest" responses: "200": content: application/json: schema: $ref: "#/components/schemas/Scenequery_TriggerPromptWSResponse" 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: Trigger prompt tags: - Scene Query Webservice components: schemas: Scenequery_TriggerPromptWSRequest: description: Request object for triggering a prompt. properties: deviceFacetUuid: description: RUUID with optional appended facet information example: AAAAAAAAAAAAAAAAAAAAAA.v0 format: DeviceFacetUuid nullable: true type: string multiImageTimeDeltasSeconds: description: "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: - -10 - -5 - 5 items: description: "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." format: int32 nullable: true type: integer nullable: true type: array prompt: description: Prompt text to trigger example: Count people in the scene nullable: true type: string promptType: $ref: "#/components/schemas/PromptTypeEnum" region: $ref: "#/components/schemas/RegionPolygonType" timestampMs: description: Timestamp in milliseconds for the trigger example: 1640995200000 format: int64 nullable: true type: integer type: object PromptTypeEnum: enum: - COUNT - PERCENT - BOOLEAN - TEXT type: string 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 Scenequery_TriggerPromptWSResponse: description: Response object for triggering a prompt. 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 event: $ref: "#/components/schemas/SceneQueryReportEvent" warningMsg: nullable: true type: string type: object SceneQueryReportEvent: description: Scene query report event from the triggered prompt properties: checkCondition: nullable: true type: boolean image: nullable: true type: string imageOffsets: items: format: int32 nullable: true type: integer nullable: true type: array prompt: nullable: true type: string timestampMs: format: int64 nullable: true type: integer value: 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 `. 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 ````