Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.quarterzip.ai/llms.txt

Use this file to discover all available pages before exploring further.

​
How It Works

  1. User clicks a button → window.Quarterzip.open() is called
  2. The SDK creates an isolated UI panel (Shadow DOM) on the page
  3. A voice call connects to the agent automatically
  4. Microphone and screen sharing permissions are solicited from the user
  5. On Chromium browsers (Chrome, Edge), the call panel can pop out as a Picture-in-Picture window. On Firefox/Safari, the same UI renders inline on the page.
The SDK manages the entire call lifecycle. Your code only needs to call open().

​
1. Add the SDK Script

Place this snippet before </body> on any page where you want the agent available: 
<script>
  (function() {
    var q = [];
    window.Quarterzip = {
      _q: q,
      open: function(args) { q.push(['open', args]); },
      close: function(args) { q.push(['close', args]); },
    };
    var s = document.createElement('script');
    s.async = true;
    s.src = 'https://app.quarterzip.ai/sdk/qz.js';
    document.head.appendChild(s);
  })();
</script>
This single snippet does two things: creates a lightweight stub that queues any open()calls, then asynchronously loads the full SDK. Once loaded, the SDK will consumes the queue and take action.

​
2. Open the Agent

Trigger a call from any user interaction (button click, menu item, etc.): 
window.Quarterzip.open({
  workspaceToken: 'YOUR_WORKSPACE_TOKEN',
  agentId: 'YOUR_AGENT_ID',
  user: {
	  email: 'jane@company.com',
	  displayName: 'Jane Smith',
    id: 'your_internal_user_id'
  }
})
ParameterRequiredDescriptionType
workspaceTokenYesUse the workspace token provided by Quarterzip.String
agentIdYesThe agent’s ID which can be copied from the Quarterzip appString
userYesThe user who will join the callObject
user.emailYesEnd user’s email addressString
user.displayNameYesEnd user’s display nameString
user.idYesYour unique internal user identifierString

​
3. Close the Agent

If you would like to cancel an in-progress call, this can be done with the .close() function. In normal operation the call will end gracefully upon user request, and calling close is not required. 
window.Quarterzip.close();