Skip to the page

Praecise Platform

Rivier/ Reference/ agents

Agents assistant interrupt

post/agents/assistant/threads/{id}/interrupt

Stop the assistant at the next safe point, or redirect it with a new instruction while it works.

Before you call

Credential: Authorization: Bearer $KEY
Scope: agents:write
Sdk: agents.assistant.interrupt
Cli: agents assistant interrupt

Parameters

idstringrequired
In the path

Request bodyapplication/json, required

modestring
One of: stop, steer. Default: stop.
messagestring
At most 2000 characters.

Responses

200application/json
Success
400application/json
The request was malformed
- errorstringrequired
- messagestring
401application/json
No valid credential
- errorstringrequired
- messagestring
403application/json
The credential lacks the scope, origin or address
- errorstringrequired
- messagestring
429application/json
Over the key's rate limit; see Retry-After
- errorstringrequired
- messagestring

Example request

curl -X POST 'https://api.rivier.ai/agents/assistant/threads/{id}/interrupt' \
  -H 'Authorization: Bearer $KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "mode": "stop",
  "message": "string"
}'

$KEY stands for your own key. No key is shown or kept on this site.

This page as Markdown