White label

A white-labeled agent is a cloud agent that wears your branding instead of ours. Its web page, its browser tab and the pages around it show your agent's name, your logo, your colors and fonts, and your welcome line. Use it to ship agents inside your own product: one branding per product or per customer of yours, as many agents under each as you need.

1. 1

   Design a branding

   In Cloud agents → Brandings select New branding. Set the name your users see, upload a logo, pick a theme, colors and fonts, and write a welcome line; the preview shows the agent's page as you go. Or create it with POST /v1/agents/brandings.

2. 2

   Pick it for an agent

   Choose it under Branding when you create an agent, or later in the agent's Settings. Over the API, send "branding": "brd_…" when you create or update an agent. It applies from the agent's next start.

3. 3

   Give your users its page

   Hand your user an agent token with the ui scope: its link opens the agent's page, signed in, in your branding. Or keep the page to yourself and only use runs.

What your users see#

• The agent's page: your agent's name in the page title, the sidebar and the browser tab; your logo as the sidebar mark, the large mark over the message box and the favicon; your welcome line as the headline; your colors throughout, in a dark or light theme; your fonts.
• The pages around it: Starting…, Sign in, Stopped and the other notices on the agent's address use your branding too, and never link to Lovely Router. When the agent can't start because of your balance or a budget, your user is only told it isn't available right now.
• The agent itself: it calls itself by your agent's name, the models it offers are listed under that name, and its built-in tools don't mention Lovely Router.

The address is agent.lovelyrouter.com/a/<agent id>/ (and agent.lovelyrouter.com/s/… for share links) until you connect your own domain: then it is yours, for example agents.yourcompany.com/a/<agent id>/.

Pricing#

White-labeled agents cost 1.5× the standard rates for their sandbox: compute and storage. Models, data tools and the browser agent they use keep their usual prices.

A session is billed at the rate it started with: switching an agent's branding on or off changes the price from its next start. Storage is billed each day at the rate of the agent's branding that day. Brandings themselves are free to keep.

Brandings#

A branding holds:

• Agent name: what your users see (1 to 40 letters, digits, spaces and . _ -).
• Name in your console: your own label for it, never shown to your users.
• Logo: PNG, JPEG, WebP or SVG. Square works best; the console scales pictures to 256 pixels. Without a logo, the first letter of the agent name on your accent color. An SVG is shown as an image, so scripts in it never run.
• Theme: dark or light, with an accent and a background color. The other colors (panels, borders, text, links, text on the accent) are derived from them; fine-tune each one if you like.
• Fonts: a text font and a code font from Google Fonts, or the page's own.
• Welcome line: the headline over the first message box, up to 80 characters. Default: What can I do for you?

Keep up to 50 brandings. A change reaches every agent that uses the branding at its next start; the pages around the agent follow within a minute. A branding that agents use can't be deleted: switch them to another branding, or back to the standard look, first.

curl https://lovelyrouter.com/v1/agents/brandings \
  -H "Authorization: Bearer $LOVELY_API_KEY" \
  -H "content-type: application/json" \
  -d '{"agent_name": "Nova Assistant", "scheme": "light", "colors": {"accent": "#0d9488"}, "font": "Inter", "welcome": "How can Nova help today?"}'

# then create an agent that wears it
curl https://lovelyrouter.com/v1/agents \
  -H "Authorization: Bearer $LOVELY_API_KEY" \
  -H "content-type: application/json" \
  -d '{"name": "Nova for cust-42", "user": "cust-42", "branding": "brd_6c1f0a9e3b7d2c4e8f5a1b0d"}'

See the branding endpoints for every field.

Your own domain#

Serve a branding's agents on a domain of yours, such as agents.yourcompany.com. Their links, sign-in, pages and share links then use it, and nothing in the address bar names us.

1. 1

   Connect it

   Open the branding in Brandings and enter the domain under Your own domain, or call PUT /v1/agents/brandings/{id}/domain.

2. 2

   Add one DNS record

   At your DNS provider, add the CNAME record shown: your domain → the target shown there. A domain at the root (yourcompany.com) needs a provider that allows CNAME records there (CNAME flattening or ALIAS).

3. 3

   Wait for the certificate

   Once the record is live, the certificate is issued by itself, usually within minutes; the status turns Active. To prepare the certificate before you point the domain at us, add the TXT records shown as well.

Once it is active, new open links, ui agent tokens and share links point at your domain. Links made before keep working on agent.lovelyrouter.com. Only that branding's agents answer on your domain; nothing else of Lovely Router does.

A domain costs $0.50 per day while it is connected, charged for each day (UTC) it is connected, starting the day you connect it. Removing it stops the charge from the next day. One domain per branding; deleting the branding removes its domain. Domains of an account that stays below zero are removed after 24 hours, like its workspaces.

Limits#

• Up to 50 brandings per account; any number of agents per branding.
• Logo up to 64 KB (as a base64 data: URI over the API).
• One domain per branding; a domain connects to one account only.