Get a widget embed and its widget key
Read one deployment including its widget key, so you can recover the embed snippet at any time. The key is public; the origin allowlist is what protects it.
GET
The response includes
widget_key, so you can recover the snippet for an embed at any time. The key is public and is not a secret.
A deployment that does not exist, a deployment in another organization and a malformed ID all return the same 404.
You need the assistant.read permission, which the owner, admin, editor and member (normal) roles hold. Authenticate with an arukz_sk_ API key or a signed-in console session.
string
required
The deployment’s ID (UUID), as returned in
id.Response
string
required
The deployment’s ID (UUID).
string
required
The embed’s label.
string
required
The public widget key,
arukz_wk_ followed by the deployment ID. Send it in the
X-ARUKZ-Widget-Key header.string
required
The embedded assistant’s ID.
string
required
active, revoked or expired. expired means the current time is past expires_at; an
expired embed answers nothing. A revoked embed reads revoked even after its expiry.string[]
required
Origins allowed to host the widget, sorted.
string
required
When the deployment was created, ISO 8601 in UTC.
string | null
required
ID of the user who created it, or
null when it was created with an API key.string | null
required
When the embed expires, or
null if it does not.string | null
required
When the embed was revoked, or
null.string | null
required
When the widget key last authenticated a request, or
null if never.Last modified on September 26, 2026