Skip to main content
PUT
Save an unpublished website 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.

Body

application/json
origin
string<uri>
required

Exact HTTPS origin, including any non-default port. No wildcard, path, query, fragment or credentials.

Pattern: ^https://
Example:

"https://support.example.com"

daily_session_limit
integer
required

Maximum visitor sessions per UTC day for the widget. This is a session count, not a spending limit.

Required range: 1 <= x <= 10000
ip_daily_session_limit
integer
required

Maximum visitor sessions per IP per UTC day.

Required range: 1 <= x <= 1000
expected_revision
string

Opaque revision from the latest preview. Required to replace a changed draft.

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

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}$