Skip to main content
A Hosted Link is a public URL that runs your scenario as a full live avatar conversation (voice and video), hosted by Akapulu. Anyone you share the link with can open it and click Start Call. No SDK, backend, or API key required. Unlike Testing Mode, which is a text-only simulation, a hosted link starts a real conversation with a real avatar, so it consumes your voice/video conversation minutes.

​
What you can configure

Each hosted link stores its own connection settings, so you can create several links for the same scenario:
  • Avatar: the avatar that will appear on the call.
  • Label: the title shown above Start Call in the hosted UI, and how the link appears in your list of hosted links on the scenario page.
  • Runtime variables: a JSON object passed as runtime_vars when the call starts.
  • STT keywords: optional speech-to-text keyword hints.
  • Record conversation: whether the conversation is recorded.
  • Redirect URL: where the visitor is sent after the call ends (optional).
  1. Open a scenario in the editor (Make sure visual mode is toggled)
  2. Open the Scenario Menu (side panel on left hand side) and select the Hosted Link tab.
  3. Click + Add hosted link and fill in the connect settings above.
  4. Click Add Link. Then to persist your changes - click “save” in the upper right hand corder
  5. Copy the url and paste into a browser to start your live conversation

​
Runtime variables

A hosted link must provide a value for every runtime variable your scenario declares (the ones referenced as {{runtime.*}} in your role instruction, task instructions, and endpoint templates). Values may be blank, but the keys must be present. Example:
Hosted links use the format:
Open the link, click Start Call, and the conversation starts with the avatar and settings you configured. Anyone with the link can start a conversation.

​
Redirects and tracking parameters

When you create a hosted link, you can set an optional Redirect URL. After the call ends, the visitor is sent there. For example, set the redirect URL to:
Then share your hosted link with your own query parameters attached (CRM IDs, UTM tags, or anything else you use for tracking):
When the call ends, those query parameters are carried over onto your redirect URL. Akapulu Labs also appends a conversation_session_id so you can sync the hosted conversation with your own systems and fetch the transcript or recording:
If your redirect URL already includes query parameters, those are preserved. Incoming parameters with the same name do not overwrite them. Every hosted link appears as a card in the Hosted Link tab. Expand a card to view its full settings, copy the link, or delete it. Deleting a scenario also deletes its hosted links. Hosted links are built for quick integrations, demos, and testing. They are the fastest way to put a scenario in front of someone. For production and enterprise use cases where you need maximum security and full control (your own domain, authentication, and UI, with no publicly shareable token), we recommend using the Web SDK instead. See the Web SDK Overview and Customize Conversation UI.

​
See also