Publish and share an assistant
Publishing puts one of your agents behind a link of its own. Anyone with the full link can talk to it without signing in. Builders publish; only an Admin creates the share link, because the link carries the key that makes the assistant reachable from outside the tenant.
Who can do it
Section titled “Who can do it”| Role | What they can do |
|---|---|
| Admin | Publish, and create the share link during publishing or later with Get share link |
| Builder | Publish. The share link is left for an Admin to create |
| Auditor, Reviewer, End user | Cannot publish or create a link |
| Platform admin | Holds every capability, in any tenant |
Prerequisites
Section titled “Prerequisites”- An agent in the tenant, with a model the tenant can call. See Create and edit an agent.
- For the share link: at least one project in the tenant. The link’s key belongs to the tenant’s first project, and its usage counts against that project’s budget. A platform admin creates projects.
Publish an agent
Section titled “Publish an agent”Start from any of three places. All open the same wizard, New assistant (or Publish as an assistant when it starts from an agent):
- Build › Assistants, New assistant.
- An agent’s page, Publish as assistant. Once an assistant publishes the agent, the button reads View assistant instead.
- An agent’s preview, Publish as assistant.
The steps:
- Agent. Search for and choose the agent the assistant publishes. Each agent shows the assistants that already publish it (Published as) and whether it Ships with the platform. This step is skipped when you start from an agent.
- Identity.
- Name: the name its users see. It starts as the agent’s name. Required.
- Its address shows the link the assistant will get: the name made URL-safe, plus a suffix the platform adds so the address is unique everywhere.
- Welcome message: optional, shown on the chat’s start screen.
- Appearance.
- Accent color: a swatch, or Custom color (hex). The chat uses the color for its buttons and links. When white text on the color would be hard to read, the chat uses a deeper shade of it, and the field says so.
- Starter prompts (one per line): the suggested questions on the start screen.
- A preview beside the fields shows What a visitor sees first.
- Publishing.
- Answer on its link right away: on, the assistant is Active; off, it is kept as a draft that answers once it is enabled.
- Create a share link now: Admins only. On, the link is created when you publish and shown once on the next step. Off, you create it later from the assistant’s page. A Builder sees “An Admin can create its share link later, from the assistant page.”
- Review. Check the agent, name, address, welcome message, accent color, conversation starters, On its link and Share link. Choose Publish.
- Its link (only when a link is being created). Copy the link now. Then choose Open the assistant.
Without a link step, Publish lands on the new assistant’s page. A toast says Published.
Once Publish succeeds, the assistant exists. If its link could not be created, the last step says Published, without its link and why; create the link later with Get share link. Closing the wizard before publishing asks first, because what you entered is lost.
Set the logo and How it answers afterwards with Edit. See Assistants.
Create or replace the share link
Section titled “Create or replace the share link”- Open the assistant from Build › Assistants, or use the row’s Actions menu.
- Choose Get share link.
- Copy the link from White-label link (in the list’s dialog) or from Its link (on the assistant’s page).
The link looks like this:
https://<console-host>/a/<slug>#k=<access-key>Creating a new link revokes the previous one at once. Every place that held the old link stops getting answers.
What the link means
Section titled “What the link means”- Anyone with it can talk to the assistant. No sign-in. The key sits after
#in the address, so browsers do not send it in requests for the page or in the referrer. - The key is narrow. It can call only the assistant’s own model, only for this assistant, and only in this tenant. The tenant’s grants, budgets and guardrails apply, and every turn is metered to the tenant.
- Each visitor gets a reference. A conversation from the link is kept under a reference that starts with
v-. The chat shows it to the visitor, who can quote it to have the conversation deleted; Erasure finds and erases a visitor by it. - The link follows the assistant. Renaming the assistant, editing it or changing the agent behind it keeps the same link and the same conversations.
To stop a link working, either Disable the assistant, which keeps the link for later, or use Get share link, which replaces it.
Put the assistant in front of people
Section titled “Put the assistant in front of people”Share the link
Section titled “Share the link”Send the full link, including everything after #. A link without its key opens a page that says This assistant link is missing its access key.
Link to it from your own site
Section titled “Link to it from your own site”Link to the assistant from your site or application, or open it in a new window.
If your site knows who the visitor is, add your own handle for them to the fragment, after the key:
https://<console-host>/a/<slug>#k=<access-key>&u=<your-handle-for-this-person>Olympusx AI stores that handle on the visitor’s conversations instead of a v- reference, so you can erase a person’s conversations with your other records of them. The page then does not show a reference. The handle must be opaque: not an email address, not a name, national id or account number, and at most 200 characters.
Call it from your application
Section titled “Call it from your application”Your application can hold a conversation with a published assistant over the API, with the same key and an optional handle per person. Those conversations appear on the assistant’s Conversations tab as End user (your application). See Agents and assistants over the API.
Let signed-in users find it
Section titled “Let signed-in users find it”Every Active assistant appears on an end user’s overview, under Assistants you can use, with its welcome message. Signed-in users need no share link; see Chatting with an assistant.
Check it worked
Section titled “Check it worked”- Open the link in a private browser window.
- The page shows the assistant’s name, its logo if it has one, the welcome message and the starter prompts.
- Ask a question. The answer streams in, and the assistant’s Conversations tab gains a row Started by Visitor (public link).
When it does not work
Section titled “When it does not work”| The page says | What to do |
|---|---|
| This assistant is not available | The address is mistyped, or the assistant is Draft or Disabled, or it was deleted. Enable it, or send the link again |
| This assistant link is missing its access key. | The part after # was lost on the way. Send the full link again |
| This assistant could not be reached | The service did not answer. Try again in a moment |
| A turn fails right after a new link was created | The visitor holds the old link. Send the new one |
| Answers stop with a budget or rate message | The tenant’s budget is spent or its rate limit is reached. See Keys and budgets |
Limits
Section titled “Limits”| What | Limit |
|---|---|
| Share links per assistant | One at a time. A new link revokes the previous one |
| Who creates a link | Admin |
| Requests from public links | 60 a minute per tenant, across all its public links, unless a rate limit is set for the tenant. Over it, a turn is refused and the visitor can ask again a moment later |
| Message from a visitor | 4,000 characters |
Your handle for a visitor (u=) |
At most 200 characters, no @ |