Skip to main content
GET
Preview a managed website voice widget

Authorizations

Authorization
string
header
required

Use Authorization: Bearer pyai_live_... (or pyai_test_...).

Path Parameters

id
string
required

Saved agent ID in the authenticated project.

Response

Widget configuration and embed preview for the selected project.

object
string
required
Allowed value: "agent.widget.preview"
agent_id
string
required
project_id
string
required
public_id
string
required
status
enum<string>
required
Available options:
draft,
published,
disabled
allowed_origins
string<uri>[]
required
daily_session_limit
integer
required
ip_daily_session_limit
integer
required
snippet
string
required

Copy this script tag into the approved website after publication. A draft ID cannot start a visitor session.

readiness
object
required
revision
string
required

Opaque identifier for the configuration shown in the preview.

Pattern: ^[a-f0-9]{64}$