Skip to content

assistantStop ​

Requests that an active BetterForms assistants stream stop gracefully.

assistantStop requests that an active assistants run stop.

Expected Options ​

KeyTypeDescription
options.threadIdstringAssistant thread identifier
options.runIdstringAssistant run identifier

Example ​

json
{
  "action": "assistantStop",
  "options": {
    "threadId": "thread_123",
    "runId": "run_456"
  }
}

Behavior Notes ​

  • Both threadId and runId are required for a real stop request.
  • When both values are present, BetterForms calls stream/create/assistants/stop.
  • Missing or already-finished runs are handled gracefully.

Klai Studio documentation