Skip to content

Document autoClose option for the VAPI peer #290

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Gawor270 merged 1 commit into from
Sep 30, 2026
Merged

Document autoClose option for the VAPI peer #290

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
43 changes: 43 additions & 0 deletions docs/integrations/vapi-integration.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -186,6 +186,49 @@ Once both steps are complete, the VAPI assistant is live in the room — peers c

The VAPI peer's lifetime is tied to the underlying WebSocket connection. If there is a prolonged period of silence or the call ends for any other reason, the peer will disconnect and be removed from the room. You can detect this by listening for `PeerDisconnected` and `PeerDeleted` server notifications. If the peer crashes (e.g. due to an invalid transport configuration or call ID), a `PeerCrashed` notification is sent instead. See [Listening to events](../how-to/backend/server-setup#listening-to-events) for how to subscribe to these notifications.

## Ending the call automatically

Set `autoClose` to end the VAPI call once the last participant leaves the room.
The peer is then removed and a `PeerDeleted` notification is sent.

<Tabs groupId="language">
<TabItem value="ts" label="TypeScript">

```ts
import { FishjamClient, type RoomId } from '@fishjam-cloud/js-server-sdk';

const fishjamClient = new FishjamClient({
fishjamId: process.env.FISHJAM_ID!,
managementToken: process.env.FISHJAM_TOKEN!,
});
const roomId = '' as RoomId;
const callId = '';

// ---cut---
await fishjamClient.createVapiAgent(roomId, {
callId,
apiKey: process.env.VAPI_API_KEY!,
// [!code highlight]
autoClose: true,
});
```

</TabItem>

<TabItem value="python" label="Python">

```python
options = PeerOptionsVapi(
api_key=os.environ["VAPI_API_KEY"],
call_id=call.id,
# [!code highlight]
auto_close=True,
)
```

</TabItem>
</Tabs>

## Billing

The VAPI peer is billed as a single Fishjam peer. VAPI's own usage pricing applies separately — see [VAPI pricing](https://vapi.ai/pricing) for details.
Loading