@skippr/live-agent-sdk
v0.9.0
Published
[](https://skippr.ai) [](https://www.npmjs.com/package/@skippr/live-agent-sdk)
Keywords
Readme
@skippr/live-agent-sdk
A live agent with visual and voice skills, embedded into your app with a single React component.
Installation
npm install @skippr/live-agent-sdkQuick Start
import { LiveAgent } from '@skippr/live-agent-sdk';
import '@skippr/live-agent-sdk/styles';
function App() {
return <LiveAgent organizationId="your_org_id" agentId="your_agent_id" />;
}Custom Components
Any component rendered inside <LiveAgent> can use the useLiveAgent hook to access session state and controls:
import { LiveAgent, useLiveAgent } from '@skippr/live-agent-sdk';
function ConnectionStatus() {
const { isConnected } = useLiveAgent();
if (isConnected) return <p>Agent connected</p>;
return <p>Agent disconnected</p>;
}
function App() {
return (
<LiveAgent organizationId="your_org_id" agentId="your_agent_id">
<ConnectionStatus />
</LiveAgent>
);
}API Reference
<LiveAgent>
Self-contained widget component. Renders a floating button that opens a sidebar panel for real-time agent interaction.
Props
| Prop | Type | Default | Description |
|------|------|---------|-------------|
| organizationId | string | required | Organization ID provided by Skippr |
| agentId | string | required | Agent ID provided by Skippr |
| defaultOpen | boolean | false | Whether the panel starts open |
useLiveAgent()
Hook for accessing session state and panel controls. Must be called within <LiveAgent>.
State
| Field | Type | Description |
|-------|------|-------------|
| isConnected | boolean | Whether the agent is connected |
| isPanelOpen | boolean | Whether the panel is currently open |
| isStarting | boolean | Whether a session is being created |
| error | string | Error message, if any |
Methods
| Method | Type | Description |
|--------|------|-------------|
| startSession | () => Promise<void> | Start a new agent session |
| disconnect | () => Promise<void> | End the current session |
| openPanel | () => void | Open the panel |
| closePanel | () => void | Close the panel |
| togglePanel | () => void | Toggle the panel open/closed |
Support
For questions, technical support, or feedback:
- Email: [email protected]
- Website: https://skippr.ai
© 2026 Skippr
