Skip to main content
POST
Generate embed code for component

Authorizations

x-api-key
string
header
required

API Key for server-to-server authentication. Resolves to the owning organization.

Path Parameters

id
string
required

Component ID

Body

application/json
userId
string

User ID for tracking

groupIds
string[]

Group IDs for collaboration

Example:
sessionId
string

Session ID for continuity

theme
object

Theme customization

features
object

Feature toggles

width
string

Embed width (e.g., "100%", "600px")

height
string

Embed height (e.g., "400px", "100vh")

expiryHours
number
default:1

Token expiry time in hours

Response

200 - application/json

Embed code generated successfully

embedUrl
string
required

The embed URL for iframe integration

token
string
required

JWT token for authentication

expiresAt
string<date-time>
required

Token expiration timestamp

componentId
string
required

Component ID

componentType
string
required

Component type

options
object
required

Embed options