get_instance_key | SignalWire

Get the unique key used to track this skill instance.

Returns

str — For single-instance skills, returns SKILL_NAME. For multi-instance skills (SUPPORTS_MULTIPLE_INSTANCES = True), returns "<SKILL_NAME>_<tool_name>" where tool_name comes from params.

Example

1 from signalwire.core.skill_base import SkillBase
2 
3 class NotificationSkill(SkillBase):
4     SKILL_NAME = "notify"
5     SKILL_DESCRIPTION = "Send notifications"
6     SUPPORTS_MULTIPLE_INSTANCES = True
7 
8     def setup(self) -> bool:
9         return True
10 
11     def register_tools(self):
12         pass

Instance key behavior:

1 from signalwire import AgentBase
2 
3 agent = AgentBase(name="demo")
4 agent.add_skill("notify")
5 # Instance key: "notify"
6 
7 agent.add_skill("notify", {"tool_name": "email"})
8 # Instance key: "notify_email"
9 
10 agent.add_skill("notify", {"tool_name": "sms"})
11 # Instance key: "notify_sms"