Skip to main content
GET
Get the website widget

Authorizations

Authorization
string
header
required

An org API key (gh_live_…) from Settings → API keys in the console.

Path Parameters

agent_id
string
required

The agent’s id, e.g. billing.

Response

OK

The agent on websites: a character on a chat bar in the corner of your pages, added with one script tag. Visitors chat with the published version and see its moods (thinking, reading, scouring), not its steps. Saved as it changes, not with the agent's versions.

object
enum<string>
Available options:
widget
agent_id
string
Example:

"support"

widget_id
string

Public: it goes in the snippet.

Example:

"wgt_l6ehq2niwfp5tpgw"

enabled
boolean

Whether websites show it. Off, only your team can try it, in the console.

domains
string[]

The sites that may show it, each with its subdomains. Empty: any site.

Example:
character
enum<string>

none: the bar alone (the default). bot: a character standing on the bar, for accounts that have one (see characters).

Available options:
bot,
none
characters
enum<string>[]

The characters this widget can pick.

Available options:
bot,
none
Example:
placeholder
string

What the bar says before anyone types ('' shows "Ask a question").

Maximum string length: 60
suggestions
boolean

Visitors see typing suggestions (how they might finish their message; Tab accepts). On by default.

snippet
string

Paste it into your pages, before .

Example:

"<script src=\"https://guidinghand.ai/widget.js\" data-widget=\"wgt_l6ehq2niwfp5tpgw\" async></script>"

share
boolean

The share link is on: anyone with share_url chats with the published version on a page that's only the chat. Off by default.

share_url
string | null

The share link (null until it's first turned on). Works only while share is on.

Example:

"https://guidinghand.ai/a/k3bq7xw2m4rt5yzn6pdc"