curl -X POST https://rhizomeai.com/api/v3/conversations/3b1f8c6e-2a4d-4c1e-9f2a-7d5e6b8c9a01/stop \
-H "x-api-key: YOUR_API_KEY"
import requests
conversation_id = "3b1f8c6e-2a4d-4c1e-9f2a-7d5e6b8c9a01"
response = requests.post(
f"https://rhizomeai.com/api/v3/conversations/{conversation_id}/stop",
headers={"x-api-key": "YOUR_API_KEY"},
)
response.raise_for_status()
print(response.json()["stopped"])
{
"conversation_id": "3b1f8c6e-2a4d-4c1e-9f2a-7d5e6b8c9a01",
"stopped": true
}
Conversations
Stop a run
Cancel the message in progress
POST
/
api
/
v3
/
conversations
/
{conversation_id}
/
stop
curl -X POST https://rhizomeai.com/api/v3/conversations/3b1f8c6e-2a4d-4c1e-9f2a-7d5e6b8c9a01/stop \
-H "x-api-key: YOUR_API_KEY"
import requests
conversation_id = "3b1f8c6e-2a4d-4c1e-9f2a-7d5e6b8c9a01"
response = requests.post(
f"https://rhizomeai.com/api/v3/conversations/{conversation_id}/stop",
headers={"x-api-key": "YOUR_API_KEY"},
)
response.raise_for_status()
print(response.json()["stopped"])
{
"conversation_id": "3b1f8c6e-2a4d-4c1e-9f2a-7d5e6b8c9a01",
"stopped": true
}
Stops the message the agent is working on, like the stop button on rhizomeai.com. The stopped message is removed from the conversation, along with any documents it produced, and is not counted against your plan. The conversation can be continued with a new message.
Plus
stopped: false means there was nothing to stop: the run had already finished, and its answer stands.
Path parameters
string
required
The conversation’s id.
Response
string
The conversation’s id.
boolean
Whether a run was stopped.
Errors
| Status | Code | Description |
|---|---|---|
| 404 | not_found | No conversation with this id in your account |
401 and 429, see Errors.
curl -X POST https://rhizomeai.com/api/v3/conversations/3b1f8c6e-2a4d-4c1e-9f2a-7d5e6b8c9a01/stop \
-H "x-api-key: YOUR_API_KEY"
import requests
conversation_id = "3b1f8c6e-2a4d-4c1e-9f2a-7d5e6b8c9a01"
response = requests.post(
f"https://rhizomeai.com/api/v3/conversations/{conversation_id}/stop",
headers={"x-api-key": "YOUR_API_KEY"},
)
response.raise_for_status()
print(response.json()["stopped"])
{
"conversation_id": "3b1f8c6e-2a4d-4c1e-9f2a-7d5e6b8c9a01",
"stopped": true
}