Team Run Cancellation
Cancel a running team execution from another thread.
Cancel a running team execution by starting the run in one thread and cancelling it from another. The example also shows how to handle cancelled responses.
Cancellation is cooperative: a request marks the run for cancellation, and execution stops at its next cancellation check. A fast run can finish first. The final status below determines the outcome; marking a run is not proof that it stopped.
Example
"""
Example demonstrating how to cancel a running team execution.
This example shows how to:
1. Start a team run in a separate thread
2. Cancel the run from another thread
3. Handle the cancelled response
"""
import threading
import time
from uuid import uuid4
from agno.agent import Agent
from agno.models.openai import OpenAIResponses
from agno.run.agent import RunEvent
from agno.run.base import RunStatus
from agno.run.team import TeamRunEvent
from agno.team import Team
def long_running_task(team: Team, run_id_container: dict):
"""Consume the parent run's stream and retain its terminal outcome."""
run_id = run_id_container["run_id"]
status = "unknown"
content_pieces = []
try:
for chunk in team.run(
"Write a detailed story about a dragon who learns to code.",
run_id=run_id,
stream=True,
stream_events=True,
):
# Member/step runs have their own IDs and do not determine parent status.
if chunk.run_id != run_id:
continue
if chunk.event == TeamRunEvent.run_cancelled:
status = "cancelled"
elif chunk.event == TeamRunEvent.run_error:
status = "error"
elif chunk.event == TeamRunEvent.run_paused:
status = "paused"
elif chunk.event == TeamRunEvent.run_completed and status == "unknown":
status = "completed"
content = getattr(chunk, "content", None)
if isinstance(content, str):
content_pieces.append(content)
run_id_container["result"] = {
"status": status,
"run_id": run_id,
"cancelled": status == "cancelled",
"content": "".join(content_pieces)[:200],
}
except Exception as exc:
run_id_container["result"] = {
"status": "error", "run_id": run_id, "cancelled": False,
"error": str(exc), "content": "Run raised an exception",
}
def cancel_after_delay(team: Team, run_id_container: dict, delay_seconds: int = 3):
"""
Cancel the team run after a specified delay.
Args:
team: The team whose run should be cancelled
run_id_container: Dictionary containing the run_id to cancel
delay_seconds: How long to wait before cancelling
"""
print(f"Will cancel team run in {delay_seconds} seconds...")
time.sleep(delay_seconds)
run_id = run_id_container.get("run_id")
if run_id:
print(f"Cancelling team run: {run_id}")
success = team.cancel_run(run_id)
if success:
print(f"Team run {run_id} marked for cancellation")
else:
print(
f"Failed to cancel team run {run_id} (may not exist or already completed)"
)
else:
print("No run_id found to cancel")
def main():
"""Main function demonstrating team run cancellation."""
# Create team members
storyteller_agent = Agent(
name="StorytellerAgent",
model=OpenAIResponses(id="gpt-5.2"),
description="An agent that writes creative stories",
)
editor_agent = Agent(
name="EditorAgent",
model=OpenAIResponses(id="gpt-5.2"),
description="An agent that reviews and improves stories",
)
# Initialize the team with agents
team = Team(
name="Storytelling Team",
members=[storyteller_agent, editor_agent],
model=OpenAIResponses(id="gpt-5.2"), # Team leader model
description="A team that collaborates to write detailed stories",
)
print("Starting team run cancellation example...")
print("=" * 50)
# Container to share run_id between threads
run_id_container = {"run_id": str(uuid4())}
# Start the team run in a separate thread
team_thread = threading.Thread(
target=lambda: long_running_task(team, run_id_container), name="TeamRunThread"
)
# Start the cancellation thread
cancel_thread = threading.Thread(
target=cancel_after_delay,
args=(team, run_id_container, 8), # Cancel after 8 seconds
name="CancelThread",
)
# Start both threads
print("Starting team run thread...")
team_thread.start()
print("Starting cancellation thread...")
cancel_thread.start()
# Wait for both threads to complete
print("Waiting for threads to complete...")
team_thread.join()
cancel_thread.join()
# Print the results
print("\n" + "=" * 50)
print("RESULTS:")
print("=" * 50)
result = run_id_container.get("result")
if result:
print(f"Status: {result['status']}")
print(f"Run ID: {result['run_id']}")
print(f"Was Cancelled: {result['cancelled']}")
if result.get("error"):
print(f"Error: {result['error']}")
else:
print(f"Content Preview: {result['content']}")
if result["cancelled"]:
print("\nSUCCESS: Team run was successfully cancelled!")
elif result["status"] == "completed":
print("Run completed before cancellation")
else:
print(f"Run ended with status: {result['status']}")
else:
print("No result obtained - check if cancellation happened during streaming")
print("\nTeam cancellation example completed!")
if __name__ == "__main__":
# Run the main example
main()Usage
Set up your virtual environment
uv venv --python 3.12
source .venv/bin/activateInstall dependencies
uv pip install -U agno openaiExport your OpenAI API key
Set OpenAI Key
Set your OPENAI_API_KEY as an environment variable. You can get one from OpenAI.
export OPENAI_API_KEY=sk-***Run example
python team_cancel_run.pyAPI Endpoint
Team runs can be cancelled via the AgentOS API:
POST /teams/{team_id}/runs/{run_id}/cancelStart a separate AgentOS server with the entity registered before using this endpoint. The thread example above does not start an HTTP server. Replace the entity and run IDs below with IDs returned by that server and include its authentication headers when configured.
Example:
curl --location 'http://localhost:7777/teams/storytelling-team/runs/456/cancel' \
--request POSTReference: Cancel Team Run API