Stop Standalone Study Question
cancel_study_questionStops one standalone Study question by runId, or studyId and questionId: queued or preparing stops at once, being answered stops at its next step. Answers given are kept. An answered or failed question errors unchanged. Not for multi-question runs.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| runId | No | runId that ask_study or ask_audience returned for the question to stop. Without it, pass studyId and questionId. | |
| studyId | No | Study of the question to stop, with questionId, when the runId is not known. | |
| questionId | No | questionId that ask_study or ask_audience returned for the question to stop, with studyId. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| runId | No | The question run the cancellation was requested for. | |
| status | No | cancelled (no further answers are generated), cancelling (the Minds answering it stop at their next step), preparing (not submitted yet; call again to stop it) or planning_required (waits for a confirmed plan, nothing is being asked). An already answered or failed question returns an error instead. | |
| stopped | No | True while the question is cancelled or stopping, also on a repeated call; false when nothing was asked yet. | |
| studyId | No | Study of the question; read its state with get_study_status and questionId. | |
| questionId | No | The question's request id, the questionId get_study_status takes. |