Skip to content
Developers

Share links

Share links are the fastest way to put Practicl in front of a customer with no engineering. You mint a scoped key in the dashboard and send a single URL. When the customer opens it, they land in the full Practicl workspace — a side-by-side PDF viewer and chat — and can ask your documentation anything, with every answer cited to the page.

There is nothing to install, no script to add and no backend to write. If you want a chat bubble on your own site that answers from your website’s pages instead, see Embed the widget.

Create one

Open Documents, select the document, and press Share in the panel on the right. The link is on your clipboard.

That single press creates a key, scopes it to that document and nothing else, and builds the URL around it. Nothing to configure, and no way to accidentally issue a key that opens more than you meant.

The button appears once the document has finished processing. Until then there is nothing to ask questions of.

When you want more control

Open API Keys and create one with the type share. This is the route to take when you want a key scoped to a whole product rather than one document, an origin allowlist, an expiry, or a particular persona on the link.

The full pk_live_ key is shown at creation and can be copied again from the key’s row under Experts: a share link is kept, encrypted with a key held outside the database. Backend keys are different — see below.

The URL

A share link points at the workspace for a specific manual and carries the key as a query parameter:

https://app.staging.practicl.io/chat/{manualId}?key=pk_live_...

Send it however you reach customers — in an email, inside your own documentation, or behind an “Ask our AI” button. The link opens the full workspace scoped to that manual, with the PDF alongside the chat.

A link always addresses one manual. A key scoped to a whole product widens what that key may answer from, but there is no single URL that opens a product — send one link per manual.

Scope and limits

  • Scope to specific documents. Every key must carry manual_ids or product_ids; a key with neither is rejected. It answers only from those documents and nothing else in your account.
  • Restrict where it works. Add an optional allowed_domains allowlist to reject requests from any origin you have not approved.
  • Set an expiry. Add an optional expires_in_minutes for time-limited campaigns — for example a key that stops working after a trade show. Omit it and the key does not expire.

Withdrawing a link

A share link is revoked rather than changed. Open API Keys, find the key, and revoke it — the link stops working immediately.

It stops working for everyone holding it, including the customer you meant to keep. If a link has been forwarded further than you intended, the usual move is to revoke it and send the person you do want a new one, rather than trying to narrow the old one.

This is worth planning for rather than discovering: a link per customer costs nothing and means withdrawing one never affects another.

When to use share links vs the widget

Use a share link when you want a link you send — in an email, a PDF or a button — and the customer opens the full workspace, answering from the documents you scoped it to (you can add your website source too). Use the widget when you want an always-present chat bubble on your own site that answers from your website’s pages, and that visitors can open without leaving the page.