AIAction | SignalWire

Returned from call.ai(). Tracks an active AI agent session on the call. Terminal states: finished, error.

AI sessions typically end when the call ends or when explicitly stopped. The terminal event may not carry a standard state field like other actions.

Inherits all properties and methods from the base Action interface (control_id, is_done, completed, result, wait()).

Properties

No additional properties beyond the base Action interface.

Methods

stop

Stop the AI agent session.

Example

1 from signalwire.relay import RelayClient
2 
3 client = RelayClient(
4     project="your-project-id",
5     token="your-api-token",
6     host="your-space.signalwire.com",
7     contexts=["default"],
8 )
9 
10 @client.on_call
11 async def handle_call(call):
12     await call.answer()
13     action = await call.ai(
14         prompt={"text": "You are a helpful assistant."},
15         ai_params={"temperature": 0.7},
16     )
17 
18     # Wait for it to complete naturally
19     event = await action.wait()
20 
21 client.run()