Groundeddocs
ReferencePublic agents and widget

The widget's chat page (framed by allowed origins only)

GET/embed/{agentId}

Checks the publishable key, the agent's status and audience, and the public switch. Content-Security-Policy frame-ancestors lists 'self' and the key's allowed origins; X-Frame-Options is not sent. A Referer from another origin must be allowed. With preview=1 (and no key) it is the editor's same-origin preview for team members.

Path Parameters

agentId*string
Formatuuid

Query Parameters

key?string

The publishable key (pk_...)

preview?"1"

Value in

  • "1"

Response Body

text/html

text/html

text/html

text/html

curl -X GET "https://example.com/embed/497f6eca-6276-4993-bfeb-53cbbbba6f08"
"string"