Skip to main content
POST
/
api
/
scenequery
/
optimizePromptChat
Optimize prompt via chat
curl --request POST \
  --url https://api2.rhombussystems.com/api/scenequery/optimizePromptChat \
  --header 'Content-Type: application/json' \
  --header 'x-auth-apikey: <api-key>' \
  --header 'x-auth-scheme: <x-auth-scheme>' \
  --data '
{
  "context": {
    "deviceFacetUuid": "AAAAAAAAAAAAAAAAAAAAAA.v0",
    "expectedAnswer": "<string>",
    "optionalContext": "<string>",
    "originalAnswer": "<string>",
    "originalPrompt": "<string>",
    "region": {
      "coordinates": [
        {
          "x": 123,
          "y": 123
        }
      ]
    },
    "timestampMs": 123
  },
  "currentMessage": "<string>",
  "history": [
    {
      "role": "<string>",
      "text": "<string>"
    }
  ]
}
'
{
  "error": true,
  "errorMsg": "<string>",
  "explanation": "<string>",
  "optimizedPrompt": "<string>",
  "questionForUser": "<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 prompt optimization chat.

context
object

Context for prompt optimization including the camera frame, original prompt, and expected answer.

currentMessage
string | null

Current user message

history
object[] | null

Chat history messages

Response

200 - application/json

OK

Response object for prompt optimization chat.

error
boolean | null
errorMsg
string | null
explanation
string | null

Explanation of the optimization

optimizedPrompt
string | null

The optimized prompt

questionForUser
string | null

Follow-up question for the user, if any

warningMsg
string | null