Skip to main content
POST
Create Widget

Authorizations

Authorization
string
header
required

Your API key. Send in the Authorization header as: Bearer

Headers

X-Idempotency-Key
string | null

Body

application/json
name
string
required
Required string length: 1 - 100
agent_id
string
required
clerk_org_id
string | null
presentation
enum<string>
default:video
Available options:
video,
simple
primary_color
string
default:#6366f1
font_family
string
default:'Inter', sans-serif
dark_mode
boolean
default:false
position
string
default:bottom-right
button_text
string
default:Talk to AI
Maximum string length: 200
display_name
string | null
Maximum string length: 200
agent_subtext
string | null
Maximum string length: 200
widget_size
string
default:medium
placement_mode
string
default:overlay
embedded_justification
string
default:center
show_transcript
boolean
default:true
show_post_call_recap
boolean
default:false
speaking_animation
boolean
default:true
animation_color
string | null
allowed_domains
string[]
profile_picture_url
string | null
speaking_picture_url
string | null

Response

Successful Response

data
PublicWidgetResource · object
required
meta
ResponseMeta · object
required

Metadata included in every API response.