cancel_survey
Permanently cancel a survey, stop new tasks, and refund unused reserved credits. In-flight responses complete and consumed credits are not refunded.
Instructions
Permanently cancel a survey and settle its reserved credits.
⚠ Cancellation is irreversible. Once cancelled, the survey stops serving new tasks, any in-flight responses still complete, and all unused reserved credits are returned to the balance. Already-consumed credit (for responses already collected) is NOT refunded — the response is shown in the result so the user knows the final cost.
Before calling, show the user the survey id and confirm they want to
cancel. Prefer pause_survey when the user just wants to stop temporarily.
Backend rejects with 400 if the survey is already in a terminal state (completed, failed, or cancelled) — the message will say which.
Args: job_id: The job ID returned by create_survey.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| job_id | Yes |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |