Prompts
Manage reusable AI probing instructions and variables.
Prompt details
Prompt content is read-only here. Open the editor to change this Prompt and insert variables.
Probing API
Generate one AI probing question for each request.
/api/probingAuthorization: Bearer <CLIENT_KEY>Use a Client Key created for the calling application. Never put a real key in browser code, logs, screenshots or source control.
Request body
Send UTF-8 JSON. Field names are case-sensitive.
| Field | Type | Required | Description |
|---|---|---|---|
surveyId | string | Yes | Survey UUID from the Surveys tab. A managed Survey selects its linked Prompt and variable defaults. |
questionNumber | string | Yes | Question identifier, for example Q1. |
questionText | string | Yes | Original survey question. |
answerText | string | Yes | Respondent answer to the original question. |
language | string | Yes | BCP 47 response-language code, such as zh-CN, en-US or pt-BR. |
previousProbings | array | Yes | Completed probing questions and answers. Send [] in round 1. The server derives the current round from this array and enforces the Survey or global probing-round limit. |
variables | object | No | Values for custom {{variableName}} placeholders. Request values override Survey defaults. |
Try request
Fill every required field and call this environment directly. Defaults are loaded wherever they are available.
cURL
Client Key is masked in this preview.Response
—Success response
Display probingQuestionText to the respondent and retain requestId for troubleshooting.
{
"questionNumber": "Q1",
"probingQuestionText": "What mattered most about the convenience?",
"canContinueProbing": true,
"provider": "azure-openai",
"api": "responses",
"model": "configured-deployment",
"requestId": "f89a32c2-7aad-49c9-a214-c20d72a52fc1"
}
Each successful response contains exactly one probingQuestionText. canContinueProbing only says whether the client may make another request after collecting its answer; it does not mean this response contains multiple questions.
Next round
- Keep the original
questionTextandanswerText. - Add every completed probing question and its answer to
previousProbings. - Continue only while
canContinueProbingistrue. The server derives the next round frompreviousProbingsand enforces the Survey-specific or global probing-round limit.
Client Keys
Only Master administrators can see this page. Key values are shown once.